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<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IGenericComponent<T,Form<T>>, IMetadataContext<Serializable,Component>, IRequestListener, 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:

  • Constructor Details

  • Method Details

    • 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>

    • 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