Skip to main content
Jump to: navigation, search

Scout/Concepts/Layout

< Scout‎ | Concepts
Revision as of 05:35, 4 April 2014 by Andreas.hoegger.bsiag.com (Talk | contribs) (Form Field Properties)


Scout
Wiki Home
Website
DownloadGit
Community
ForumsBlogTwitterG+
Bugzilla
Bugzilla


The Concepts pages define concepts and elements used in the Eclipse Scout Framework.

Abstract

Scout provides a generic layout on any composite fields as:

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.

VerticalSmartGroupBoxBodyGrid

The fields are placed in column first in the grid. The number of rows is variable and calculated from the fields and its layout properties placed in this layout. E.g.

Field01 Field04 Field07
Field02 Field05 Field08
Field03 Field06 Field09


HorizontalGroupBoxBodyGrid

The fields are placed in row first in the grid. The number of rows is variable and calculated from the fields and its layout properties placed in this layout. E.g.

Field01 Field02 Field03
Field04 Field05 Field06
Field07 Field08 Field09


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.
It is not necessary to explicitly set a column count by AbstractGroupBox#getConfiguredGridColumnCount().

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 getConfiguredGridX() and getConfiguredGridY().

Note.png
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 getConfiguredGridY().

Note.png
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 getConfiguredGridColumnCount() (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 desc
getConfiguredGridWeightX desc
getConfiguredGridWeightY desc
getConfiguredGridUseUiWidth desc
getConfiguredGridUseUiHeight desc

Layout Inspector

Back to the top