|
|
|
The Model-Driven System Builder
|
|
JeeWiz Architect's Guide
|
|
|
|
Contents >
15. 'Screen' Reference
|
|
|
15.11 MenuItem Object
| Used on |
|
| Description | This is a menu item - used in menus and menu tabs.
|
Contained
Lists |
| 1 |
| Name | childItems |
| Type | menuItem |
| Description | This is the children for the menu item. Although this was originally a String List of the names of menu items, this now contains the child menu items directly.
|
| GenerateAllList | false |
|
|
Inherited
properties |
| description |
(base property)
| |
| template |
(base property)
| |
| text |
(base property)
| |
| jwpattern |
(base property)
| |
|
15.11.1 Property 'name'
|
| Description | This is the name for the menu item. The name is used as the name of the component representingn the menu item, but
not necessarily its id. So
|
| Type | String |
15.11.2 Property 'label'
|
| Description | This is the label for the menu item. It should be what is displayed on the screen.
|
| Type | String |
15.11.3 Property 'title'
|
| Description | This is the title of the menu item. This will only be relevant in more unusual formats.
|
| Type | String |
15.11.4 Property 'outcome'
|
| Description | This is the outcome for the menu item. When the item is selected, it may pass an outcome value to an underlying method, or the outcome
might be used directly by the navigation configuration to decide on the next page.
|
| Type | String |
15.11.5 Property 'viewId'
|
| Description | This is the viewId for the menu item. In Trinidad, data models which extend MenuModel have the concept of a view identifier. This
is an identifier for a menu node. The current viewId is the identifier for the current node (if there is a current node). The other
two ways of identifying a node, the key and the index. The index is the position of a node in a flat (sub)tree, ie among its peers.
The key is global to the menu and is unique withing the menu. The viewId is returned, possibly dynamically, by the bean backing the
node, and is unique for each menu which contains a node using the bean. Confusingly the viewId is sometimes also the to-view
page identifier which will be the page that the application navigates to when selecting the menu item. This is an optional usage for
viewId and not an intrinsic requirement. We use the destination property.
|
| Type | String |
15.11.6 Property 'destination'
|
| Description | This is the destination for the menu item. What page the application will navigate to, although this might be overridden depending on the outcome
|
| Type | String |
15.11.7 Property 'icon'
|
| Description | This is the icon for the menu item. Displays an icon, next to or instead of the text id supported by the rendering
|
| Type | String |
15.11.8 Property 'type'
|
| Description | This is the type for the menu item. [I don't know what this is. What's a global versus local menu item? JH]
|
| Type | String |
| Default | global |
15.11.9 Property 'readOnly'
|
| Description | This is an indicator as to whether this item is selectable. It is unlikely that the value would be set to true globally in this way
and it is far more likely that dynamic menu handling would used.
|
| Type | boolean |
| Default | false |
15.11.10 Property 'shown'
|
| Description | This is an indicator as to whether this item is shown. As with readOnly, it is unlikely that the value would be set to false
globally in this way and it is far more likely that dynamic menu handling would used; however it might be used temporarily.
|
| Type | boolean |
| Default | true |
Copyright (c) 2001-2008 New Technology/enterprise Ltd.
| |
