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"

m (Category changed)
(Description)
Line 6: Line 6:
 
In the code, a property is defined with special getter functions:
 
In the code, a property is defined with special getter functions:
  
 +
<source lang="java">
 
   @Override
 
   @Override
 
   protected ... getConfiguredXxxxxxx() {
 
   protected ... getConfiguredXxxxxxx() {
     return /*the value of the property*/
+
     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.
 
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.

Revision as of 02:45, 15 July 2014

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 ...). The Scout documentation has been moved to https://eclipsescout.github.io/. with the The Scout documentation has been moved to https://eclipsescout.github.io/. offers a manner to configure theses properties very quickly.

In the code, a property is defined with special getter functions:

  @Override
  protected ... getConfiguredXxxxxxx() {
    return /*the value of the property*/;
  }

The Scout framework reads the configured properties during the initialization, and adapts the behavior of the object depending to its configuration. The getXxxxxxx() function should only return a constant. It is not expected to find an if-statement or call to another private or public method.

Often the properties can also be set dynamically with the corresponding setter [setXxxxxxx()]. To access the properties you can use the getter [getXxxxxxx()]. There should be no need to call getConfiguredXxxxxxx() function directly.

See Also

Back to the top