JSMenu
Overview
JSMenu
is a wrapper for scripting menu objects, providing properties and methods to define and manage menus in a user interface.
The name property serves as the identifier for a menu, allowing for easy reference during scripting. The styleClass property enables the assignment of space-separated CSS style classes to customize the menu's appearance.
JSMenu offers a range of methods to interact with menu items. The addMenuItem(id)
and addMenuItem(id, index)
methods allow adding menu items either at the end of the list or at a specific position. Existing menu items can be retrieved using methods like findMenuItem(id)
, which searches for items by identifier, including nested ones, and getMenuItem(id)
or getMenuItemAt(index)
, which retrieve menu items based on identifier or index respectively. The getMenuItems()
method returns a list of all menu items in the order they appear in the interface.
Additional functionality includes removing menu items using removeMenuItem(menuItem)
or removeMenuItem(id)
, both of which return a Boolean indicating success. The selectMenuItem(menuItem)
method allows selecting a specific menu item in the user interface. For enhanced security considerations, the getMenuItemsWithSecurity()
method provides items with security metadata, and the getSelectedItem()
method retrieves the currently selected item.
For further information, refer to the menu section of this documentation.
Properties Summarized
Methods Summarized
Returns all the menus items, either created at design time or at runtime, in the order they will show up in user interface.
Removes a menu item from children's list, returns true if element was found an removed
Removes a menu item with given id, returns true if element was found an removed
Properties Detailed
name
The menu name (identifier)
Type String the name (identifier) of the menu
styleClass
Set/Get the menu space separated styleclases
Type String
Sample
Methods Detailed
addMenuItem(id)
Adds a new menu item, as last item in the list.
Parameters
String id the menu item identifier
Returns: JSMenuItem
Sample
addMenuItem(id, index)
Adds a new menu item, at a specific position.
Parameters
Returns: JSMenuItem
Sample
findMenuItem(id)
Gets a menu item by identifier. Also searches for nested elements. Returns null if not found.
Parameters
String id the menu item identifier
Returns: JSMenuItem
Sample
getMenuItem(id)
Gets a menu item by identifier. Returns null if not found.
Parameters
String id the menu item identifier
Returns: JSMenuItem
Sample
getMenuItemAt(index)
Gets a menu item by index (0 based). Returns null if not found.
Parameters
Number index the menu item index among its sibblings
Returns: JSMenuItem
Sample
getMenuItems()
Returns all the menus items, either created at design time or at runtime, in the order they will show up in user interface.
Returns: Array
Sample
getMenuItemsWithSecurity()
Returns: Array
getSelectedItem()
Returns: JSMenuItem the selectedItem
removeMenuItem(menuItem)
Removes a menu item from children's list, returns true if element was found an removed
Parameters
JSMenuItem menuItem the menu item to be removed
Returns: Boolean
Sample
removeMenuItem(id)
Removes a menu item with given id, returns true if element was found an removed
Parameters
String id the menu item identifier
Returns: Boolean
Sample
selectMenuItem(menuItem)
Selects a menu item in user interface
Parameters
JSMenuItem menuItem the menu item to be selected
Returns: void
Sample
Last updated