Module org.apache.wicket.extensions

Package org.apache.wicket.extensions.markup.html.repeater.data.table.filter

Class ChoiceFilter<T>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

org.apache.wicket.extensions.markup.html.repeater.data.table.filter.AbstractFilter

org.apache.wicket.extensions.markup.html.repeater.data.table.filter.ChoiceFilter<T>

Type Parameters:

T - The model object type

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IMetadataContext<Serializable,Component>, IQueueRegion, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

public class ChoiceFilter<T>
extends AbstractFilter

Filter that can be represented by a drop down list of choices

Author:

Igor Vaynberg (ivaynberg)

See Also:

• DropDownChoice
• Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.markup.html.panel.Panel

PANEL

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	Description
ChoiceFilter(String id, IModel<T> model, FilterForm<?> form, List<? extends T> choices, boolean autoSubmit)	Constructor
ChoiceFilter(String id, IModel<T> model, FilterForm<?> form, List<? extends T> choices, IChoiceRenderer<? super T> renderer, boolean autoSubmit)	Constructor
ChoiceFilter(String id, IModel<T> model, FilterForm<?> form, IModel<? extends List<? extends T>> choices, boolean autoSubmit)	Constructor.
ChoiceFilter(String id, IModel<T> model, FilterForm<?> form, IModel<? extends List<? extends T>> choices, IChoiceRenderer<? super T> renderer, boolean autoSubmit)

Method Summary

Modifier and Type	Method	Description
final DropDownChoice<T>	getChoice()
protected DropDownChoice<T>	newDropDownChoice(String id, IModel<T> model, IModel<? extends List<? extends T>> choices, IChoiceRenderer<? super T> renderer)	Factory method for the drop down choice component

Methods inherited from class org.apache.wicket.extensions.markup.html.repeater.data.table.filter.AbstractFilter

enableFocusTracking, getState, getStateLocator, getStateModel

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

getRegionMarkup, newMarkupSourcingStrategy

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, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, 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, getMarkupTag, 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, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, 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 org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

ChoiceFilter

public ChoiceFilter(String id,
 IModel<T> model,
 FilterForm<?> form,
 IModel<? extends List<? extends T>> choices,
 boolean autoSubmit)

Constructor.

Parameters:

id - component id

model - model for the drop down choice component

form - filter form this component will be attached to

choices - list of choices, see DropDownChoice

autoSubmit - if true this filter will submit the form on selection change

ChoiceFilter

public ChoiceFilter(String id,
 IModel<T> model,
 FilterForm<?> form,
 List<? extends T> choices,
 boolean autoSubmit)

Constructor

Parameters:

id - component id

model - model for the drop down choice component

form - filter form this component will be attached to

choices - list of choices, see DropDownChoice

autoSubmit - if true this filter will submit the form on selection change

ChoiceFilter

public ChoiceFilter(String id,
 IModel<T> model,
 FilterForm<?> form,
 List<? extends T> choices,
 IChoiceRenderer<? super T> renderer,
 boolean autoSubmit)

Constructor

Parameters:

id - component id

model - model for the drop down choice component

form - filter form this component will be attached to

choices - list of choices, see DropDownChoice

renderer - choice renderer, see DropDownChoice

autoSubmit - if true this filter will submit the form on selection change

ChoiceFilter

public ChoiceFilter(String id,
 IModel<T> model,
 FilterForm<?> form,
 IModel<? extends List<? extends T>> choices,
 IChoiceRenderer<? super T> renderer,
 boolean autoSubmit)

Parameters:

id - component id

model - model for the drop down choice component

form - filter form this component will be attached to

choices - list of choices, see DropDownChoice

renderer - choice renderer, see DropDownChoice

autoSubmit - if true this filter will submit the form on selection change

See Also:

• DropDownChoice

Method Details

newDropDownChoice

protected DropDownChoice<T> newDropDownChoice(String id,
 IModel<T> model,
 IModel<? extends List<? extends T>> choices,
 IChoiceRenderer<? super T> renderer)

Factory method for the drop down choice component

Parameters:

id - component id

model - component model

choices - choices model

renderer - choice renderer

Returns:

created drop down component

getChoice

public final DropDownChoice<T> getChoice()

Returns:

the DropDownChoice form component created to represent this filter