org.apache.wicket.markup.html.form
Class CheckBoxMultipleChoice

java.lang.Object
  org.apache.wicket.Component
      org.apache.wicket.MarkupContainer
          org.apache.wicket.markup.html.WebMarkupContainer
              org.apache.wicket.markup.html.form.LabeledWebMarkupContainer
                  org.apache.wicket.markup.html.form.FormComponent
                      org.apache.wicket.markup.html.form.ListMultipleChoice
                          org.apache.wicket.markup.html.form.CheckBoxMultipleChoice

All Implemented Interfaces:

java.io.Serializable, IClusterable, IConverterLocator, IFormVisitorParticipant, ILabelProvider

public class CheckBoxMultipleChoice
extends ListMultipleChoice

A choice subclass that shows choices via checkboxes.

Java:

 List SITES = Arrays.asList(new String[] { "The Server Side", "Java Lobby", "Java.Net" });
 // Add a set of checkboxes uses Input's 'site' property to designate the
 // current selections, and that uses the SITES list for the available options.
 form.add(new CheckBoxMultipleChoice("site", SITES));
 

HTML:

    <span valign="top" wicket:id="site">
        <input type="checkbox">site 1</input>
        <input type="checkbox">site 2</input>
    </span>
 

Author:

Jonathan Locke, Johan Compagner, Martijn Dashorst, Gwyn Evans, Igor Vaynberg (ivaynberg)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.markup.html.form.FormComponent

FormComponent.AbstractVisitor, FormComponent.IVisitor

Nested classes/interfaces inherited from class org.apache.wicket.Component

Component.ComponentModelChange, Component.EnabledChange, Component.VisibilityChange

Field Summary

Fields inherited from class org.apache.wicket.markup.html.form.FormComponent

FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, VALUE_SEPARATOR

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Constructor Summary

CheckBoxMultipleChoice(java.lang.String id)
Constructor

CheckBoxMultipleChoice(java.lang.String id, IModel choices)
Constructor

CheckBoxMultipleChoice(java.lang.String id, IModel choices, IChoiceRenderer renderer)
Constructor

CheckBoxMultipleChoice(java.lang.String id, IModel model, IModel choices)
Constructor

CheckBoxMultipleChoice(java.lang.String id, IModel model, IModel choices, IChoiceRenderer renderer)
Constructor

CheckBoxMultipleChoice(java.lang.String id, IModel model, java.util.List choices)
Constructor

CheckBoxMultipleChoice(java.lang.String id, IModel model, java.util.List choices, IChoiceRenderer renderer)
Constructor

CheckBoxMultipleChoice(java.lang.String id, java.util.List choices)
Constructor

CheckBoxMultipleChoice(java.lang.String id, java.util.List choices, IChoiceRenderer renderer)
Constructor

Method Summary

protected void	appendOptionHtml(AppendingStringBuffer buffer, java.lang.Object choice, int index, java.lang.String selected) Generates and appends html for a single choice into the provided buffer
protected void	detachModel() Detaches the model for this component if it is detachable.
protected java.lang.CharSequence	escapeOptionHtml(java.lang.String displayValue) Method to override if you want special escaping of the options html.
IChoiceRenderer	getChoiceRenderer()
java.util.List	getChoices()
protected java.lang.CharSequence	getDefaultChoice(java.lang.Object selected)
java.lang.String	getPrefix()
java.lang.String	getSuffix()
protected boolean	isDisabled(java.lang.Object object, int index, java.lang.String selected) Gets whether the given value is disabled.
protected boolean	isEscapeLabelMarkup() Overridable method to determine whether the label markup should be escaped.
protected boolean	localizeDisplayValues() Override this method if you want to localize the display values of the generated options.
protected void	onComponentTag(ComponentTag tag) Processes the component tag.
protected void	onComponentTagBody(MarkupStream markupStream, ComponentTag openTag) Handle the container's body.
org.apache.wicket.markup.html.form.AbstractChoice	setChoiceRenderer(IChoiceRenderer renderer) Set the choice renderer to be used.
org.apache.wicket.markup.html.form.AbstractChoice	setChoices(IModel choices) Sets the list of choices
org.apache.wicket.markup.html.form.AbstractChoice	setChoices(java.util.List choices) Sets the list of choices.
CheckBoxMultipleChoice	setPrefix(java.lang.String prefix)
CheckBoxMultipleChoice	setSuffix(java.lang.String suffix)
protected boolean	supportsPersistence()

