MenuElement
A menu elements
Superclass of MenuItem, MenuSeparator, and Submenu
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| index | number | readonly | The index of the MenuElement within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| parent | MenuSubmenu | readonly | The parent of the MenuElement (a Menu or Submenu). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
Array
of MenuElement getElements ()
Resolves the object specifier, creating an array of object references.
void remove ()
Deletes the MenuElement.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the MenuElement.
Used in:
MenuElement MenuElements.nextItem (obj: MenuElement)
MenuElement MenuElements.previousItem (obj: MenuElement)
MenuItem MenuItems.add (associatedMenuAction: MenuAction[, at: LocationOptions=LocationOptions.AT_END][, reference: MenuElement][, withProperties: Object])
MenuSeparator MenuSeparators.add ([at: LocationOptions=LocationOptions.AT_END][, reference: MenuElement][, withProperties: Object])
Submenu Submenus.add (title: string[, at: LocationOptions=LocationOptions.AT_END][, reference: MenuElement][, withProperties: Object])
Return
Array of MenuElement MenuElement.getElements ()
MenuElement MenuElements.[] (index: number)
MenuElement MenuElements.anyItem ()
Array of MenuElement MenuElements.everyItem ()
MenuElement MenuElements.firstItem ()
MenuElement MenuElements.item (index: varies)
Array of MenuElement MenuElements.itemByRange (from: varies, to: varies)
MenuElement MenuElements.lastItem ()
MenuElement MenuElements.middleItem ()
MenuElement MenuElements.nextItem (obj: MenuElement)
MenuElement MenuElements.previousItem (obj: MenuElement)
| Jongware, 29-Apr-2012 v3.0.3i | Contents :: Index |