Type to start searching...

Label : UI Control

Properties
accessForCtrl : string

The name of the control this label is associated with.

Setting this is important for accessibility because it allows form elements to be associated with the label that describes them. All labels on edit pages should have this set.
autolink : boolean

Specifies if the framework should detect URLs and emails and create hyperlinks for them. This attribute will be ignored if an event is associated to this label.

bgImage : string

Background image of the Label.

caption : string

String indentifier for caption display in the UI.

collection : string

If blank, the Label is static or bound to an instance. Otherwise, the Label will be displaying a list of values from the collection specified here.

An expression that specifies that a collection model must be set on the control.
Example


(@) - all instances of the associated class for Forms and form controls.
(@@ ClassName) - all instances of the class specified by ClassName
(ControlName1 assoc1 ... assocN) ... (ControlNameM assoc1 ... assocX) - all instances filtered by the parent instances.
(@ assoc1 ... assocN) - variant of above example. All instances relative to the Form model.

collectionAnnotation : string

Space separated list of annotations which do not exist in the Domain Model.

collectionCaption : identifierList

Caption bind for data-driven Label. Must be an attribute of the Label's collection.

Valid values based on“token”.
(:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*\s+)*(:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*)?

Each element in the list must begin with a letter or underscore. Elements are space delimited.

collectionContextValue : string

The attribute, association path, or a constant specifying context value from a collection. For context bus adapter.

See
Application'contextImplementation
collectionLazy : boolean

Load the collection on display, not when the screen is loaded.

If true, the query for the dynamic combo will only be executed when the combo is displayed. Otherwise, the combo will be loaded when the screen is loaded.
collectionOrderBy : string

Optional order by clause to be added to the Label collection query: ((attr1 . asc1) ... (attrN . ascN)).

List of attributes or attribute and boolean pairs to indicate ascending (true) or descending (false).
Example


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

collectionQuery : string

List of additional attributes to include in collection read query.

collectionSeparator : string

String indentifier of list separator symbol.

collectionTooltip : string

The attribute, association path, or a constant specifying tooltip for each collection item.

collectionWhere : string

Optional clause to be added to collection model query.

context : string

The attribute, association path, or a constant specifying context indentifier to be set. For context bus adapter.

See
Application'contextImplementation
contextValue : string

The attribute, association path, or a constant specifying context value. For context bus adapter.

See
Application'contextImplementation
control : identifier

The control type this should be rendered with.

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.

edit : string

Boolean property specifying whether the insert, delete, or edit operations are allowed in the column.

editMode : FormEditType

Whether the control is used for querying, or editing.

Valid values based on“string”.
edit

Marks the form as edit only.

query

Marks the form as query only.

enabled : string

The attribute, association path, or a constant returning boolean to set enablement.

error : string

Expression returning non-#f if the message should be treated as an error. The raw message is passed as "this".

event : identifier

UIEvent attached to this control. UIEvents are handled by UIActions.

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.

exclusive : boolean

If true lack of selection means disabling children collection query. Otherwise, children query is generated.

format : string

Format string to be used for parsing and formatting the raw value.

Either a pre-defined format, such as longTimestamp, percent, shortBoolean, shortCurrency... or a java format string appropriate to the data type being formatted.
Example


For a double you could use "#,##0.0#".  See http://java.sun.com/j2se/1.4.2/docs/api/java/text/DecimalFormat.html
for an example of numeric formatting.  Exmaples for date and other formatting can be found in related pages.

hiddenObjectCaption : string

The attribute, association path, or a string constant to display when the value is an object that is hidden from the user.

icon : string

Icon provides a means of recognition of the Label.

lines : int

Number of lines the Label holds. Must be an Integer.

maxWidth : Dimension

The maximum width to which the label can expand. Only pixels unit is supported. Value of 0 denotes no maximum width, and does not allow for ellipses.

Valid values based on“string”.
(\d{1,8})|(\d{1,8}px)|(\d{1,8}pt)|(\d{1,8}%)
menu : identifier

The menu associated with the Label.

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.

name : uiIdentifier

Uniquely identifies the Label.

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.

nullCaption : string

Text caption to display in the label when the value is null.

popupTooltip : identifier

The name of screen appearing as popup tooltip.

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.

popupTooltipJustification : RelativeJustification

The popup tooltip justification relative to its anchor. One of "before", or "after".

Valid values based on“string”.
before
after
popupTooltipPosition : RelativePosition

The position of the popup tooltip relative to its anchor. One of "above", "below", "left", or "right.

Valid values based on“string”.
above
below
left
right
popupTooltipStyle : PopupTooltipStyle

The popup tooltip appearance style. One of "clean", or "callout".

Valid values based on“string”.
clean
callout
popupTooltipValue : string

The attribute or an association path to the instance to appear in the popup tooltip. Can be empty.

query : string

List of additional attributes to include in read query.

style : string

Style of the Label background.

tabIndex : long

The index number of the tabbable control. Must be a long integer.

tabStop : boolean

Specifies if tabbing should stop on the tabbable control

textAlign : Alignment

Horizontal alignment of the Label text.

Example


"left", "right", "center"

Valid values based on“string”.
right
center
left
textVAlign : VAlignment

Vertical alignment of the Label text.

Example


"top", "bottom", "middle"

Valid values based on“string”.
top
middle
bottom
tooltip : string

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

unit : string

Display unit bind. Attribute name, or constant.

url : string

TODO: comment attribute url

value : identifierList

The value of the Label.

Valid values based on“token”.
(:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*\s+)*(:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*)?

Each element in the list must begin with a letter or underscore. Elements are space delimited.

visible : string

The attribute, association path, or a constant returning boolean to set visibility.

wrap : boolean

Specifies if the Label should wrap text.

Parents