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
,IFeedbackContributor
,IConverterLocator
,IGenericComponent<T,Form<T>>
,IMetadataContext<Serializable,Component>
,IRequestListener
,IHeaderContributor
,IRequestableComponent
,IHierarchical<Component>
,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 thenForm.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, HIDDEN_FIELDS_CSS_CLASS_KEY, METHOD_GET, METHOD_POST, UPLOAD_FAILED_RESOURCE_KEY, UPLOAD_SINGLE_FILE_TOO_LARGE_RESOURCE_KEY, UPLOAD_TOO_LARGE_RESOURCE_KEY, UPLOAD_TOO_MANY_FILES_RESOURCE_KEY
-
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 FilterForm(String id, IFilterStateLocator<T> locator)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.protected String
generateHiddenInputMarkup()
Generates the Markup for the hidden input.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)
Append an additional hidden input tag to support anchor tags that can submit a form.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.Form
add, addDefaultSubmitButtonHandler, appendDefaultButtonField, beforeUpdateFormComponentModels, callOnError, clearInput, delegateSubmit, encodeUrlInHiddenFields, error, findForm, findSubmitter, getActionUrl, getDefaultButton, getFileCountMax, getFileMaxSize, getFormValidators, getInputNamePrefix, getJsForListenerUrl, getJsForSubmitter, getMaxSize, getMethod, getRootForm, getRootFormRelativeId, getStatelessHint, getValidatorKeyPrefix, handleMultiPart, hasError, internalOnModelChanged, isMultiPart, isRootForm, isSubmitted, markFormComponentsInvalid, markFormComponentsValid, onBeforeRender, onComponentTag, onDetach, onError, onEvent, onFileUploadException, onFormSubmitted, onMethodMismatch, onRequest, onSubmit, onValidate, onValidateModelObjects, process, remove, renderPlaceholderTag, setDefaultButton, setFileCountMax, setFileMaxSize, setMaxSize, setMultiPart, setVersioned, updateFormComponentModels, validate, validateComponents, validateFormValidator, validateFormValidators, visitFormComponents, visitFormComponentsPostOrder, wantSubmitOnNestedFormSubmit, wantSubmitOnParentFormSubmit, writeHiddenFields, writeParamsAsHiddenFields
-
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, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, 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, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onConfigure, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderPart, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, 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.IGenericComponent
getDefaultModel, getDefaultModelObject, getModel, getModelObject, setDefaultModel, setDefaultModelObject, setModel, setModelObject
-
Methods inherited from interface org.apache.wicket.IRequestListener
rendersPage
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Constructor Detail
-
FilterForm
public FilterForm(String id, IFilterStateLocator<T> locator)
- Parameters:
id
- component idlocator
- filter state locator
-
-
Method Detail
-
renderHead
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 interfaceIHeaderContributor
- Overrides:
renderHead
in classForm<T>
- Parameters:
response
- Response object
-
onComponentTagBody
public void onComponentTagBody(MarkupStream markupStream, ComponentTag openTag)
Append an additional hidden input tag to support anchor tags that can submit a form.- Overrides:
onComponentTagBody
in classForm<T>
- Parameters:
markupStream
- The markup streamopenTag
- The open tag for the body
-
generateHiddenInputMarkup
protected String generateHiddenInputMarkup()
Generates the Markup for the hidden input. Can be overridden by subclasses if necessary.- Returns:
- The markup to be appended to the response
-
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
-
-