Methods inherited from class org.apache.wicket.markup.html.form.ListMultipleChoice

convertChoiceIdsToChoices, convertValue, getDefaultMaxRows, getModelValue, isSelected, setDefaultMaxRows, setMaxRows, updateModel

Methods inherited from class org.apache.wicket.markup.html.form.FormComponent

add, checkRequired, clearInput, convertInput, error, getBehaviors, getConvertedInput, getForm, getInput, getInputAsArray, getInputName, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isPersistent, isRequired, isValid, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, setConvertedInput, setLabel, setModelValue, setModelValue, setPersistent, setRequired, setType, shouldTrimInput, trim, valid, validate, validateRequired, validateValidators, visitFormComponentsPostOrder

Methods inherited from class org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

getLabel, setLabelInternal

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getMarkupType, getWebPage

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, continueToOriginalDestination, debug, detach, detachBehaviors, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMetaData, getModel, getModelComparator, getModelObject, getModelObjectAsString, getModelObjectAsString, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, newPage, newPage, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onEndRequest, onModelChanged, onModelChanging, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMetaData, setModelObject, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CheckBoxMultipleChoice

public CheckBoxMultipleChoice(java.lang.String id)

Constructor

Parameters:

id - See Component

See Also:

Component.Component(String), AbstractChoice.AbstractChoice(String)

CheckBoxMultipleChoice

public CheckBoxMultipleChoice(java.lang.String id,
                              java.util.List choices)

Constructor

Parameters:

id - See Component

choices - The collection of choices in the radio choice

See Also:

Component.Component(String), AbstractChoice.AbstractChoice(String, java.util.List)

CheckBoxMultipleChoice

public CheckBoxMultipleChoice(java.lang.String id,
                              java.util.List choices,
                              IChoiceRenderer renderer)

Constructor

Parameters:

id - See Component

renderer - The rendering engine

choices - The collection of choices in the radio choice

See Also:

Component.Component(String), AbstractChoice.AbstractChoice(String, java.util.List,org.apache.wicket.markup.html.form.IChoiceRenderer)

CheckBoxMultipleChoice

public CheckBoxMultipleChoice(java.lang.String id,
                              IModel model,
                              java.util.List choices)

Constructor

Parameters:

id - See Component

model - See Component

choices - The collection of choices in the radio choice

See Also:

Component.Component(String, org.apache.wicket.model.IModel), AbstractChoice.AbstractChoice(String, org.apache.wicket.model.IModel, java.util.List)

CheckBoxMultipleChoice

public CheckBoxMultipleChoice(java.lang.String id,
                              IModel model,
                              java.util.List choices,
                              IChoiceRenderer renderer)

Constructor

Parameters:

id - See Component

model - See Component

choices - The collection of choices in the radio choice

renderer - The rendering engine

See Also:

Component.Component(String, org.apache.wicket.model.IModel), AbstractChoice.AbstractChoice(String, org.apache.wicket.model.IModel, java.util.List,org.apache.wicket.markup.html.form.IChoiceRenderer)

CheckBoxMultipleChoice

public CheckBoxMultipleChoice(java.lang.String id,
                              IModel choices)

Constructor

Parameters:

id - See Component

choices - The collection of choices in the radio choice

See Also:

Component.Component(String), AbstractChoice.AbstractChoice(String, org.apache.wicket.model.IModel)

CheckBoxMultipleChoice

public CheckBoxMultipleChoice(java.lang.String id,
                              IModel model,
                              IModel choices)

Constructor

Parameters:

id - See Component

model - The model that is updated with changes in this component. See Component

choices - The collection of choices in the radio choice

See Also:

AbstractChoice.AbstractChoice(String, org.apache.wicket.model.IModel,org.apache.wicket.model.IModel), Component.Component(String, org.apache.wicket.model.IModel)

CheckBoxMultipleChoice

public CheckBoxMultipleChoice(java.lang.String id,
                              IModel choices,
                              IChoiceRenderer renderer)

Constructor

Parameters:

id - See Component

choices - The collection of choices in the radio choice

renderer - The rendering engine

See Also:

AbstractChoice.AbstractChoice(String, org.apache.wicket.model.IModel,org.apache.wicket.markup.html.form.IChoiceRenderer), Component.Component(String)

CheckBoxMultipleChoice

public CheckBoxMultipleChoice(java.lang.String id,
                              IModel model,
                              IModel choices,
                              IChoiceRenderer renderer)

