wicket.markup.html.form
Class CheckBoxMultipleChoice

java.lang.Object
  wicket.Component
      wicket.MarkupContainer
          wicket.markup.html.WebMarkupContainer
              wicket.markup.html.form.FormComponent
                  wicket.markup.html.form.AbstractChoice
                      wicket.markup.html.form.ListMultipleChoice
                          wicket.markup.html.form.CheckBoxMultipleChoice

All Implemented Interfaces:

IAjaxListener, IHeaderContributor, IRequestListener, java.io.Serializable

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 inherited from class wicket.markup.html.form.FormComponent

FormComponent.IVisitor

Nested classes inherited from class wicket.Component

Component.ComponentModelChange, Component.VisibilityChange

Field Summary

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

FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, NO_INVALID_INPUT

Fields inherited from class wicket.Component

FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4

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

java.lang.String	getPrefix()
java.lang.String	getSuffix()
protected void	onComponentTagBody(MarkupStream markupStream, ComponentTag openTag) Handle the container's body.
CheckBoxMultipleChoice	setPrefix(java.lang.String prefix)
CheckBoxMultipleChoice	setSuffix(java.lang.String suffix)

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

appendOptionHtml, detachModel, getChoiceRenderer, getChoices, getDefaultChoice, getDefaultMaxRows, getModelValue, isSelected, onComponentTag, setChoiceRenderer, setChoices, setDefaultMaxRows, setMaxRows, setModelValue, supportsPersistence, updateModel

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

add, getForm, getInput, getInputName, getLabel, getValidationType, getValidators, getValue, inputAsInt, inputAsInt, inputAsIntArray, inputAsStringArray, invalid, isMultiPart, isPersistent, isValid, isValidated, onInvalid, onModelChanged, onValid, setLabel, setPersistent, valid, validate

Methods inherited from class wicket.markup.html.WebMarkupContainer

getMarkupType, onRender, renderHead

Methods inherited from class wicket.MarkupContainer

add, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, internalAdd, internalBeginRequest, internalEndRequest, iterator, iterator, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren

Methods inherited from class wicket.Component

add, add, addStateChange, checkComponentTag, checkComponentTagAttribute, debug, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getAjaxHandlers, getApplication, getApplicationPages, getApplicationSettings, getClassRelativePath, getComparator, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getId, getLocale, getLocalizer, getModel, getModelObject, getModelObjectAsString, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResource, getResponse, getSession, getString, getString, getString, getStyle, getVariation, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnBeginRequest, internalOnEndRequest, internalOnModelChanged, internalOnModelChanging, isAncestorOf, isVersioned, isVisible, isVisibleInHierarchy, modelChanged, modelChanging, newPage, newPage, onBeginRequest, onEndRequest, onModelChanging, onRequest, onSessionAttach, redirectTo, remove, render, renderComponent, renderComponentTag, rendered, replaceComponentTagBody, sameRootModel, sameRootModel, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setModelObject, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisible, urlFor, urlFor, visitParents, warn

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,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, wicket.model.IModel), AbstractChoice.AbstractChoice(String, 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, wicket.model.IModel), AbstractChoice.AbstractChoice(String, wicket.model.IModel, java.util.List,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, 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, wicket.model.IModel,wicket.model.IModel), Component.Component(String, 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, wicket.model.IModel,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, wicket.model.IModel), AbstractChoice.AbstractChoice(String, wicket.model.IModel, wicket.model.IModel,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

onComponentTagBody

protected final void onComponentTagBody(MarkupStream markupStream,
                                        ComponentTag openTag)

Description copied from class: AbstractChoice

Handle the container's body.

Overrides:

onComponentTagBody in class AbstractChoice

Parameters:

markupStream - The markup stream

openTag - The open tag for the body

See Also:

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