org.apache.wicket.markup.html.form

Class CheckGroup<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<Collection<T>>

org.apache.wicket.markup.html.form.CheckGroup<T>

Type Parameters:

T - The model object type

All Implemented Interfaces:

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

public class CheckGroup<T>
extends FormComponent<Collection<T>>
implements IOnChangeListener

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

Author:

Igor Vaynberg

See Also:

Check,

Note: This component does not support cookie persistence, 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_AFTER_RENDERING, FLAG_INITIALIZED, FLAG_PREPARED_FOR_RENDER, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RENDERING, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

Fields inherited from interface org.apache.wicket.markup.html.form.IOnChangeListener

INTERFACE

Constructor Summary

Constructors

Constructor and Description
CheckGroup(String id) Constructor that will create a default model collection
CheckGroup(String id, Collection<T> collection) Constructor that wraps the provided collection with the org.apache.wicket.model.Model object
CheckGroup(String id, IModel<? extends Collection<T>> model)

Method Summary

Methods

Modifier and Type	Method and Description
protected Collection<T>	convertValue(String[] values) Subclasses should overwrite this if the conversion is not done through the type field and the IConverter.
protected String	getModelValue()
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(Collection<T> newSelection) Template method that can be overridden by clients that implement IOnChangeListener to be notified by onChange events of a select element.
void	updateModel() See FormComponent.updateCollectionModel(FormComponent) for details on how the model is updated.
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, add, checkRequired, clearInput, convertInput, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getInputName, getModel, getModelObject, getParameterValues, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onDetach, onDisabled, onInvalid, onRequired, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModel, setModelObject, setModelValue, setRequired, setType, shouldTrimInput, trim, updateAutoLabels, 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

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, onComponentTagBody, onInitialize, onRender, queue, 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, canCallListenerInterfaceAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, 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, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, 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

CheckGroup

public CheckGroup(String id)

Constructor that will create a default model collection

Parameters:

id - component id

CheckGroup

public CheckGroup(String id,
          Collection<T> collection)

Constructor that wraps the provided collection with the org.apache.wicket.model.Model object

Parameters:

id - component id

collection - collection to be used as the model

CheckGroup

public CheckGroup(String id,
          IModel<? extends Collection<T>> model)

Parameters:

id -

model -

See Also:

WebMarkupContainer.WebMarkupContainer(String, IModel)

Method Detail

getModelValue

protected String getModelValue()

Overrides:

getModelValue in class FormComponent<Collection<T>>

Returns:

Value to return when model value is needed

See Also:

FormComponent.getModelValue()

convertValue

protected Collection<T> convertValue(String[] values)
                              throws ConversionException

Description copied from class: FormComponent

Subclasses should overwrite this if the conversion is not done through the type field and the IConverter. WARNING: this method may be removed in future versions. If conversion fails then a ConversionException should be thrown

Overrides:

convertValue in class FormComponent<Collection<T>>

Parameters:

values - The value can be the getInput() or through a cookie

Returns:

The converted value. default returns just the given value

Throws:

ConversionException - If input can't be converted

updateModel

public void updateModel()

See FormComponent.updateCollectionModel(FormComponent) for details on how the model is updated.

Specified by:

updateModel in interface IFormModelUpdateListener

Overrides:

updateModel in class FormComponent<Collection<T>>

onComponentTag

protected void onComponentTag(ComponentTag tag)

Description copied from class: FormComponent

Processes the component tag.

Overrides:

onComponentTag in class FormComponent<Collection<T>>

Parameters:

tag - Tag to modify

See Also:

Component.onComponentTag(ComponentTag)

onSelectionChanged

public final void onSelectionChanged()

Called when a selection changes.

Specified by:

onSelectionChanged in interface IOnChangeListener

onSelectionChanged

protected void onSelectionChanged(Collection<T> 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 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.

Parameters:

newSelection - The new selection of the CheckGroup. NOTE this is the same as you would get by calling getModelObject() if the new selection were current

See Also:

wantOnSelectionChangedNotifications()

wantOnSelectionChangedNotifications

protected boolean wantOnSelectionChangedNotifications()

This method should be overridden to return true if it is desirable to have on-selection-changed notification.

Returns:

true if component should receive on-selection-changed notifications, false otherwise

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