org.apache.wicket.markup.html.form
Class CheckBox
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<java.lang.Boolean>
org.apache.wicket.markup.html.form.CheckBox
- All Implemented Interfaces:
- java.io.Serializable, IClusterable, IConverterLocator, IRequestListener, IFormModelUpdateListener, IFormVisitorParticipant, ILabelProvider<java.lang.String>, IOnChangeListener
- Direct Known Subclasses:
- AjaxCheckBox
public class CheckBox
- extends FormComponent<java.lang.Boolean>
- implements IOnChangeListener
HTML checkbox input component.
Java:
form.add(new CheckBox("bool"));
HTML:
<input type="checkbox" wicket:id="bool" />
You can can extend this class and override method wantOnSelectionChangedNotifications() to force
server roundtrips on each selection change.
- Author:
- Jonathan Locke
- See Also:
- Serialized Form
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, PATH_SEPARATOR, RENDER |
Constructor Summary |
CheckBox(java.lang.String id)
|
CheckBox(java.lang.String id,
IModel<java.lang.Boolean> model)
|
Methods inherited from class org.apache.wicket.markup.html.form.FormComponent |
add, add, checkRequired, clearInput, convertInput, convertValue, error, getConvertedInput, getForm, getInput, getInputAsArray, getInputName, getModel, getModelObject, getModelValue, 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, updateModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder |
Methods inherited from class org.apache.wicket.MarkupContainer |
add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, 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, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, 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, 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 |
CheckBox
public CheckBox(java.lang.String id)
- See Also:
Component.Component(String)
CheckBox
public CheckBox(java.lang.String id,
IModel<java.lang.Boolean> model)
- Parameters:
id
- model
- - See Also:
Component.Component(String, IModel)
onSelectionChanged
public void onSelectionChanged()
- Description copied from interface:
IOnChangeListener
- Called when a new option is selected.
- Specified by:
onSelectionChanged
in interface IOnChangeListener
- See Also:
IOnChangeListener.onSelectionChanged()
onSelectionChanged
protected void onSelectionChanged(java.lang.Object newSelection)
- Template method that can be overridden by clients that implement IOnChangeListener to be
notified by onChange events of a select element. This method does nothing by default.
Called when a option is selected of a dropdown list that wants to be notified of this event.
This method is to be implemented by clients that want to be notified of selection events.
- Parameters:
newSelection
- The newly selected object of the backing model NOTE this is the same as you would
get by calling getModelObject() if the new selection were current
wantOnSelectionChangedNotifications
protected boolean wantOnSelectionChangedNotifications()
- Whether this component's onSelectionChanged event handler should called using javascript if
the selection changes. If true, a roundtrip will be generated with each selection change,
resulting in the model being updated (of just this component) and onSelectionChanged being
called. This method returns false by default.
- Returns:
- True if this component's onSelectionChanged event handler should called using
javascript if the selection changes
getStatelessHint
protected boolean getStatelessHint()
- Description copied from class:
Component
- 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
- See Also:
Component.getStatelessHint()
onComponentTag
protected void onComponentTag(ComponentTag tag)
- Processes the component tag.
- Overrides:
onComponentTag
in class FormComponent<java.lang.Boolean>
- Parameters:
tag
- Tag to modify- See Also:
Component.onComponentTag(ComponentTag)
supportsPersistence
protected final boolean supportsPersistence()
- Overrides:
supportsPersistence
in class FormComponent<java.lang.Boolean>
- Returns:
- True if this type of FormComponent can be persisted.
- See Also:
FormComponent.supportsPersistence()
getConverter
public final IConverter getConverter(java.lang.Class<?> type)
- Final because we made
FormComponent.convertInput()
final and it no longer delegates to
getConverter(Class)
- Specified by:
getConverter
in interface IConverterLocator
- Overrides:
getConverter
in class Component
- Parameters:
type
- The type to convert to
- Returns:
- The converter that should be used by this component
- See Also:
Component.getConverter(java.lang.Class)
Copyright © 2004-2010 Apache Software Foundation. All Rights Reserved.