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

Revision as of 13:25, 18 March 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/..

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

Description

TODO
Add a description

TODO:

To be used with a TablePage
SearchFilter: contains the FormData corresponding to the SearchForm.
Server: The Scout documentation has been moved to https://eclipsescout.github.io/. using The Scout documentation has been moved to https://eclipsescout.github.io/.

Screenshot

TODO
Add a screenshot: Example of a Search form. TablePage of an application

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:

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

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 SearchFilter 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());
  }

@@ Line 1: / Line 1: @@
 {{ScoutPage|cat=Concepts}}
-Search Form is special kind of {{ScoutLink|Concepts|Form|form}} where the user will set some value to formulate a query to load the content of a {{ScoutLink|Concepts|TablePage|table page}}.
+Search Form is special kind of {{ScoutLink|Concepts|Form|form}} where the user will enter some values to formulate a query to load the content of a {{ScoutLink|Concepts|TablePage|table page}}.
-* implements: {{ScoutJavadoc|<TODO:NameOfTheInterface>|I}}
+* implements: {{ScoutJavadoc|ISearchForm|I}}
-* extends: {{ScoutJavadoc|<TODO:NameOfTheAbstractClass>|C}}
+* extends: {{ScoutJavadoc|AbstractForm|C}}
 == Description ==
 {{note|TODO|Add a description}}
+TODO:
+* To be used with a TablePage
+* SearchFilter: contains the FormData corresponding to the SearchForm.
+* Server: {{ScoutLink|Concepts|Process_Service|ProcessService}} using {{ScoutLink|Concepts|FormDataStatementBuilder|FormDataStatementBuilder}}
 == Screenshot ==
-{{note|TODO|Add a screenshot (or remove this section, if there is no screenshot to make)}}
+{{note|TODO|Add a screenshot: Example of a Search form. TablePage of an application}}
@@ Line 17: / Line 20: @@
 ''Defined with {{ScoutLink|Concepts|GetConfigured Methods|getConfiguredXxxxxx()}} methods''.
-{{note|TODO|Add a description of important properties. The idea is not to recreate the JavaDoc of the getConfiguredXxxxxx() methods but to provide explanations, best practice, example... Group the properties by domain.}}
+All properties of {{ScoutLink|Concepts|Form|Form}} are available. SearchForm does just change some of the default parameters:
+* {{ScoutProp|MinimizeEnabled}} is '''true'''
+* {{ScoutProp|AskIfNeedSave}} is '''true'''
 == Events ==
-''Defined with {{ScoutLink|Concepts|Exec_Methods|execXxxxxx()}} methods''.
+''Defined with {{ScoutLink|Concepts|Exec_Methods|execXxxxxx()}} methods''. All events are defined in the {{ScoutLink|Concepts|Form|Form}} class.
+=== execResetSearchFilter(..) ===
+The Form is responsible to produce the 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:
+<source lang="java">
+  @Override
+  protected void execResetSearchFilter(SearchFilter searchFilter) throws ProcessingException{
+    super.execResetSearchFilter(searchFilter);
+    PersonSearchFormData formData = new PersonSearchFormData();
+    exportFormData(formData);
+    searchFilter.setFormData(formData);
+  }
+</source>
+== Remarks ==
+=== startSearch() ===
+All SearchForm needs to implement a <code>startSearch()</code> function. In most of the case, the SearchForm contains a {{ScoutLink|Concepts|Form_Handler|FormHandler}} named <code>SearchHandler</code>. The function starts the Form with this handler:
-{{note|TODO|Add a description of important events. The idea is not to recreate the JavaDoc of the execXxxxxx() methods but to provide explanations, best practice, example... Group the events by domain.}}
+<source lang="java">
+  public void startSearch()throws ProcessingException {
+    startInternal(new SearchHandler());
+  }
+</source>
@@ Line 29: / Line 57: @@
 * {{ScoutLink|Concepts|Form|Form}}
 * {{ScoutLink|Concepts|TablePage|Table Page}}
+* {{ScoutLink|Concepts|FormData|FormData}}
+* {{ScoutLink|Concepts|Process_Service|ProcessService}}
+* {{ScoutLink|Concepts|FormDataStatementBuilder|FormDataStatementBuilder}}
 * {{ScoutLink|Concepts|Client Plug-In|Client Plug-In}}

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

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

Revision as of 13:25, 18 March 2011

Contents

Description

Screenshot

Properties

Events

execResetSearchFilter(..)

Remarks

startSearch()

See Also

Breadcrumbs

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

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

Revision as of 13:25, 18 March 2011

Contents

Description

Screenshot

Properties

Events

execResetSearchFilter(..)

Remarks

startSearch()

See Also