Class CheckGroupSelector

  extended by org.apache.wicket.Component
      extended by org.apache.wicket.MarkupContainer
          extended by org.apache.wicket.markup.html.WebMarkupContainer
              extended by org.apache.wicket.markup.html.form.LabeledWebMarkupContainer
                  extended by org.apache.wicket.markup.html.form.AbstractCheckSelector
                      extended by org.apache.wicket.markup.html.form.CheckGroupSelector
All Implemented Interfaces:, java.lang.Iterable<Component>, IEventSink, IEventSource, IClusterable, IConverterLocator, ILabelProvider<java.lang.String>, IHeaderContributor, IRequestableComponent, IHierarchical<Component>

public class CheckGroupSelector
extends AbstractCheckSelector

Selects and deselects all Check components under the same CheckGroup as itself. Selection toggling is accomplished by generating an onclick javascript event handler. This component must be attached to markup of type <input type="checkbox"/>. Additionally, if CheckGroupSelector(String) constuctor is used the selector must be a descendant of the CheckGroup it is meant to affect.

Igor Vaynberg, Carl-Eric Menzel
See Also:
CheckGroup, Check, Serialized Form

Field Summary
Fields inherited from class org.apache.wicket.Component
Constructor Summary
CheckGroupSelector(java.lang.String id)
          A Selector that will look for a CheckGroup in its parent hierarchy.
CheckGroupSelector(java.lang.String id, CheckGroup<?> group)
          A Selector that will work with the given group.
Method Summary
protected  java.lang.CharSequence getFindCheckboxesFunction()
          Concrete subclasses must override this to provide a Javascript function that returns the IDs of all checkboxes that should be controlled by this selector.
 boolean isEnabled()
          Gets whether this component is enabled.
protected  void onInitialize()
          This method is meant to be used as an alternative to initialize components.
 void renderHead(IHeaderResponse response)
          Render to the web response whatever the component wants to contribute to the head section.
Methods inherited from class org.apache.wicket.markup.html.form.AbstractCheckSelector
onComponentTag, wantAutomaticUpdate
Methods inherited from class org.apache.wicket.markup.html.form.LabeledWebMarkupContainer
getLabel, onDetach, setLabelInternal
Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer
getWebPage, getWebRequest
Methods inherited from class org.apache.wicket.MarkupContainer
add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, hasAssociatedMarkup, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onMarkupAttached, onRender, 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, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, 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, getFeedbackMessage, 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, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onConfigure, onEvent, onModelChanged, onModelChanging, 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, warn, wrap
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail


public CheckGroupSelector(java.lang.String id)
A Selector that will look for a CheckGroup in its parent hierarchy.

id - component id


public CheckGroupSelector(java.lang.String id,
                          CheckGroup<?> group)
A Selector that will work with the given group.

id - component id
group - group to work with
Method Detail


public void renderHead(IHeaderResponse response)
Description copied from class: Component
Render to the web response whatever the component wants to contribute to the head section.

Specified by:
renderHead in interface IHeaderContributor
renderHead in class AbstractCheckSelector
response - Response object


protected void onInitialize()
Description copied from class: Component
This method is meant to be used as an alternative to initialize components. Usually the component's constructor is used for this task, but sometimes a component cannot be initialized in isolation, it may need to access its parent component or its markup in order to fully initialize. This method is invoked once per component's lifecycle when a path exists from this component to the Page thus providing the component with an atomic callback when the component's environment is built out.

Overrides must call super#Component.onInitialize(). Usually this should be the first thing an override does, much like a constructor.

Parent containers are guaranteed to be initialized before their children

It is safe to use Component.getPage() in this method

NOTE:The timing of this call is not precise, the contract is that it is called sometime before Component.onBeforeRender().

onInitialize in class Component


public boolean isEnabled()
Description copied from class: Component
Gets whether this component is enabled. Specific components may decide to implement special behavior that uses this property, like web form components that add a disabled='disabled' attribute when enabled is false.

isEnabled in class Component
Whether this component is enabled.


protected java.lang.CharSequence getFindCheckboxesFunction()
Description copied from class: AbstractCheckSelector
Concrete subclasses must override this to provide a Javascript function that returns the IDs of all checkboxes that should be controlled by this selector.

Specified by:
getFindCheckboxesFunction in class AbstractCheckSelector
a String containing a Javascript expression that evaluates to a function(!). This function must return an array containing the IDs of all checkbox input elements that this selector should control.

Copyright © 2006-2011 Apache Software Foundation. All Rights Reserved.