Submenu

A submenu.

Methods:

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, MenuElements, MenuItems, MenuSeparators, Number, Object, String, Submenus

Hierarchy:

Superclass: MenuElement

Class: Submenu

Property Listing

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 Submenu within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

menuElements

MenuElements MenuElement

readonly

A collection of menu elements.

menuItems

MenuItems MenuItem

readonly

A collection of menu items.

menuSeparators

MenuSeparators MenuSeparator

readonly

A collection of menu separators.

name

String

readonly

The name of the Submenu.

parent

Menu

Submenu

readonly

The parent of the Submenu (a Menu or Submenu).

properties

Object

read/write

A property that allows setting of several properties at the same time.

submenus

Submenus Submenu

readonly

A collection of submenus.

title

String

readonly

The name of the Submenu for display in the user interface. The title includes any ampersand characters (&), which are used to tell the Windows OS to underline the following character in the name for use with the Alt key to navigate to a menu item. Double ampersands are used to display an actual ampersand character in the name. The Mac OS ignores and removes the extra ampersand characters.

Constants/Events

Name

Type

Access

Description

BEFORE_DISPLAY

String

readonly

Dispatched before the Submenu is displayed. This event does not bubble. This event is not cancelable.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

Submenu getElements ()

Resolves the object specifier, creating an array of object references.

undefined remove ()

Deletes the Submenu.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the Submenu.

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MenuElement.parent

MenuItem.parent

MenuSeparator.parent

MutationEvent.parent

Submenu.parent

Return

Submenus.add()

Submenu.getElements()

Submenus.anyItem()

Submenus.everyItem()

Submenus.nextItem()

Submenus.previousItem()

Submenus.item()

Submenus.[]()

Submenus.itemByName()

Submenus.itemByRange()

Submenus.firstItem()

Submenus.lastItem()

Submenus.middleItem()