Scout/Concepts/GetConfigured Methods

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

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