Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Scout/Concepts/Search Form"

(screenshot and corrections)
Line 9: Line 9:
 
{{note|TODO|Add a description}}
 
{{note|TODO|Add a description}}
 
TODO:  
 
TODO:  
* To be used with a TablePage
+
* To be used with a {{ScoutLink|Concepts|TablePage|Table Page}}.
* SearchFilter: contains the FormData corresponding to the SearchForm.
+
* {{ScoutLink|Concepts|SearchFilter|SearchFilter}}: contains the {{ScoutLink|Concepts|FormData|FormData}} corresponding to the SearchForm.
* Server: {{ScoutLink|Concepts|Process_Service|ProcessService}} using {{ScoutLink|Concepts|FormDataStatementBuilder|FormDataStatementBuilder}}
+
* {{ScoutEvent|LoadTableData}} event of the TablePage uses the searchFilter and send it to the {{ScoutLink|Concepts|Outline_Service|OutlineService}} .
  
 
== Screenshot ==
 
== Screenshot ==
{{note|TODO|Add a screenshot: Example of a Search form. TablePage of an application}}
+
[[Image:Scout_TablePage_SearchForm.png]]
  
  
Line 29: Line 29:
  
 
=== execResetSearchFilter(..) ===
 
=== execResetSearchFilter(..) ===
The Form is responsible to produce the SearchFilter that is used in the {{ScoutLink|Concepts|TablePage|TablePage}} in the {{ScoutEvent|LoadTableData}} event.  
+
The Form is responsible to produce the {{ScoutLink|Concepts|SearchFilter|SearchFilter}} that is used in the {{ScoutLink|Concepts|TablePage|TablePage}} in the {{ScoutEvent|LoadTableData}} event.  
  
 
This is an example of how the {{ScoutEvent|ResetSearchFilter}} event can be implemented:
 
This is an example of how the {{ScoutEvent|ResetSearchFilter}} event can be implemented:
Line 58: Line 58:
 
* {{ScoutLink|Concepts|TablePage|Table Page}}
 
* {{ScoutLink|Concepts|TablePage|Table Page}}
 
* {{ScoutLink|Concepts|FormData|FormData}}
 
* {{ScoutLink|Concepts|FormData|FormData}}
* {{ScoutLink|Concepts|Process_Service|ProcessService}}
 
* {{ScoutLink|Concepts|FormDataStatementBuilder|FormDataStatementBuilder}}
 
 
* {{ScoutLink|Concepts|Client Plug-In|Client Plug-In}}
 
* {{ScoutLink|Concepts|Client Plug-In|Client Plug-In}}

Revision as of 02:55, 17 April 2011

The Scout documentation has been moved to https://eclipsescout.github.io/.

Search Form is special kind of The Scout documentation has been moved to https://eclipsescout.github.io/. where the user will enter some values to formulate a query to load the content of a The Scout documentation has been moved to https://eclipsescout.github.io/..

Description

Note.png
TODO
Add a description

TODO:

Screenshot

Scout TablePage SearchForm.png


Properties

Defined with The Scout documentation has been moved to https://eclipsescout.github.io/. methods.

All properties of The Scout documentation has been moved to https://eclipsescout.github.io/. are available. SearchForm does just change some of the default parameters:


Events

Defined with The Scout documentation has been moved to https://eclipsescout.github.io/. methods. All events are defined in the The Scout documentation has been moved to https://eclipsescout.github.io/. class.

execResetSearchFilter(..)

The Form is responsible to produce the The Scout documentation has been moved to https://eclipsescout.github.io/. that is used in the The Scout documentation has been moved to https://eclipsescout.github.io/. in the The Scout documentation has been moved to https://eclipsescout.github.io/. event.

This is an example of how the The Scout documentation has been moved to https://eclipsescout.github.io/. 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 The Scout documentation has been moved to https://eclipsescout.github.io/. named SearchHandler. The function starts the Form with this handler:

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


See Also

Back to the top