Jump to: navigation, search

Scout/Concepts/Search Form

< Scout‎ | Concepts
Revision as of 06:49, 24 May 2012 by Jbr.bsiag.com (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)


Scout
Wiki Home
Website
DownloadGit
Community
ForumsBlogTwitter
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: I obj.pngISearchForm
  • extends: C obj.pngAbstractForm

Description

Note.png
TODO
Add a description

TODO:

Screenshot

Scout TablePage SearchForm.png


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:

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