MenuItem¶
Definition¶
Extends¶
Extended By¶
None
Description¶
A custom menu item. Can implement AmiScript and take on the following modes: enabled, disabled, invisible, and divider.
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| DashboardResource | getCallback(callbackName) | Callback | Returns a callback by name |
| DashboardResource | getCallbacks() | Map | Returns a map of all callback definitions. |
| DashboardResource | getChildren() | List | Returns a list of the child dashboard resources. |
| Object | getClassName() | String | Returns the string name of this object's class type. |
| DashboardResource | getDRI() | String | Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of this resources within the entire dashboard. |
| DashboardResource | getDashboardResourceType() | String | Returns the Dashboard Resource Type as a string |
| DashboardResource | getFormula(formulaName) | Formula | Returns a Formula given the formula name. |
| DashboardResource | getFormulaNames() | Set | Returns a set of the names of all formulas for this object. |
| DashboardResource | getFormulas() | Map | Returns a map of all available formulas for this object. The key is the formula name. |
| MenuItem | getId() | String | Returns the id of the menu. |
| DashboardResource | getLRI() | String | Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element. |
| DashboardResource | getOwner() | DashboardResource | Returns the DashboardResource that owns this object. |
| MenuItem | getPanel() | Panel | Returns the underlying panel.. |
| MenuItem | getParentMenuItem() | MenuItem | Returns the parent menu item, or null if this is the root. |
| MenuItem | getSubMenuItems() | List | Returns a list of child menu items. |
| DashboardResource | invokeCallback(callbackName, args) | Object | Executes the specified callback definition and returns the result from the callback. |
| DashboardResource | isTransient() | Boolean | Returns true if this is transient, false otherwise. Transient objects are not saved to the layout. |
| Object | toJson() | String | Returns a json representation of this object. |
Method Definitions¶
getId()¶
Description¶
Returns the id of the menu.
getPanel()¶
Description¶
Returns the underlying panel..
getParentMenuItem()¶
MenuItem MenuItem::getParentMenuItem()
Description¶
Returns the parent menu item, or null if this is the root.
getSubMenuItems()¶
List MenuItem::getSubMenuItems()
Description¶
Returns a list of child menu items.