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.
Difference between revisions of "Scout/Concepts/Layout"
(→Form Field Properties) |
(→Form Field Properties) |
||
| Line 56: | Line 56: | ||
<code>getConfiguredGridY()</code>. | <code>getConfiguredGridY()</code>. | ||
{{note|This property is for static layout only and should only be used in spacial cases!}} | {{note|This property is for static layout only and should only be used in spacial cases!}} | ||
| − | | | + | | -1 means no static grid position. |
|- | |- | ||
| getConfiguredGridY | | getConfiguredGridY | ||
| Line 65: | Line 65: | ||
<code>getConfiguredGridY()</code>. | <code>getConfiguredGridY()</code>. | ||
{{note|This property is for static layout only and should only be used in spacial cases!}} | {{note|This property is for static layout only and should only be used in spacial cases!}} | ||
| − | | | + | | -1 means no static grid position. |
|- | |- | ||
| getConfiguredGridW | | getConfiguredGridW | ||
| − | | | + | | Configures the column span of this group box. |
| − | | | + | The value defined by this property refers to the number of columns defined by the container of this field. |
| + | The column count of the container, which actually is the parent group box, can be configured by | ||
| + | <code>getConfiguredGridColumnCount()</code> (you need to configure that in the parent group box). | ||
| + | The maximum value is the number of columns of the containing container (group box) otherwise the value will be set runtimely to the number of columns of the container. | ||
| + | | 1 | ||
|- | |- | ||
| getConfiguredGridH | | getConfiguredGridH | ||
Revision as of 05:22, 4 April 2014
The Scout documentation has been moved to https://eclipsescout.github.io/.
The Concepts pages define concepts and elements used in the Eclipse Scout Framework.
Contents
Abstract
Scout provides a generic layout on any composite fields as:
- The Scout documentation has been moved to https://eclipsescout.github.io/.
- The Scout documentation has been moved to https://eclipsescout.github.io/.
- The Scout documentation has been moved to https://eclipsescout.github.io/.
- The Scout documentation has been moved to https://eclipsescout.github.io/.
- The Scout documentation has been moved to https://eclipsescout.github.io/.
The layout is mainly related to a grid layout with some additional features as weight related resize behavior and some optimizations reducing the used space. There are currently a horizontal and a vertical implementation of the grid layout.
Layout properties
Groupbox Properties
The following group box properties affect the layout of the container. So the fields in the container getting layouted respecting the properties.
| Config method | Meaning | Default value |
|---|---|---|
| getConfiguredBodyGrid | The layout orientation vertical vs. horizontal. Scout provides two layout strategies:
|
VerticalSmartGroupBoxBodyGrid.class |
| getConfiguredColumnCount | Column count of the layout where child fields are placed in respective to their layout data. | -1 Will be replaced with either the parent groupbox column count or if any of the parent group boxes has a grid column count 2. |
Form Field Properties
The form field properties define how a certain form field has to be layout in its container.
| Config method | Meaning | Default value |
|---|---|---|
| getConfiguredGridX | Configures the x position (horizontal) of this field in the logical grid of the surrounding group box. If the value is set to -1, the property will be ignored. If the value is >= 0, it's considered as grid column. This property only has an effect if every field inside the group box has a fix position which means every field
inside the group box need to have x and y to be set which can be configured by  This property is for static layout only and should only be used in spacial cases!
|
-1 means no static grid position. |
| getConfiguredGridY | Configures the y (vertical) position of this field in the logical grid of the surrounding group box.
If the value is set to -1, the property will be ignored. If the value is >= 0, it's considered as grid row.
This property only has an effect if every field inside the group box has a fix position which means every field
inside the group box need to have x and y to be set which can be configured by </code>getConfiguredGridX()</code> and
This property is for static layout only and should only be used in spacial cases!
|
-1 means no static grid position. |
| getConfiguredGridW | Configures the column span of this group box.
The value defined by this property refers to the number of columns defined by the container of this field.
The column count of the container, which actually is the parent group box, can be configured by
|
1 |
| getConfiguredGridH | desc | |
| getConfiguredGridWeightX | desc | |
| getConfiguredGridWeightY | desc | |
| getConfiguredGridUseUiWidth | desc | |
| getConfiguredGridUseUiHeight | desc |