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

Class FilterForm<T>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.form.Form<T>

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

Type Parameters:

T - type of filter state object

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IConverterLocator, IGenericComponent<T>, IRequestListener, IFormSubmitListener, IHeaderContributor, IRequestableComponent, org.apache.wicket.util.IHierarchical<Component>, org.apache.wicket.util.io.IClusterable

public class FilterForm<T>
extends Form<T>

A form with filter-related special functionality for its form components.

This form uses an invisible button to be able to submit when the user presses the ENTER key. If there is a need to add an explicit IFormSubmittingComponent to this form then Form.setDefaultButton(org.apache.wicket.markup.html.form.IFormSubmittingComponent) should be used to specify this custom submitting component.

Author:

igor

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.markup.html.form.Form

Form.MethodMismatchResponse, Form.ValidationVisitor

Field Summary

Fields inherited from class org.apache.wicket.markup.html.form.Form

ENCTYPE_MULTIPART_FORM_DATA, METHOD_GET, METHOD_POST

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_AFTER_RENDERING, FLAG_INITIALIZED, FLAG_PREPARED_FOR_RENDER, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RENDERING, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

Fields inherited from interface org.apache.wicket.markup.html.form.IFormSubmitListener

INTERFACE

Constructor Summary

Constructors

Constructor and Description
FilterForm(String id, IFilterStateLocator<T> locator)

Method Summary

Methods

Modifier and Type	Method and Description
void	enableFocusTracking(FormComponent<?> fc) Adds behavior to the form component to allow this form to keep track of the component's focus which will be restored after a form submit.
String	getFocusTrackerFieldCssId()
String	getFocusTrackingHandler(Component component) Returns the javascript focus handler necessary to notify the form of focus tracking changes on the component Useful when components want to participate in focus tracking but want to add the handler their own way.
IFilterStateLocator<T>	getStateLocator()
void	onComponentTagBody(MarkupStream markupStream, ComponentTag openTag)
void	renderHead(IHeaderResponse response)

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

add, appendDefaultButtonField, beforeUpdateFormComponentModels, callOnError, clearInput, delegateSubmit, encodeUrlInHiddenFields, error, findForm, findSubmittingButton, getActionUrl, getDefaultButton, getFileMaxSize, getFormValidators, getHiddenFieldId, getInputNamePrefix, getJsForInterfaceUrl, getMaxSize, getMethod, getModel, getModelObject, getRootForm, getRootFormRelativeId, getStatelessHint, getValidatorKeyPrefix, handleMultiPart, hasError, internalOnModelChanged, isMultiPart, isRootForm, isSubmitted, markFormComponentsInvalid, markFormComponentsValid, onBeforeRender, onComponentTag, onDetach, onError, onFileUploadException, onFormSubmitted, onFormSubmitted, onMethodMismatch, onSubmit, onValidate, onValidateModelObjects, process, registerJavaScriptNamespaces, remove, renderPlaceholderTag, setDefaultButton, setFileMaxSize, setMaxSize, setModel, setModelObject, setMultiPart, setVersioned, updateFormComponentModels, validate, validateComponents, validateFormValidator, validateFormValidators, visitFormComponents, visitFormComponentsPostOrder, wantSubmitOnNestedFormSubmit, writeHiddenFields, writeParamsAsHiddenFields

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findComponentToDequeue, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, onInitialize, onRender, queue, 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, canCallListenerInterfaceAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, 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, 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, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterForm

public FilterForm(String id,
          IFilterStateLocator<T> locator)

Parameters:

id - component id

locator - filter state locator

Method Detail

renderHead

public void renderHead(IHeaderResponse response)

Specified by:

renderHead in interface IHeaderContributor

Overrides:

renderHead in class Form<T>

onComponentTagBody

public void onComponentTagBody(MarkupStream markupStream,
                      ComponentTag openTag)

Overrides:

onComponentTagBody in class Form<T>

getFocusTrackerFieldCssId

public final String getFocusTrackerFieldCssId()

Returns:

css id of the hidden form input that keeps track of the focused input field

getStateLocator

public final IFilterStateLocator<T> getStateLocator()

Returns:

IFilterStateLocator passed to this form

enableFocusTracking

public final void enableFocusTracking(FormComponent<?> fc)

Adds behavior to the form component to allow this form to keep track of the component's focus which will be restored after a form submit.

Parameters:

fc - form component

getFocusTrackingHandler

public final String getFocusTrackingHandler(Component component)

Returns the javascript focus handler necessary to notify the form of focus tracking changes on the component Useful when components want to participate in focus tracking but want to add the handler their own way. A unique css id is required on the form component for focus tracking to work.

Parameters:

component - component to

Returns:

the javascript focus handler necessary to notify the form of focus tracking changes on the component