org.apache.wicket.markup.html.form
Class Check<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.Check<T>

Type Parameters:

T - The model object type

All Implemented Interfaces:

Serializable, IClusterable, IConverterLocator, ILabelProvider<String>

public class Check<T>
extends LabeledWebMarkupContainer

Component representing a single checkbox choice in a org.apache.wicket.markup.html.form.CheckGroup. Must be attached to an <input type="checkbox" ... > markup.

STATELESS NOTES: By default this component cannot be used inside a stateless form. If it is desirable to use this inside a stateless form then

• override #getValue() and return some stateless value to uniquely identify this radio (eg relative component path from group to this radio)
• override getStatelessHint() and return true

Author:

Igor Vaynberg

See Also:

CheckGroup, Serialized Form

Nested Class Summary

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

Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor<T extends Component>, Component.VisibilityChange

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

Check(String id)

Check(String id, CheckGroup<T> group)

Check(String id, IModel<T> model)

Check(String id, IModel<T> model, CheckGroup<T> group)

Method Summary

protected CheckGroup<T>	getGroup()
IModel<T>	getModel() Gets model
T	getModelObject() Gets model object
protected boolean	getStatelessHint() Returns whether the component can be stateless.
String	getValue() Form submission value used for this radio component.
protected void	onComponentTag(ComponentTag tag) Processes the component tag.
Check<T>	setLabel(IModel<String> labelModel) The value will be made available to the validator property by means of ${label}.
void	setModel(IModel<T> model) Sets model
void	setModelObject(T object) Sets model object

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

getLabel, onDetach, 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, onAfterRenderChildren, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, 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, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, 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, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onConfigure, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, 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

Check

public Check(String id)

See Also:

WebMarkupContainer.WebMarkupContainer(String)

Check

public Check(String id,
             IModel<T> model)

Parameters:

id -

model -

See Also:

WebMarkupContainer.WebMarkupContainer(String, IModel)

Check

public Check(String id,
             CheckGroup<T> group)

Parameters:

id -

group - parent CheckGroup of this check

See Also:

WebMarkupContainer.WebMarkupContainer(String)

Check

public Check(String id,
             IModel<T> model,
             CheckGroup<T> group)

Parameters:

id -

model -

group - parent CheckGroup of this check

See Also:

WebMarkupContainer.WebMarkupContainer(String, IModel)

Method Detail

getValue

public String getValue()

Form submission value used for this radio component. This string will appear as the value of the value html attribute for the input tag.

Returns:

form submission value

getGroup

protected CheckGroup<T> getGroup()

onComponentTag

protected void onComponentTag(ComponentTag tag)

Description copied from class: Component

Processes the component tag.

Overrides of this method most likely should call the super implementation.

Overrides:

onComponentTag in class Component

Parameters:

tag - the abstraction representing html tag of this component

See Also:

Component.onComponentTag(ComponentTag)

setLabel

public Check<T> setLabel(IModel<String> labelModel)

The value will be made available to the validator property by means of ${label}. It does not have any specific meaning to Check itself.

Parameters:

labelModel -

Returns:

this for chaining

getModel

public final IModel<T> getModel()

Gets model

Returns:

model

setModel

public final void setModel(IModel<T> model)

Sets model

Parameters:

model -

getModelObject

public final T getModelObject()

Gets model object

Returns:

model object

setModelObject

public final void setModelObject(T object)

Sets model object

Parameters:

object -

getStatelessHint

protected boolean getStatelessHint()

Returns whether the component can be stateless. Also the component behaviors must be stateless, otherwise the component will be treat as stateful. In order for page to be stateless (and not to be stored in session), all components (and component behaviors) must be stateless.

Overrides:

getStatelessHint in class Component

Returns:

whether the component can be stateless