Package | com.adobe.indesign |
Class | public class MenuItem |
Inheritance | MenuItem ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
associatedMenuAction : MenuAction [read-only]
The menu action that implements the menu item. | MenuItem | ||
checked : Boolean [read-only]
If true, the menu item associated with the menu action is checked. | MenuItem | ||
enabled : Boolean [read-only]
If true, the MenuItem is enabled. | MenuItem | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | MenuItem | ||
events : Events [override] [read-only]
A collection of events. | MenuItem | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [read-only]
The unique ID of the MenuItem. | MenuItem | ||
index : Number [override] [read-only]
The index of the MenuItem within its containing object. | MenuItem | ||
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | MenuItem | ||
name : String [read-only]
The name of the MenuItem. | MenuItem | ||
parent : Object [override] [read-only]
The parent of the MenuItem (a Menu or Submenu). | MenuItem | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | MenuItem | ||
title : String [read-only]
The name of the MenuItem for display in the user interface. | MenuItem |
Method | Defined By | ||
---|---|---|---|
![]() | addEventListenerMenuElement(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | MenuElement | |
addEventListenerMenuItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | MenuItem | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | getClassObjectForName(className:String):HostObject [static] This returns a "Class" object, meaning, a HostObject that can be used
to make static function calls or get static properties
| CSHostObject | |
getElements():Object [override]
Resolves the object specifier, creating an array of object references. | MenuItem | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):* [static]
Implements a safe get of a static property on the host
Used by for instance, all the enum implementations. | CSHostObject | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | isDescendedFrom(clz:Class, ancClass:Class):Boolean [static] Efficiently determines whether or not one class descends from
another in inheritance hierarchy- class relationships are cached
by the ClassUtils implementation-
(uses org.as3commons lib to quickly discover class hierarchy. | CSHostObject | |
remove():void [override]
Deletes the MenuItem. | MenuItem | ||
![]() | removeEventListenerMenuElement(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | MenuElement | |
removeEventListenerMenuItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | MenuItem | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
select():void
Selects the MenuItem. | MenuItem | ||
toSpecifier():String [override]
Retrieves the object specifier. | MenuItem | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
associatedMenuAction | property |
associatedMenuAction:MenuAction
[read-only] Since : | CS5 |
The menu action that implements the menu item.
public function get associatedMenuAction():MenuAction
checked | property |
checked:Boolean
[read-only] Since : | CS5 |
If true, the menu item associated with the menu action is checked.
public function get checked():Boolean
enabled | property |
enabled:Boolean
[read-only] Since : | CS5 |
If true, the MenuItem is enabled.
public function get enabled():Boolean
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the MenuItem.
public function get id():Number
index | property |
index:Number
[read-only] [override] Since : | CS5 |
The index of the MenuItem within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
name | property |
name:String
[read-only] Since : | CS5 |
The name of the MenuItem.
public function get name():String
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the MenuItem (a Menu or Submenu).
public function get parent():Object
properties | property |
properties:Object
[override] Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
title | property |
title:String
[read-only] Since : | CS5 |
The name of the MenuItem 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.
public function get title():String
addEventListenerMenuItem | () | method |
public function addEventListenerMenuItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
Adds an event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The event type.
| |
handlerParam:Object (default = null ) — (Object) The event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
EventListener |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
remove | () | method |
override public function remove():void
Since : | CS5 |
Deletes the MenuItem.
removeEventListenerMenuItem | () | method |
public function removeEventListenerMenuItem(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
Removes the event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The registered event type.
| |
handlerParam:Object (default = null ) — (Object) The registered event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
Boolean |
select | () | method |
public function select():void
Since : | CS5 |
Selects the MenuItem.
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |