org.apache.wicket.markup.html.form

Class CheckGroupSelector

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

org.apache.wicket.markup.html.form.CheckGroupSelector

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, ILabelProvider<String>, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

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.

Author:

Igor Vaynberg, Carl-Eric Menzel

See Also:

CheckGroup, Check, Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING, RFLAG_CONTAINER_HAS_REMOVALS

Constructor Summary

Constructors

Constructor and Description
CheckGroupSelector(String id) A Selector that will look for a CheckGroup in its parent hierarchy.
CheckGroupSelector(String id, CheckGroup<?> group) A Selector that will work with the given group.

Method Summary

Modifier and Type	Method and Description
protected CharSequence	getFindCheckboxesFunction() Find all checkboxes in the containing form with the same input name as the CheckGroup .
boolean	isEnabled() Gets whether this component is enabled.
protected void	onBeforeRender() Called on all visible components before any component is rendered.

Methods inherited from class org.apache.wicket.markup.html.form.AbstractCheckSelector

onComponentTag, renderHead, wantAutomaticUpdate

Methods inherited from class org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

getLabel, onDetach, setLabel

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, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, 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, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CheckGroupSelector

public CheckGroupSelector(String id)

A Selector that will look for a CheckGroup in its parent hierarchy.

Parameters:

id - component id

CheckGroupSelector

public CheckGroupSelector(String id,
                          CheckGroup<?> group)

A Selector that will work with the given group.

Parameters:

id - component id

group - group to work with

Method Detail

onBeforeRender

protected void onBeforeRender()

Description copied from class: Component

Called on all visible components before any component is rendered.

NOTE: If you override this, you *must* call super.onBeforeRender() within your implementation. Because this method is responsible for cascading Component.onBeforeRender() call to its children it is strongly recommended that super call is made at the end of the override.

Changes to the component tree can be made only before calling super.onBeforeRender().

Overrides:

onBeforeRender in class Component

See Also:

MarkupContainer.addOrReplace(Component...)

isEnabled

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.

Overrides:

isEnabled in class Component

Returns:

Whether this component is enabled.

getFindCheckboxesFunction

protected CharSequence getFindCheckboxesFunction()

Find all checkboxes in the containing form with the same input name as the CheckGroup .

Specified by:

getFindCheckboxesFunction in class AbstractCheckSelector

Returns:

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.