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<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:

Serializable, Iterable<Component>, IEventSink, IEventSource, IConverterLocator, IGenericComponent<Collection<T>>, IFormModelUpdateListener, IFormVisitorParticipant, ILabelProvider<String>, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

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

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_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

CheckBoxMultipleChoice(String id)
Constructor

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

CheckBoxMultipleChoice(String id, IModel<? extends Collection<T>> model, IModel<? extends List<? extends T>> choices, IChoiceRenderer<? super T> renderer)
Constructor

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

CheckBoxMultipleChoice(String id, IModel<? extends Collection<T>> model, List<? extends T> choices, IChoiceRenderer<? super T> renderer)
Constructor

CheckBoxMultipleChoice(String id, IModel<? extends List<? extends T>> choices)
Constructor

CheckBoxMultipleChoice(String id, IModel<? extends List<? extends T>> choices, IChoiceRenderer<? super T> renderer)
Constructor

CheckBoxMultipleChoice(String id, List<? extends T> choices)
Constructor

CheckBoxMultipleChoice(String id, List<? extends T> choices, IChoiceRenderer<? super T> renderer)
Constructor

Method Summary

protected void	appendOptionHtml(AppendingStringBuffer buffer, T choice, int index, String selected) Generates and appends html for a single choice into the provided buffer
protected IValueMap	getAdditionalAttributes(int index, T choice) You may subclass this method to provide additional attributes to the <input ..> tag.
protected String	getCheckBoxMarkupId(String id) Creates markup id for the input tag used to generate the checkbox for the element with the specified id.
String	getPrefix()
protected String	getPrefix(int index, T choice)
String	getSuffix()
protected String	getSuffix(int index, T choice)
protected void	onComponentTag(ComponentTag tag) Processes the component tag.
void	onComponentTagBody(MarkupStream markupStream, ComponentTag openTag) Handle the container's body.
CheckBoxMultipleChoice<T>	setPrefix(String prefix)
CheckBoxMultipleChoice<T>	setSuffix(String suffix)

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

convertChoiceIdsToChoices, convertValue, getModelValue, isRetainDisabledSelected, isSelected, setMaxRows, setRetainDisabledSelected, updateModel

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

detachModel, escapeOptionHtml, getChoiceRenderer, getChoices, getDefaultChoice, isDisabled, localizeDisplayValues, setChoiceRenderer, setChoices, setChoices, setOptionAttributes, setType

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

add, add, checkRequired, clearInput, convertInput, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getInputName, getModel, getModelObject, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setRequired, shouldTrimInput, trim, updateCollectionModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder

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

getLabel

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

getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, debug, detach, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onConfigure, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, 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(String id)

Constructor

Parameters:

id - See Component

See Also:

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

CheckBoxMultipleChoice

public CheckBoxMultipleChoice(String id,
                              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(String id,
                              List<? extends T> choices,
                              IChoiceRenderer<? super 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(String id,
                              IModel<? extends Collection<T>> model,
                              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(String id,
                              IModel<? extends Collection<T>> model,
                              List<? extends T> choices,
                              IChoiceRenderer<? super 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(String id,
                              IModel<? extends 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(String id,
                              IModel<? extends Collection<T>> model,
                              IModel<? extends 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(String id,
                              IModel<? extends List<? extends T>> choices,
                              IChoiceRenderer<? super 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(String id,
                              IModel<? extends Collection<T>> model,
                              IModel<? extends List<? extends T>> choices,
                              IChoiceRenderer<? super 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 String getPrefix()

Returns:

Prefix to use before choice

getPrefix

protected String getPrefix(int index,
                           T choice)

Parameters:

index - index of the choice

choice - the choice itself

Returns:

Prefix to use before choice. The default implementation just returns getPrefix(). Override to have a prefix dependent on the choice item.

getSuffix

protected String getSuffix(int index,
                           T choice)

Parameters:

index - index of the choice

choice - the choice itself

Returns:

Separator to use between radio options. The default implementation just returns getSuffix(). Override to have a prefix dependent on the choice item.

setPrefix

public final CheckBoxMultipleChoice<T> setPrefix(String prefix)

Parameters:

prefix - Prefix to use before choice

Returns:

this

getSuffix

public String getSuffix()

Returns:

Separator to use between radio options

setSuffix

public final CheckBoxMultipleChoice<T> setSuffix(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

public final void onComponentTagBody(MarkupStream markupStream,
                                     ComponentTag openTag)

Description copied from class: AbstractChoice

Handle the container's body.

Overrides:

onComponentTagBody in class AbstractChoice<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)

appendOptionHtml

protected void appendOptionHtml(AppendingStringBuffer buffer,
                                T choice,
                                int index,
                                String selected)

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

Overrides:

appendOptionHtml in class AbstractChoice<Collection<T>,T>

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

getAdditionalAttributes

protected IValueMap getAdditionalAttributes(int index,
                                            T choice)

You may subclass this method to provide additional attributes to the <input ..> tag.

Parameters:

index -

choice -

Returns:

tag attribute name/value pairs.

getCheckBoxMarkupId

protected String getCheckBoxMarkupId(String id)

Creates markup id for the input tag used to generate the checkbox for the element with the specified id.

NOTE It is useful to override this method if the contract for the generated ids should be fixed, for example in cases when the id generation pattern in this method is used to predict ids by some external javascript. If the contract is fixed in the user's code then upgrading wicket versions will guarantee not to break it should the default contract be changed at a later time.

Parameters:

id -

Returns:

markup id for the input tag