t_ScreenLayout_LayoutRef

LayoutRef

Properties

association : string

Layout element's association path: <layout-ref> <assoc1> ... <assocN>

Portlets and Dialogs can host one or more layouts. Each layout has a class for data binding. Associations allow you to connect the layouts.

For instance, we have two layouts hosted in a portlet - name="personRef", class="Person" and name="addressRef", class="Address". A normal configuration is for a blank personRef association and the addressRef association to be "personRef addrs". This means that the addressRef portlet will show all the addresses in the addrs attribute of the currently selected Person.

attributes : string

Additional association paths to retrieve

augment : uiIdentifier

A path to the view to augment with this view.

Augmentation rules depend on the types of augmented and augmenting views. When augmented view is a layout, such as Composite, Tabs, or Switch, and augmenting view is also of the same type, the children views will be added to the augmented layout. When both augmented views are layouts but of different type, the augmenting view is inserted next to the augmented one. When augmented view is primitive, the augmenting view is inserted next to it.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*	Value must begin with a letter. Case and length are not restricted. Letters and numbers are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

caption : string

Caption text expression

enabled : string

Enablement flag association path or expression

head : boolean

True to start a new row in the layout

icon : string

Icon name expression

iconCaption : string

Icon caption expression

layout : identifier

Referenced layout name

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

lazy : boolean

Valid when child collection. Specifies whether a separate read request will be generated

name : identifier

Unique view name

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

off : unsignedInt

Number of columns to skip from the previous view in the same row

order : string

Item order specification: ((<attr1> . #t|#f) ... (<attrN> . #t|#f)

List of attributes or attribute and boolean pairs to indicate ascending (#t) or descending (#f).

Example

((name . #t) (company . #f))

privilege : identifier

Access privilege

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

query : boolean

True for data query mode, false for data entry/display mode

sort : ComboSortType

Set to "server" to perform sort on the server, "client" to perform sort on the client when order expression is not supported by the data source

Valid values based on“string”.
client	The model will be sorted on the client.
server	The model will be sorted on the server.

span : int

Number of consecutive columns to occupy

visible : string

Default visibility flag association path or expression

Default visiblity set to a control but value can be overriden by script, client state, or control-specific mechanism such as setListColumn in a table.

where : string

Logical expression that the items must satisfy. If quasiquoted, it is expanded on the client every time the model is (re-)loaded.

Special local variable this (=controller) is provided by the framework for the function

Example

Constant where expression:
(= (@ firstName) "Joe")

Function returning where clause:
`(generate-where-clause this "EntityId")

In a library:
(define (generate-where-clause controller var)
...
)

Content

• Sequence of:

  • t_LayoutRef_Layout [0..1]

Parents

• t_ScreenSwitch_Composite - A container that displays its child views in columns - within a switch in a portlet or dialog.

• g_ScreenView_Composite - A container that displays its child views in columns - within tabs in a portlet or dialog.

• t_ScreenTabs_CaptionLayout - CaptionLayout descripton - portlet tabs

• t_ScreenLayout_Composite - A container that displays its child views in columns - within a composite in a portlet or dialog.

• t_ScreenLayout_CaptionLayout

• t_FormTabs_CaptionLayout

• t_Screen_Composite - A container that displays its child views in columns - in the root of a portlet or dialog.

Parent topic: t_Screen_Composite