Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
AddSubMenu

AddSubMenu Class Reference

Constructors

Instance Methods

Constructors

new AddSubMenu(parameters)

Initalizes an instance of AddSubMenu.

Instance Methods

addSubMenu.getMenuID() ⇒ Number

Get the MenuID

Kind: Instance method of AddSubMenu
Returns: Number - the KEY_MENU_ID value

addSubMenu.getMenuIcon() ⇒ Image

Get the MenuIcon

Kind: Instance method of AddSubMenu
Returns: Image - the KEY_MENU_ICON value

addSubMenu.getMenuLayout() ⇒ MenuLayout

Get the MenuLayout

Kind: Instance method of AddSubMenu
Returns: MenuLayout - the KEY_MENU_LAYOUT value

addSubMenu.getMenuName() ⇒ String

Get the MenuName

Kind: Instance method of AddSubMenu
Returns: String - the KEY_MENU_NAME value

addSubMenu.getPosition() ⇒ Number

Get the Position

Kind: Instance method of AddSubMenu
Returns: Number - the KEY_POSITION value

addSubMenu.setMenuID(id) ⇒ AddSubMenu

Set the MenuID

Kind: Instance method of AddSubMenu
Returns: AddSubMenu - The class instance for method chaining.

ParamTypeDescription
id Number unique ID of the sub menu to add. - The desired MenuID.

addSubMenu.setMenuIcon(icon) ⇒ AddSubMenu

Set the MenuIcon

Kind: Instance method of AddSubMenu
Returns: AddSubMenu - The class instance for method chaining.

ParamTypeDescription
icon Image The image field for AddSubMenu - The desired MenuIcon.

addSubMenu.setMenuLayout(layout) ⇒ AddSubMenu

Set the MenuLayout

Kind: Instance method of AddSubMenu
Returns: AddSubMenu - The class instance for method chaining.

ParamTypeDescription
layout MenuLayout Sets the layout of the submenu screen. - The desired MenuLayout.

addSubMenu.setMenuName(name) ⇒ AddSubMenu

Set the MenuName

Kind: Instance method of AddSubMenu
Returns: AddSubMenu - The class instance for method chaining.

ParamTypeDescription
name String Text to show in the menu for this sub menu. - The desired MenuName.

addSubMenu.setPosition(position) ⇒ AddSubMenu

Set the Position

Kind: Instance method of AddSubMenu
Returns: AddSubMenu - The class instance for method chaining.

ParamTypeDescription
position Number Position within the items that are are at top level of the in application menu. 0 will - The desired Position. insert at the front. 1 will insert at the second position. If position is greater or equal than the number of items on top level, the sub menu will be appended to the end. Position of any submenu will always be located before the return and exit options If this param was omitted the entry will be added at the end.
View on GitHub.com
Previous Section Next Section