t_FormLayout_List

List : Composite : Layout

List control - within a composite in a layout.

Properties

annotation : stringa1 ... aN: empty annotation names; must differ from domain model attribute namesattributes : stringAdditional association paths to retrieveaugment : uiIdentifierA 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 : stringCaption text expressiondeletePrompt : stringDeletion confirmation prompt string id with class and instance name parameters, or space to skip the confirmation.enabled : stringEnablement flag association path or expressionevent : stringRow-selection eventfactory : stringNew item factory event: <class> <event>|<event>head : booleanTrue to start a new row in the layouticon : stringIcon name expressioniconCaption : stringIcon caption expressionitems : stringDisplayed 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 ClassNamelazy : booleanValid when child collection. Specifies whether a separate read request will be generatedmode : stringMode name from the picker definitionname : identifierUnique view nameValid 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 : unsignedIntNumber of columns to skip from the previous view in the same roworder : stringItem 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 : identifierAccess privilegeValid 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 : stringCustom 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 :xlockref : stringPicker (.picker) definition nameshowGroupCounts : booleanTrue if the List should show the group size in the headersort : ComboSortTypeSet to "server" to perform sort on the server, "client" to perform sort on the client when order expression is not supported by the data sourceValid values based on“string”.clientThe model will be sorted on the client.serverThe model will be sorted on the server.span : intNumber of consecutive columns to occupyvalues : identifierListAssociation path or expression to the value returned from the items in the collectionIf 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.viewAll : stringName of the UI event to fire when the View All button is clickedvisible : stringDefault 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 : stringLogical 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

Parent topic: t_Controllable_Composite

Parent topic: t_Table_CaptionLayout

Parent topic: t_FormLayout_CaptionLayout

Parent topic: t_FormLayout_Composite

Parent topic: t_List_CaptionLayout