|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 org.apache.wicket.markup.html.form.CheckGroup
public class CheckGroup
Component used to connect instances of Check components into a group. Instances of Check have to
be in the component hierarchy somewhere below the group component. The model of the CheckGroup
component has to be an instance of java.util.Collection. The model collection of the group is
filled with model objects of all selected Check components.
ie
...
choice 1
...
choice 2
...
Check
,
Note: This component does not support cookie persistence
,
Serialized FormNested 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 |
Fields inherited from interface org.apache.wicket.markup.html.form.IOnChangeListener |
---|
INTERFACE |
Constructor Summary | |
---|---|
CheckGroup(java.lang.String id)
Constructor that will create a default model collection |
|
CheckGroup(java.lang.String id,
java.util.Collection collection)
Constructor that wraps the provided collection with the org.apache.wicket.model.Model object |
|
CheckGroup(java.lang.String id,
IModel model)
|
Method Summary | |
---|---|
protected java.lang.Object |
convertValue(java.lang.String[] values)
Subclasses should overwrite this if the conversion is not done through the type field and the IConverter. |
protected boolean |
getStatelessHint()
Returns whether the component can be stateless. |
protected void |
onComponentTag(ComponentTag tag)
Processes the component tag. |
void |
onSelectionChanged()
Called when a selection changes. |
protected void |
onSelectionChanged(java.util.Collection newSelection)
Template method that can be overriden by clients that implement IOnChangeListener to be notified by onChange events of a select element. |
protected boolean |
supportsPersistence()
Check group does not support persistence through cookies |
void |
updateModel()
Updates this components model from the request, it expects that the object is already converted through the convertInput() call that is called by the validate() method when a form is being processed. |
protected boolean |
wantOnSelectionChangedNotifications()
This method should be overridden to return true if it is desirable to have on-selection-changed notification. |
Methods inherited from class org.apache.wicket.markup.html.form.FormComponent |
---|
add, checkRequired, clearInput, convertInput, error, getBehaviors, getConvertedInput, getForm, getInput, getInputAsArray, getInputName, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isPersistent, isRequired, isValid, onDetach, onDisabled, onInvalid, onValid, processChildren, processInput, setConvertedInput, setLabel, setModelValue, setModelValue, setPersistent, setRequired, setType, shouldTrimInput, trim, valid, validate, validateRequired, validateValidators, 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 |
Methods inherited from class org.apache.wicket.MarkupContainer |
---|
add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public CheckGroup(java.lang.String id)
id
- component idpublic CheckGroup(java.lang.String id, java.util.Collection collection)
id
- component idcollection
- collection to be used as the modelpublic CheckGroup(java.lang.String id, IModel model)
WebMarkupContainer.WebMarkupContainer(String, IModel)
Method Detail |
---|
protected java.lang.Object convertValue(java.lang.String[] values) throws ConversionException
FormComponent
convertValue
in class FormComponent
values
- The value can be the getInput() or through a cookie
ConversionException
- If input can't be convertedFormComponent.convertValue(String[])
public void updateModel()
FormComponent
setModelObject(getConvertedInput());DO NOT CALL THIS METHOD DIRECTLY UNLESS YOU ARE SURE WHAT YOU ARE DOING. USUALLY UPDATING YOUR MODEL IS HANDLED BY THE FORM, NOT DIRECTLY BY YOU.
updateModel
in class FormComponent
FormComponent.updateModel()
protected final boolean supportsPersistence()
supportsPersistence
in class FormComponent
FormComponent.supportsPersistence()
protected void onComponentTag(ComponentTag tag)
FormComponent
onComponentTag
in class FormComponent
tag
- Tag to modifyFormComponent.onComponentTag(org.apache.wicket.markup.ComponentTag)
public final void onSelectionChanged()
onSelectionChanged
in interface IOnChangeListener
protected void onSelectionChanged(java.util.Collection newSelection)
Called when a Check
is clicked in a CheckGroup
that wants to be notified of
this event. This method is to be implemented by clients that want to be notified of selection
events.
newSelection
- The new selection of the CheckGroup
. NOTE this is the same as you would
get by calling getModelObject() if the new selection were currentprotected boolean wantOnSelectionChangedNotifications()
protected boolean getStatelessHint()
Component
getStatelessHint
in class Component
Component.getStatelessHint()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |