Reference > Classes

MenuItem¶

Definition¶

1	`MenuItem var = .... ;`

Extends¶

Extended By¶

None

Description¶

A custom menu item. Can implement AmiScript and takes one of 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 an object 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	getPosition()	Integer	Returns the position of this menu item
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.
MenuItem	isBold()	Boolean	Returns true if the menu item font is bold, false otherwise.
MenuItem	isItalic()	Boolean	Returns true if the menu item font is italic, false otherwise.
DashboardResource	isTransient()	Boolean	Returns true if this is transient, false otherwise. Transient objects are not saved to the layout.
MenuItem	isUnderline()	Boolean	Returns true if the menu item font is underlined, false otherwise.
MenuItem	setBold(isBold)	Boolean	Make the menu label font bold.
MenuItem	setItalic(isItalic)	Boolean	Make the menu label font italic.
MenuItem	setUnderline(isUnderline)	Boolean	Make the menu label font underlined.
Object	toJson()	String	Returns a string of a json representation of this object.

Method Definitions¶

getCallback(callbackName)¶

Callback DashboardResource::getCallback(String callbackName)

Description¶

Returns a callback by name

Parameter Definition¶

Name	Type	Description
callbackName	String	method name of callback

getCallbacks()¶

Map DashboardResource::getCallbacks()

Description¶

Returns a map of all callback definitions.

getChildren()¶

List DashboardResource::getChildren()

Description¶

Returns a list of the child dashboard resources.

getClassName()¶

String Object::getClassName()

Description¶

Returns the string name of this object's class type.

getDRI()¶

String DashboardResource::getDRI()

Description¶

Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of an object within the entire dashboard.

getDashboardResourceType()¶

String DashboardResource::getDashboardResourceType()

Description¶

Returns the Dashboard Resource Type as a string

getFormula(formulaName)¶

Formula DashboardResource::getFormula(String formulaName)

Description¶

Returns a Formula given the formula name.

Parameter Definition¶

Name	Type	Description
formulaName	String	name of the formula to return

getFormulaNames()¶

Set DashboardResource::getFormulaNames()

Description¶

Returns a set of the names of all formulas for this object.

getFormulas()¶

Map DashboardResource::getFormulas()

Description¶

Returns a map of all available formulas for this object. The key is the formula name.

getId()¶

String MenuItem::getId()

Description¶

Returns the ID of the menu.

getLRI()¶

String DashboardResource::getLRI()

Description¶

Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element.

getOwner()¶

DashboardResource DashboardResource::getOwner()

Description¶

Returns the DashboardResource that owns this object.

getPanel()¶

Panel MenuItem::getPanel()

Description¶

Returns the underlying Panel.

getParentMenuItem()¶

MenuItem MenuItem::getParentMenuItem()

Description¶

Returns the parent menu item or null if this is the root.

getPosition()¶

Integer MenuItem::getPosition()

Description¶

Returns the position of this menu item

getSubMenuItems()¶

List MenuItem::getSubMenuItems()

Description¶

Returns a list of child menu items.

invokeCallback(callbackName,args)¶

Object DashboardResource::invokeCallback(String callbackName, Object ... args)

Description¶

Executes the specified callback definition and returns the result from the callback.

Parameter Definition¶

Name	Type	Description
callbackName	String	method name of callback
args	Object ...	arguments

isBold()¶

Boolean MenuItem::isBold()

Description¶

Returns true if the menu item font is bold, false otherwise.

isItalic()¶

Boolean MenuItem::isItalic()

Description¶

Returns true if the menu item font is italic, false otherwise.

isTransient()¶

Boolean DashboardResource::isTransient()

Description¶

Returns true if this is transient, false otherwise. Transient objects are not saved to the layout.

isUnderline()¶

Boolean MenuItem::isUnderline()

Description¶

Returns true if the menu item font is underlined, false otherwise.

setBold(isBold)¶

Boolean MenuItem::setBold(Boolean isBold)

Description¶

Make the menu label font bold.

Parameter Definition¶

Name	Type	Description
isBold	Boolean	Whether to make the menu item's font bold

setItalic(isItalic)¶

Boolean MenuItem::setItalic(Boolean isItalic)

Description¶

Make the menu label font italic.

Parameter Definition¶

Name	Type	Description
isItalic	Boolean	Whether to make the menu item's font italic

setUnderline(isUnderline)¶

Boolean MenuItem::setUnderline(Boolean isUnderline)

Description¶

Make the menu label font underlined.

Parameter Definition¶

Name	Type	Description
isUnderline	Boolean	Whether to make the menu item's font underlined

toJson()¶

String Object::toJson()

Description¶

Returns a string of a json representation of this object.