org.apache.wicket.markup.html.form
Class CheckBoxMultipleChoice<T>

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<T>
                      org.apache.wicket.markup.html.form.AbstractChoice<java.util.Collection<T>,T>
                          org.apache.wicket.markup.html.form.ListMultipleChoice<T>
                              org.apache.wicket.markup.html.form.CheckBoxMultipleChoice<T>

Type Parameters:

T - The model object type

All Implemented Interfaces:

java.io.Serializable, IClusterable, IConverterLocator, IFormModelUpdateListener, IFormVisitorParticipant, ILabelProvider<java.lang.String>

public class CheckBoxMultipleChoice<T>
extends ListMultipleChoice<T>

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<? extends java.util.List<? extends T>> choices)
Constructor

CheckBoxMultipleChoice(java.lang.String id, IModel<? extends java.util.List<? extends T>> choices, IChoiceRenderer<T> renderer)
Constructor

CheckBoxMultipleChoice(java.lang.String id, IModel<java.util.Collection<T>> model, IModel<? extends java.util.List<? extends T>> choices)
Constructor

CheckBoxMultipleChoice(java.lang.String id, IModel<java.util.Collection<T>> model, IModel<? extends java.util.List<? extends T>> choices, IChoiceRenderer<T> renderer)
Constructor

CheckBoxMultipleChoice(java.lang.String id, IModel<java.util.Collection<T>> model, java.util.List<? extends T> choices)
Constructor

CheckBoxMultipleChoice(java.lang.String id, IModel<java.util.Collection<T>> model, java.util.List<? extends T> choices, IChoiceRenderer<T> renderer)
Constructor

CheckBoxMultipleChoice(java.lang.String id, java.util.List<? extends T> choices)
Constructor

CheckBoxMultipleChoice(java.lang.String id, java.util.List<? extends T> choices, IChoiceRenderer<T> renderer)
Constructor

Method Summary

java.lang.String	getPrefix()
java.lang.String	getSuffix()
protected boolean	isEscapeLabelMarkup() Deprecated. use Component.setEscapeModelStrings(boolean)
protected void	onComponentTag(ComponentTag tag) Processes the component tag.
protected void	onComponentTagBody(MarkupStream markupStream, ComponentTag openTag) Handle the container's body.
CheckBoxMultipleChoice<T>	setPrefix(java.lang.String prefix)
CheckBoxMultipleChoice<T>	setSuffix(java.lang.String suffix)

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.AbstractChoice

appendOptionHtml, detachModel, escapeOptionHtml, getChoiceRenderer, getChoices, getDefaultChoice, isDisabled, localizeDisplayValues, setChoiceRenderer, setChoices, setChoices, supportsPersistence

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

add, add, checkRequired, clearInput, convertInput, error, getConvertedInput, getForm, getInput, getInputAsArray, getInputName, getModel, getModelObject, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isPersistent, isRequired, isValid, newValidatable, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setModelValue, setPersistent, setRequired, setType, shouldTrimInput, trim, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, 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, getWebRequest

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setDefaultModel, setMarkupStream, size, swap, 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, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, 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, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onEndRequest, onModelChanged, onModelChanging, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, 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<? extends T> 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<? extends T> choices,
                              IChoiceRenderer<T> 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<java.util.Collection<T>> model,
                              java.util.List<? extends T> 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<java.util.Collection<T>> model,
                              java.util.List<? extends T> choices,
                              IChoiceRenderer<T> 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<? extends java.util.List<? extends T>> 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<java.util.Collection<T>> model,
                              IModel<? extends java.util.List<? extends T>> 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<? extends java.util.List<? extends T>> choices,
                              IChoiceRenderer<T> 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<java.util.Collection<T>> model,
                              IModel<? extends java.util.List<? extends T>> choices,
                              IChoiceRenderer<T> 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<T> 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<T> 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<T>

Parameters:

tag - Tag to modify

See Also:

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

onComponentTagBody

protected final void onComponentTagBody(MarkupStream markupStream,
                                        ComponentTag openTag)

Description copied from class: AbstractChoice

Handle the container's body.

Overrides:

onComponentTagBody in class AbstractChoice<java.util.Collection<T>,T>

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

@Deprecated
protected final boolean isEscapeLabelMarkup()

Deprecated. use Component.setEscapeModelStrings(boolean)

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

Returns:

true if label markup should be escaped