Constructor

Parameters:

id - See Component

model - The model that is updated with changes in this component. See Component

choices - The collection of choices in the radio choice

renderer - The rendering engine

See Also:

Component.Component(String, org.apache.wicket.model.IModel), AbstractChoice.AbstractChoice(String, org.apache.wicket.model.IModel, org.apache.wicket.model.IModel,org.apache.wicket.markup.html.form.IChoiceRenderer)

Method Detail

getPrefix

public java.lang.String getPrefix()

Returns:

Prefix to use before choice

setPrefix

public final CheckBoxMultipleChoice setPrefix(java.lang.String prefix)

Parameters:

prefix - Prefix to use before choice

Returns:

this

getSuffix

public java.lang.String getSuffix()

Returns:

Separator to use between radio options

setSuffix

public final CheckBoxMultipleChoice setSuffix(java.lang.String suffix)

Parameters:

suffix - Separator to use between radio options

Returns:

this

onComponentTag

protected void onComponentTag(ComponentTag tag)

Description copied from class: FormComponent

Processes the component tag.

Overrides:

onComponentTag in class ListMultipleChoice

Parameters:

tag - Tag to modify

See Also:

ListMultipleChoice.onComponentTag(org.apache.wicket.markup.ComponentTag)

onComponentTagBody

protected final void onComponentTagBody(MarkupStream markupStream,
                                        ComponentTag openTag)

Handle the container's body.

Parameters:

markupStream - The markup stream

openTag - The open tag for the body

See Also:

Component.onComponentTagBody(org.apache.wicket.markup.MarkupStream, org.apache.wicket.markup.ComponentTag)

isEscapeLabelMarkup

protected boolean isEscapeLabelMarkup()

Overridable method to determine whether the label markup should be escaped.

Returns:

getChoices

public java.util.List getChoices()

Returns:

The collection of object that this choice has

setChoices

public final org.apache.wicket.markup.html.form.AbstractChoice setChoices(IModel choices)

Sets the list of choices

Parameters:

choices - model representing the list of choices

Returns:

this for chaining

setChoices

public final org.apache.wicket.markup.html.form.AbstractChoice setChoices(java.util.List choices)

Sets the list of choices.

Parameters:

choices - the list of choices

Returns:

this for chaining

getChoiceRenderer

public final IChoiceRenderer getChoiceRenderer()

Returns:

The IChoiceRenderer used for rendering the data objects

setChoiceRenderer

public final org.apache.wicket.markup.html.form.AbstractChoice setChoiceRenderer(IChoiceRenderer renderer)

Set the choice renderer to be used.

Parameters:

renderer -

Returns:

this for chaining

detachModel

protected void detachModel()

Description copied from class: Component

Detaches the model for this component if it is detachable.

Overrides:

detachModel in class Component

See Also:

Component.detachModel()

getDefaultChoice

protected java.lang.CharSequence getDefaultChoice(java.lang.Object selected)

Parameters:

selected - The object that's currently selected

Returns:

Any default choice, such as "Choose One", depending on the subclass

isDisabled

protected boolean isDisabled(java.lang.Object object,
                             int index,
                             java.lang.String selected)

Gets whether the given value is disabled. This default implementation always returns false.

Parameters:

object - The object to check

index - The index in the choices collection this object is in.

selected - The currently selected string value

Returns:

Whether the given value represents the current selection

appendOptionHtml

protected void appendOptionHtml(AppendingStringBuffer buffer,
                                java.lang.Object choice,
                                int index,
                                java.lang.String selected)

Generates and appends html for a single choice into the provided buffer

Parameters:

buffer - Appending string buffer that will have the generated html appended

choice - Choice object

index - The index of this option

selected - The currently selected string value

escapeOptionHtml

protected java.lang.CharSequence escapeOptionHtml(java.lang.String displayValue)

Method to override if you want special escaping of the options html.

Parameters:

displayValue -

Returns:

The escaped display value

supportsPersistence

protected boolean supportsPersistence()

Overrides:

supportsPersistence in class FormComponent

Returns:

True if this type of FormComponent can be persisted.

See Also:

FormComponent.supportsPersistence()

localizeDisplayValues

protected boolean localizeDisplayValues()

Override this method if you want to localize the display values of the generated options. By default false is returned so that the display values of options are not tested if they have a i18n key.

Returns:

true If you want to localize the display values, default == false