Type to start searching...

Form

Classic Presentation Forms contain user interface controls which display data for viewing, editing, and querying. (deprecated)

Description

A Form comprises a root layout in which may lie a collection of controls (buttons, labels, grids, etc.) and sub-layouts for those controls. Forms bind to business classes for querying, viewing, creating or editing their instances.

Form configurations include specifying a description, a caption, a menu and a toolbar. Forms also specify the Class to which they bind.

There are three types of forms:


* Detail Form
      displays the details of a single object for viewing and/or editing
* List Form
      displays a collection of objects, typically the return from a query
* Query Form
      used to perform a search, providing values for search parameters

Properties
annotation : string

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

caption : string

String indentifier for caption display in the UI.

class : string

The class to which the Form is bound.

context : string

A comma delimited list of context variable names to which the form subscribes when used as a portlet.

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.

controller : string

The Java class name that implements custom form controller.

description : string

Description of the Form.

event : string

A comma delimited list of event names to which the form subscribes when used as a portlet.

factory : string

Custom factory event name.

height : Dimension

Suggested height for the form. The dimensions may be specified in pixels or points. If unspecified, a default will be used.

Example


"400px" or "400pt"

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

The Form's main menu. Must refer to an existing menu in the Form's collection of Menus.

portlet : boolean

Mark the form as a portlet.

privilege : string

The privilege required to load the Form.

query : string

List of attributes to be included in the read query.

read : string

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

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

<class> is an optional class symbol. When omitted ActiveNode's 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

toolbar : string

The Form's main toolbar. Must refer to an existing menu in the Form's collection of Menus.

width : Dimension

Suggested width for the form. The dimensions may be specified in pixels or points. If unspecified, a default will be used.

Example


"400px" or "400pt"

Valid values based on“string”.
(\d{1,8})|(\d{1,8}px)|(\d{1,8}pt)|(\d{1,8}%)
Content
  • Sequence of:

    • Sequence of:

See
Screen