Module org.apache.wicket.extensions

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

Class GoAndClearFilter

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

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

All Implemented Interfaces:

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

public class GoAndClearFilter
extends GoFilter

Filter component that generates a 'go' and 'clear' buttons.

Author:

Igor Vaynberg (ivaynberg)

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.extensions.markup.html.repeater.data.table.filter.GoFilter

DEFAULT_GO_MODEL

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
GoAndClearFilter(String id, FilterForm<?> form)	Constructor This constructor will use default models for the 'clear' and 'go' button labels.
GoAndClearFilter(String id, FilterForm<?> form, IModel<String> goModel, IModel<String> clearModel)	Constructor.
GoAndClearFilter(String id, IModel<String> goModel, IModel<String> clearModel, Object originalState)	Constructor

Method Summary

Modifier and Type	Method	Description
protected Button	getClearButton()
protected void	onClearSubmit(Button button)	This method should be implemented by subclasses to provide behavior for the clear button.

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

getGoButton, onGoSubmit

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

GoAndClearFilter

public GoAndClearFilter(String id,
 FilterForm<?> form)

Constructor This constructor will use default models for the 'clear' and 'go' button labels. Uses the form's model object as an original state

Parameters:

id - component id

form - filter form of the filter toolbar

GoAndClearFilter

public GoAndClearFilter(String id,
 FilterForm<?> form,
 IModel<String> goModel,
 IModel<String> clearModel)

Constructor. Uses the form's model object as an original state

Parameters:

id - component id

form - filter form of the filter toolbar

goModel - model for the label of the 'go' button

clearModel - model for the label of the 'clear' button

GoAndClearFilter

public GoAndClearFilter(String id,
 IModel<String> goModel,
 IModel<String> clearModel,
 Object originalState)

Constructor

Parameters:

id - component id

goModel - model for the label of the 'go' button

clearModel - model for the label of the 'clear' button

originalState - the object to use as original state

Method Details

getClearButton

protected Button getClearButton()

Returns:

button component representing the clear button

onClearSubmit

protected void onClearSubmit(Button button)

This method should be implemented by subclasses to provide behavior for the clear button.

Parameters:

button - the 'clear' button