Interface: Menu

Menu

Source:

Extends

Methods

find(id) → (nullable) {Item}

Retrieves a menu item via its id by depth-first search.
Parameters:
Name Type Description
id string The item id.
Source:
Returns:
The item if it exists.
Type
Item

generateMenu()

Generates the HTML element containing the menu entries.
Source:

getFocused() → {Item}

Returns the currently focused Item.
Source:
Returns:
The focused Item.
Type
Item

getItems() → {Array.<Item>}

Returns the items in that menu.
Source:
Returns:
The array of items.
Type
Array.<Item>

getPool() → {VariablePool.<(string|boolean)>}

Source:
Returns:
The variable pool associated to this menu.
Type
VariablePool.<(string|boolean)>

isPosted() → {boolean}

Inherited From:
Source:
Returns:
True if element is posted in the page.
Type
boolean

post()

Posts the element.
Overrides:
Source:

setFocused(item)

Sets the currently focused Item.
Parameters:
Name Type Description
item Item The new focused Item.
Source:

unpost()

Removes element from page.
Inherited From:
Source:

unpostSubmenus()

Unposts all submenus of this menu.
Source: