Scout/Concepts/Search Form

Scout

Wiki Home

Website

Download • Git

Community

Forums • Blog • Twitter • G+

Bugzilla

Bugzilla

Search Form is special kind of form where the user will enter some values to formulate a query to load the content of a table page.

• implements: ISearchForm
• extends: AbstractForm

Description

TODO
Add a description

TODO:

• To be used with a Table Page.
• SearchFilter: contains the FormData corresponding to the SearchForm.
• LoadTableData event of the TablePage uses the searchFilter and send it to the OutlineService .

Screenshot

Properties

Defined with getConfiguredXxxxxx() methods.

All properties of Form are available. SearchForm does just change some of the default parameters:

• MinimizeEnabled is true
• AskIfNeedSave is true

With DisplayViewId you can change where the SearchForm is displayed:

• 

  South (on bottom - default)

• 

  North (on top)

• 

  East (on the right)

Events

Defined with execXxxxxx() methods. All events are defined in the Form class.

execResetSearchFilter(..)

The Form is responsible to produce the SearchFilter that is used in the TablePage in the LoadTableData event.

This is an example of how the ResetSearchFilter event can be implemented:

  @Override
  protected void execResetSearchFilter(SearchFilter searchFilter) throws ProcessingException{
    super.execResetSearchFilter(searchFilter);
    PersonSearchFormData formData = new PersonSearchFormData();
    exportFormData(formData);
    searchFilter.setFormData(formData);
  }

Remarks

startSearch()

All SearchForm needs to implement a startSearch() function. In most of the case, the SearchForm contains a FormHandler named SearchHandler. The function starts the Form with this handler:

  public void startSearch()throws ProcessingException {
    startInternal(new SearchHandler());
  }

See Also

• Form
• Table Page
• FormData
• Client Plug-In