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/GetConfigured Methods"

(Description)
(Replaced content with "The Scout documentation has been moved to https://eclipsescout.github.io/.")
 
Line 1: Line 1:
{{ScoutPage|cat=Client}}
+
The Scout documentation has been moved to https://eclipsescout.github.io/.
 
+
== Description ==
+
Properties can be configured on a lot of elements (Page, Form, Fields, Table, Columns ...). {{ScoutLink|SDK|name=Scout SDK}} with the {{ScoutLink|SDK|Object Properties View|Object Properties View}} offers a manner to configure theses properties very quickly.
+
 
+
In the code, a property is defined with special getter functions:
+
 
+
<source lang="java">
+
  @Override
+
  protected ... getConfiguredXxxxxxx() {
+
    return /*the value of the property*/;
+
  }
+
</source>
+
 
+
The Scout framework reads the configured properties during the initialization, and adapts the behavior of the object depending to its configuration. The <code>getXxxxxxx()</code> function should only return a constant. It is not expected to find an <code>if</code>-statement or call to another private or public method.
+
 
+
Often the properties can also be set dynamically with the corresponding setter [<code>setXxxxxxx()</code>]. To access the properties you can use the getter [<code>getXxxxxxx()</code>]. There should be no need to call <code>getConfiguredXxxxxxx()</code> function directly.
+
 
+
== See Also ==
+
 
+
* {{ScoutLink|Concepts|Exec Methods|execXxxxxx() Methods}}
+
* {{ScoutLink|SDK|Object Properties View|Object Properties View}}
+

Latest revision as of 04:23, 14 March 2024

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

Back to the top