Module org.apache.wicket.extensions
Package 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<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.feedback.IFeedbackContributor, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<T,org.apache.wicket.markup.html.form.Form<T>>, org.apache.wicket.IMetadataContext<Serializable,org.apache.wicket.Component>, org.apache.wicket.IRequestListener, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable
public class FilterForm<T> extends org.apache.wicket.markup.html.form.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:

  • Nested Class Summary

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

    org.apache.wicket.markup.html.form.Form.MethodMismatchResponse, org.apache.wicket.markup.html.form.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

    Modifier and Type
    Method
    Description
    final void
    enableFocusTracking(org.apache.wicket.markup.html.form.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.
    final String
    getFocusTrackerFieldCssId()
     
    final String
    getFocusTrackingHandler(org.apache.wicket.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.
    final IFilterStateLocator<T>
    getStateLocator()
     
    void
    onComponentTagBody(org.apache.wicket.markup.MarkupStream markupStream, org.apache.wicket.markup.ComponentTag openTag)
    void
    renderHead(org.apache.wicket.markup.head.IHeaderResponse response)
     

    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, onAfterUpdateFormComponentModels, onBeforeRender, onBeforeUpdateFormComponentModels, 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, 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 Details

  • Method Details

    • renderHead

      public void renderHead(org.apache.wicket.markup.head.IHeaderResponse response)
      Specified by:
      renderHead in interface org.apache.wicket.markup.html.IHeaderContributor
      Overrides:
      renderHead in class org.apache.wicket.markup.html.form.Form<T>

    • onComponentTagBody

      public void onComponentTagBody(org.apache.wicket.markup.MarkupStream markupStream, org.apache.wicket.markup.ComponentTag openTag)
      Overrides:
      onComponentTagBody in class org.apache.wicket.markup.html.form.Form<T>

    • 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(org.apache.wicket.markup.html.form.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(org.apache.wicket.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