Type to start searching...

Table

Properties
annotation : string

a1 ... aN: empty annotation names; must differ from domain model attribute names

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

deletePrompt : string

Deletion confirmation prompt string id with class and instance name parameters, or space to skip the confirmation.

enabled : string

Enablement flag association path or expression

factory : string

New item factory event: <class> <event>|<event>

icon : string

Icon name expression

lazy : boolean

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

maxSelections : integer

Maximum number of selections allowed by multiselect UI. Framework default if not set.

mode : string

Mode name from the picker definition

multiplier : integer

Page sizes multiplier (default: pageSizeMultiplier environment property). For a multiplier of 1, the default page size set would be 5, 10, 20.

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

permanent : integer

Number of initial columns that should be displayed always.

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.
reader : string

Custom read event. [<class>]'<event> <arg1> ... <argN>

Specification: [<class>]'<event> <arg1> ... <argN>

<class> is an optional class symbol. When omitted, the items collection class is used. <event> is a read event symbol. <arg#> is an event argument value which can be either a constant or a scheme expression evaluating to a constant at run-time on the client, using special local variables provided by the framework: this (=controller), :node (=active node), :attributes, :where, :orderBy, :count, :offset, :xlock, or a UI initializer variable.

If arguments are not specified, a default list is supplied by the framework: :attributes :where :orderBy :count :offset :xlock

Examples:

a) Generate a request to 'readList event with default arguments: readList

b) Generate request to readList event with attributes, and orderBy argument values supplied by the framework. readList :attributes :orderBy

c) Generate request to Contact'readDetail with attributes supplied by the framework, and the contact argument calculated using (current-contact) client library function. Contact'readDetail :attributes (current-contact this :node)

In a library: (define (current-contact controller node) ... )

d) Generate request to 'read event with a constant attribute list: read '(lastName firstName) :where :orderBy :count :offset :xlock

ref : string

Picker (.picker) definition name

rows : 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 Form items (@@ ClassName) - instances of the class specified by ClassName
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.
switch : string

Association path to allow switching of grid columns based on the selected filter.

Valid if a filter view (i.e. layoutRef with query="true") is referenced in the current portlet. The standard pattern is to set the case property to "filter searchContext value" which is a path from the filter object to the currently selected filter subject.

Each column's case property is then used to match against the current subject and show or hide the column accordingly.

values : identifierList

Association path or expression to the value returned from the items in the collection

If blank, the value will be the object itself - not an attribute on the object.

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

It is called values (plural) because it returns the values(s) from the collection's item(s).

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

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
Parents
  • Picker - Picker elements provide a consistent user experience for selecting objects.
Parent topic: Picker