Type to start searching...

Composite : Switch : Layout

A container that displays its child views in columns - within a switch in a layout.

Description

Composites don't have much structure of their own. They don't introduce any visual noise. Using fewer of them is a good idea for simplicity and to avoid generating extra markup as they do introduce a new div for each composite.

Composites, Tabs, and Switches are container views. They contain other views and may contain each other to any depth. e.g. Composite->Tabs or Tabs->Switch->Tabs

In Portlets and Dialogs, they are mainly used to organize Layouts. In Layouts, they are mainly used to organize Controls e.g. Charts, Tables, Cards, ...

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

case : string

A space separated list of metaclass names, primitive values or 'null' used to drive polymorphic display.

The case part of a polymorphic form switch. This is conceptually similar to a JAVA switch, but for UI. The value property of a parent Switch contains the expression that the cases are evaluated against. If this resolves to a non-primitive, the cases are compared against the non-primitive's class type. Note: The class, all subclasses, and the 'null' case should be handled. If it resolves to a primitive, the cases are compared directly with the value. Note: All possible values and the 'null' case should be handled. That being said Enumerated values and booleans are most appropriate. All possible values must be covered by the cases - there is no 'else' case. Within the Switch the cases are checked from left to right. The first Layout to match will be the one to display.
Example


Non-primitive case: The parent Switch value property is set to EntityList.  This is
a View Path to the the EntityList form.  There are three child Layouts with cases of
1. null 2. Person UserPerson 3. Company.  The currently selected instance in the model of
the EntityList form will determine which Layout will display.  If an instance of Company
is selected in the EntityList then Layout 3 displays.
Primitive case: The parent Switch value property is set to EntityList isPerson.
This is a View Path to the EntityList form and an Association Path to the isPerson attribute.
There again are three child Layouts with cases of 1. null 2. #t 3. #f.  As
we move through the EntityList the Layouts will dynamically display based on the values in case.

cols : integer

Number of columns in the layout

enabled : string

Enablement flag association path or expression

fluid : boolean

True to enable special view positioning for space minimization

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.

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.

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.
Content
  • Sequence of:

    • CaptionLayout [0..1] - Caption Layout - within a composite in a layout.

    • Choice of:

      • Composite [1..1] - A container that displays its child views in columns - within a composite in a layout.

      • Table [1..1] - Table control - within a composite in a layout.

      • Chart [1..1] - Chart control - within a composite in a layout.

      • List [1..1] - List control - within a composite in a layout.

      • Picker [1..1] - A Picker control is essentially an enhanced combo box that provides type-ahead selection and a picker dialog as defined in a .picker file that returns a single value.

      • Multipicker [1..1] - A Multipicker control allows you to pick many items.

      • File [1..1] - File control - within a composite in a layout.

      • Multifile [1..1] - Multifile control - within a composite in a layout.

      • Date [1..1] - Date control - within a composite in a layout.

      • Combo [1..1] - Combo control - within a composite in a layout.

      • Radio [1..1] - Radio control - within a composite in a layout.

      • Toolbar [1..1] - Toolbar control - within a composite in a layout.

      • Range [1..1] - Range control - within a composite in a layout.

      • Label [1..1] - Label control - within a composite in a layout.

      • Entry [1..1] - Entry control - within a composite in a layout.

      • Field [1..1] - Field control - within a composite in a layout.

      • Text [1..1] - Text control - within a composite in a layout.

      • RichText [1..1] - RichText control - within a composite in a layout.

      • Check [1..1] - Check control - within a composite in a layout.

      • Button [1..1] - Button control - within a composite in a layout.

      • Filter [1..1] - Filter control - within a composite in a layout.

      • Tabs [1..1] - A container that displays its child views in tabs - within a composite in a layout.

      • Switch [1..1] - A container that displays only one of its child views at a time - within a composite in a layout.

      • Tree [1..1] - Tree control - within a composite in a layout.

      • CustomView [1..1] - Custom View control - within a composite in a layout.

      • ScheduleLayout [1..1] - ScheduleLayout control - within a composite in a layout.

      • Image [1..1] - Image control - within a composite in a layout.

      • Browser [1..1] - Browser control - within a composite in a layout.

      • Attachment [1..1] - Attachment control - within a composite in a layout.

Example

xml
...
   <Composite name="tblRootLayout">
      <LayoutRef layout="mda:EntityHolder" head="true" name="EntityList"/>
      <LayoutRef association="EntityList customFields" caption="ids.CFGroup3" layout="mda:CustomFieldListGrouped" head="true" name="ref""/>
   </Composite>
</Portlet>

Parents
  • Switch - A container that displays only one of its child views at a time - within a composite in a layout.
  • Switch - A container that displays only one of its child views at a time - within tabs in a layout.
  • Switch - A container that displays only one of its child views at a time - within a switch in a layout.
  • Switch - A container that displays only one of its child views at a time - in the root of a layout.