JSMenuItem
Last updated
Last updated
The JSMenuItem scripting wrapper provides functionality for managing menu items in a Servoy application. It supports configuration and interaction through constants, properties, and methods, enabling dynamic customization of menu behavior and appearance. ## Functionality
Constants such as ENABLED and VIEWABLE control security flags, determining whether menu items are accessible or visible. Properties like callbackArguments, enabled, iconStyleClass, itemID, menuText, styleClass, and tooltipText allow precise customization of menu item attributes, including visual styling, text, and state.
The functionality includes methods to manage menu items dynamically. Developers can add new items using methods like addSubMenuItem, which supports specifying positions, or retrieve existing items through methods such as getSubMenuItem and getSubMenuItemAt. Items can also be removed using the removeSubMenuItem method.
Security and visibility features allow control over menu item behavior. The setSecurityFlags method, combined with constants like ENABLED and VIEWABLE, provides flexibility to set whether a menu item is visible and interactive. Additional methods, such as getEnabledWithSecurity and getSubMenuItemsWithSecurity, refine the interaction by considering security constraints.
Properties and additional functionality extend to retrieving extra information, such as through the getExtraProperty method, and updating the menu item’s appearance and behavior dynamically. These capabilities make JSMenuItem a versatile tool for creating adaptive and secure menu systems in Servoy applications.
MenuItem section of this documentation
| Type | Name | Summary |
|---|---|---|
| Type | Name | Summary |
|---|---|---|
Constant representing the enabled flag for menu item security.
Type Number
Sample
Constant representing the viewable flag for menu item seurity.
Type Number
Sample
Set/Get the menu item callback arguments (for components that support this)
Type Array
Sample
Set/Get the menu item enabled state
Type Boolean
Sample
Set/Get the menu item space separated icon style classes
Type String
Sample
The menu name (identifier)
Type String the name (identifier) of the menu item
Set/Get the menu item text
Type String
Sample
Set/Get the menu item space separated style classes
Type String
Sample
Set/Get the menu item tooltip text
Type String
Sample
Adds a new menu item, as last item in the list.
Parameters
String id the menu item identifier
Returns: JSMenuItem
Sample
Adds a new menu item, at a specific position.
Parameters
Returns: JSMenuItem
Sample
Returns: Boolean
Returns an extra property value.
Parameters
Returns: Object extra property value
Sample
Gets a child menu item by identifier. Returns null if not found.
Parameters
String id the menu item identifier
Returns: JSMenuItem
Sample
Gets a child menu item at index (0 based). Returns null if not found.
Parameters
Number index the menu item index among its sibblings
Returns: JSMenuItem
Sample
Returns all the child menus items, either created at design time or at runtime, in the order they will show up in user interface.
Returns: Array
Sample
Returns: Array
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
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
Override the permission data and design data (for enabled flag) and set if a menu item is viewable(visible) and enabled.
Parameters
Number flags either 0 or a combination of JSMenuItem.VIEWABLE and JSMenuItem.ENABLED
Returns: void
Sample
| Type | Name | Summary |
|---|---|---|
Constant representing the enabled flag for menu item security.
Constant representing the viewable flag for menu item seurity.
Set/Get the menu item callback arguments (for components that support this)
Set/Get the menu item enabled state
Set/Get the menu item space separated icon style classes
The menu name (identifier)
Set/Get the menu item text
Set/Get the menu item space separated style classes
Set/Get the menu item tooltip text
Adds a new menu item, as last item in the list.
Adds a new menu item, at a specific position.
Returns an extra property value.
Gets a child menu item by identifier.
Gets a child menu item at index (0 based).
Returns all the child 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
void
Override the permission data and design data (for enabled flag) and set if a menu item is viewable(visible) and enabled.