Type to start searching...

Label : Composite : Layout

Label control - within a composite in a layout.

Properties
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 association path, expression or string/string ID escaped in quotes.

Expression syntax (lambda (a1 ... aM) ...) <assoc1> ... <assocM>, where assoc# is association specification, such as (@ attr), (@ attr1 .. attrN), <attribute symbol>.
Example


(lambda (fn ln) (string-affix fn " " ln)) (@ firstName) (@ lastName)

Alternative syntax, which might be more convenient in some cases: `<expr>, with unquoting for associations.
`(string-affix ,(@ firstName) " " ,(@ lastName))

Fixed caption using a string ID: "ids.opportunities.hasLead"

captions : string

Association path or expression to the caption of the items in the collection

Note that this property isn't a list of values. It is simply the association path, or expression, to the caption of the items.

It is called captions (plural) because it retrieves the caption(s) from the collection's item(s).

code : string

Association path, or expression providing color code

When color code is a string, or an integer which is used to generate an appropriate class name.
Example


"error" - applies "-error" css class
1 - applies "-color1" css class

converter : uiIdentifier

Converter name. If not specified, value type name is used to generate 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.

crop : boolean

True to crop icons

enabled : string

Enablement flag association path or expression

event : identifier

Name of the UI event to fire when the view is clicked

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.

head : boolean

True to start a new row in the layout

icon : string

Icon name association path, or expression

icons : string

Association list of association paths or constants to the icon properties of the items in the collection

Association list of association paths or constants: (image|data|type|icon|default|lock . <a1> ... <an>|"<const>")

Note that this isn't a list of values. It is simply the association path, or expression, to the icon of the items.

It is called icons (plural) because it retrieves the icon(s) from the collection's item(s).

Example


Configuring data table avatar for Entity.meta

<Table>
   <Column ... icons="(image . image)(data . mimeData)(type . mimeType)(icon . icon)(default . &quot;icon:person&quot;)(lock . locking)" .../>
   ...
</Table>

image - The name of the attribute that contains the image (usually of type Obj) from the current instance. The attribute name doesn't need to be called "image", but often is.
data - Obj'mimeData attribute of type binary returning the image data. Always mimeData if the image attribute is of type Obj.
type - Obj'mimeType attribute of type string returning mime type of the image data. Always mimeType if the image attribute is of type Obj.
icon - optional. The name of an attribute of type string returning an icon name if the image is null
default - optional. "icon:person" - A constant expression to fall back on if both image and icon are null
lock - optional. The name of the attribute returning the optimistic locking value. Always locking if the image attribute is of type Obj.

items : string

Displayed collection of items: (<view1> <a11> ... <a1N>) ... (<viewN> <aN1> ... <aNM>)|(@ <a1> ... <aN>)|(@@ <class>)


<empty> - the same as (@) in Forms; no data in other situations
(ViewName1 assoc1 ... assocN) ... (ViewNameM assoc1 ... assocX) - collection relative to the items of the specified views; constrained by all the association paths
(@ assoc1 ... assocN) - collection relative to the Layout's model items
(@@ ClassName) - instances of the class specified by ClassName

length : integer

For collection labels, maximum number of characters to display

multiline : boolean

True to display multiple lines, false to truncate the text as needed.

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))

pattern : string

Converter pattern

Examples include


date.m.f
currency.s
shortCurrency
percent
quantity
priceCurrency
shortDate
{0;choice;0||1|{$};*}  - this syntax allows for different treatment of plurals
{@$.fullName;link;;@i}
time.m
datetime.m.f
{@$.fullName;string;}
integer
shortTimestamp
ids.conversationsTo
#,##0.##
date.l.f
longDate
{@$.userPerson.fullName;string;}
internationalPhone

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.

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

style : string

Additional style name

Example


"-heading" - header text style constant,

tooltip : string

The attribute, association path, or a constant specifying tooltip.

tooltips : string

The attribute, association path, or a constant specifying tooltips.

unit : string

Converter unit association path or expression

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.
Parents
  • CaptionLayout
  • Composite - A container that displays its child views in columns - within a tab in a layout.
  • Composite - A container that displays its child views in columns - within a switch in a layout.
  • CaptionLayout
  • Composite - A container that displays its child views in columns - within a composite in a layout.
  • CaptionLayout - Caption Layout - within a composite in a layout.
  • Composite - A container that displays its child views in columns - in the root of a layout.