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

Type	Name	Summary
String	name	The menu name (identifier)
String	styleClass	Set/Get the menu space separated styleclases

Methods Summarized

Type	Name	Summary
JSMenuItem	addMenuItem(id)	Adds a new menu item, as last item in the list.
JSMenuItem	addMenuItem(id, index)	Adds a new menu item, at a specific position.
JSMenuItem	findMenuItem(id)	Gets a menu item by identifier.
JSMenuItem	getMenuItem(id)	Gets a menu item by identifier.
JSMenuItem	getMenuItemAt(index)	Gets a menu item by index (0 based).
Array	getMenuItems()	Returns all the menus items, either created at design time or at runtime, in the order they will show up in user interface.
Array	getMenuItemsWithSecurity()
JSMenuItem	getSelectedItem()
Boolean	removeMenuItem(menuItem)	Removes a menu item from children's list, returns true if element was found an removed
Boolean	removeMenuItem(id)	Removes a menu item with given id, returns true if element was found an removed
void	selectMenuItem(menuItem)	Selects a menu item in user interface

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 The space-separated style classes applied to the menu.

Sample

menu.styleClass = 'myclass';

Methods Detailed

addMenuItem(id)

Adds a new menu item, as last item in the list.

Parameters

• String id the menu item identifier

Returns: JSMenuItem The newly added menu item.

Sample

var item = menu.addMenuItem('item1');

addMenuItem(id, index)

Adds a new menu item, at a specific position.

Parameters

• String id the menu item identifier

• Number index the index position in list (0 based)

Returns: JSMenuItem The newly added menu item at the specified index.

Sample

var mnu = menu.addMenuItem('item1',0);

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 The menu item with the specified identifier, including nested items, or null if not found.

Sample

var mnu = menu.findMenuItem('item1');

getMenuItem(id)

Gets a menu item by identifier. Returns null if not found.

Parameters

• String id the menu item identifier

Returns: JSMenuItem The menu item with the specified identifier, or null if not found.

Sample

var mnu = menu.getMenuItem('item1');

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 The menu item at the specified index, or null if the index is out of bounds.

Sample

var mnu = menu.getMenuItemAt(0);

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 An array of all menu items in this menu, in the order they appear in the user interface.

Sample

var items = menu.getMenuItems();

getMenuItemsWithSecurity()

Returns: Array An array of menu items that have the security flag set to "viewable."

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 True if the specified menu item was removed; false otherwise.

Sample

var success = menu.removeMenuItem(item);

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 True if a menu item with the specified identifier was removed; false otherwise.

Sample

var success = menu.removeMenuItem('item1');

selectMenuItem(menuItem)

Selects a menu item in user interface

Parameters

• JSMenuItem menuItem the menu item to be selected

Returns: void

Sample

menu.selectMenuItem(item);

---