A new nav item to be added into this nav menu.
Returns true if the given item is added into this nav menu. Otherwise, returns false.
To check that the given item is in this nav menu or not.
A nav item to check that it is in this nav menu or not.
Returns true if the given item is in this nav menu.
Get an active nav item index of this nav menu.
Returns -1 if there is no current active item. Otherwise, return the array index of current
active item.
Get an active nav item of this nav menu.
Returns null if there is no current active item.
Get a nav item ([[AbstractNavItem]]) from the given index (idx).
The index of nav item to get.
Returns an instance of nav item ([[AbstractNavItem]]) at the specified index (idx).
Returns null if the given index is out of range.
Get a nav item ([[AbstractNavItem]]) by the given name.
The name of a nav item to get.
Returns an instance of nav item ([[AbstractNavItem]]) with the given name.
Returns null if not found.
Get nav items count in this nav menu.
Get the index of the given nav item (item).
The nav item to find index.
Returns an index of the specified item. Returns -1 if not found.
Get the index of the given item name.
The item name to find index.
Returns an index of nav item having the specified name. Returns -1 if not found.
Get nav items ([[AbstractNavItem]]) of this nav menu.
Get [[ObservableManager]]'s sub topic name associated with this nav menu.
Navigate this nav menu to the specified nav item. This method returns Promise to support
asynchronous execution. The result value of returned Promise is a boolean indicating the navigation result.
The result value must be true if the navigation is successful. Otherwise, for example, if the given item
does not exist, the result value will be false.
The nav item to navigate to.
Returns a Promise which will be resolved when the navigation is done. The Promise's result will be a
boolean value which its value will be true if the navigation is successful.
Navigate this nav menu to the specified index (idx). This method returns Promise to support
asynchronous execution. The result value of returned Promise is a boolean indicating the navigation result.
The result value must be true if the navigation is successful. Otherwise, the result value will be false.
The item index to navigate to.
Returns a Promise which will be resolved when the navigation is done. The Promise's result will be a
boolean value which its value will be true if the navigation is successful.
Navigate this nav menu to a nav item having the specified name. This method returns
Promise to support asynchronous execution. The result value of returned Promise is a boolean indicating
the navigation result. The result value must be true if the navigation is successful. Otherwise, for example, if the given item
does not exist, the result value will be false.
The name of a nav item to navigate to.
Returns a Promise which will be resolved when the navigation is done. The Promise's result will be a
boolean value which its value will be true if the navigation is successful.
Remove the given item from this nav menu. If the given item is not in this nav menu, this method
will do nothing and return false. If the item being removed is a current active item, this nav menu will be navigated
to the first nav item.
A nav item to be removed from this nav menu.
Returns true if the given item is found and removed from this nav menu. Otherwise, returns false.
Reset this nav menu. This method simply navigates back to the item at index 0.
Set nav items of this nav menu.
Get the navigation cmd topic name with the given subTopicName. The returning topic name will be prefixed by
NAVIGATE_CMD_TOPIC_NAME.
Get the navigation event topic name with the given subTopicName. The returning topic name will be prefixed by
NAVIGATE_TOPIC_NAME.
Generated using TypeDoc
Add a new
nav iteminto thisnav menu. If there already is the givenitemin thisnav menu, this method will do nothing and returnfalse.