wicket.markup.html.form
Class CheckGroup

java.lang.Object
  extended by wicket.Component
      extended by wicket.MarkupContainer
          extended by wicket.markup.html.WebMarkupContainer
              extended by wicket.markup.html.form.FormComponent
                  extended by wicket.markup.html.form.CheckGroup
All Implemented Interfaces:
java.io.Serializable, IRequestListener, IOnChangeListener

public class CheckGroup
extends FormComponent
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 (ivaynberg@users.sf.net)
See Also:
Check,

Note: This component does not support cookie persistence, Serialized Form


Nested Class Summary
 
Nested classes/interfaces inherited from class wicket.markup.html.form.FormComponent
FormComponent.IVisitor
 
Nested classes/interfaces inherited from class wicket.Component
Component.ComponentModelChange, Component.EnabledChange, Component.VisibilityChange
 
Field Summary
 
Fields inherited from class wicket.markup.html.form.FormComponent
FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, VALUE_SEPARATOR
 
Fields inherited from class 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 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 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.
 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 expect that the object is already converted through the convert() call.
protected  boolean wantOnSelectionChangedNotifications()
          This method should be overridden to return true if it is desirable to have on-selection-changed notifiaction.
 
Methods inherited from class wicket.markup.html.form.FormComponent
add, checkRequired, clearInput, convert, error, getConvertedInput, getForm, getInput, getInputAsArray, getInputName, getLabel, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputAsStringArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isPersistent, isRequired, isValid, isValidated, onComponentTag, onDetach, onDisabled, onInvalid, onValid, processInput, setLabel, setModelValue, setModelValue, setPersistent, setRequired, setType, valid, validate, validateRequired, validateValidators
 
Methods inherited from class wicket.markup.html.WebMarkupContainer
getMarkupType, getWebPage
 
Methods inherited from class wicket.MarkupContainer
add, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, internalAdd, internalAttach, internalDetach, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren
 
Methods inherited from class wicket.Component
add, addStateChange, checkComponentTag, checkComponentTagAttribute, continueToOriginalDestination, debug, detachBehaviors, detachModel, detachModels, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getApplicationPages, getApplicationSettings, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMetaData, getModel, getModelComparator, getModelObject, getModelObjectAsString, getOutputMarkupId, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getString, getString, getString, getStyle, getVariation, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnAttach, internalOnDetach, isActionAuthorized, isAncestorOf, isBehaviorAccepted, isEnableAllowed, isEnabled, isHeadRendered, isIgnoreAttributeModifier, isRenderAllowed, isVersioned, isVisible, isVisibleInHierarchy, modelChanged, modelChanging, newPage, newPage, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onEndRequest, onModelChanged, onModelChanging, onRender, redirectToInterceptPage, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderedBehaviors, renderHead, replaceComponentTagBody, replaceWith, resetHeadRendered, sameRootModel, sameRootModel, setAuto, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMetaData, setModelObject, setOutputMarkupId, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CheckGroup

public CheckGroup(java.lang.String id)
Constructor that will create a default model collection

Parameters:
id - component id

CheckGroup

public CheckGroup(java.lang.String id,
                  java.util.Collection collection)
Constructor that wraps the provided collection with the wicket.model.Model object

Parameters:
id - component id
collection - collection to be used as the model

CheckGroup

public CheckGroup(java.lang.String id,
                  IModel model)
See Also:
WebMarkupContainer.WebMarkupContainer(String, IModel)
Method Detail

convertValue

protected java.lang.Object convertValue(java.lang.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
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
See Also:
FormComponent.convertValue(String[])

updateModel

public void updateModel()
Description copied from class: FormComponent
Updates this components' model from the request, it expect that the object is already converted through the convert() call. By default it just does this:
 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.

Overrides:
updateModel in class FormComponent
See Also:
FormComponent.updateModel()

supportsPersistence

protected final boolean supportsPersistence()
Check group does not support persistence through cookies

Overrides:
supportsPersistence in class FormComponent
Returns:
True if this type of FormComponent can be persisted.
See Also:
FormComponent.supportsPersistence()

onSelectionChanged

public final void onSelectionChanged()
Called when a selection changes.

Specified by:
onSelectionChanged in interface IOnChangeListener

onSelectionChanged

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

wantOnSelectionChangedNotifications

protected boolean wantOnSelectionChangedNotifications()
This method should be overridden to return true if it is desirable to have on-selection-changed notifiaction.

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


Copyright © 2004-2007 Wicket developers. All Rights Reserved.