One item in the Kademi admin menu, contributed by an app through a menu element in its controllers.xml. Each item names its parent menu, the link text and target path, its ordering among siblings, and optionally the roles a user must hold before the item is shown. Items with no roles are visible to anyone who can reach the menu.
Group: App Definitions
Implements: Serializable, IMenuMapping
Properties
| Property | Returns | Description |
|---|---|---|
| css | String | CSS classes applied to the menu item, normally used to give it an icon. |
| id | String | Unique identifier for this menu item, used as the key when other items nest under it. |
| keywords | String | Extra comma separated terms the admin menu's filter box matches this item on, beyond its label. Useful for a page that is the way in to something whose own name does not appear in the label. |
| ordering | int | Sort position of this item among its siblings, with lower values appearing first. |
| parentId | String | Identifier of the menu this item is nested under, which is what places it in the admin menu tree. |
| path | String | Path the menu item links to, relative to the admin console root. |
| roles | Set<String> | Roles a user must hold for this menu item to be shown. |
| text | String | Label shown for this item in the admin menu. |
| type | String | Type marker for the item, used to distinguish special menu entries from ordinary links. |
Methods
getParentId() · getId() · getText() · getPath() · getOrdering() · getCss() · getType() · getKeywords() · getRoles()
getParentId()
Returns: String
Identifier of the menu this item is nested under, which is what places it in the admin menu tree.
getId()
Returns: String
Unique identifier for this menu item, used as the key when other items nest under it.
getText()
Returns: String
Label shown for this item in the admin menu.
getPath()
Returns: String
Path the menu item links to, relative to the admin console root.
getOrdering()
Returns: int
Sort position of this item among its siblings, with lower values appearing first.
getCss()
Returns: String
CSS classes applied to the menu item, normally used to give it an icon.
getType()
Returns: String
Type marker for the item, used to distinguish special menu entries from ordinary links.
getKeywords()
Returns: String
Extra comma separated terms the admin menu's filter box matches this item on, beyond its label. Useful for a page that is the way in to something whose own name does not appear in the label.
getRoles()
Returns: Set<String>
Roles a user must hold for this menu item to be shown.