Package | com.adobe.indesign |
Class | public class ScriptMenuAction |
Inheritance | ScriptMenuAction ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
AFTER_INVOKE : String [static] [read-only]
Dispatched after the ScriptMenuAction is invoked. | ScriptMenuAction | ||
area : String [override]
The menu action area. | ScriptMenuAction | ||
BEFORE_DISPLAY : String [static] [read-only]
Dispatched before the ScriptMenuAction is displayed. | ScriptMenuAction | ||
BEFORE_INVOKE : String [static] [read-only]
Dispatched before the ScriptMenuAction is invoked. | ScriptMenuAction | ||
checked : Boolean [override]
If true, the menu item associated with the menu action is checked. | ScriptMenuAction | ||
enabled : Boolean [override]
If true, the ScriptMenuAction is enabled. | ScriptMenuAction | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | ScriptMenuAction | ||
events : Events [override] [read-only]
A collection of events. | ScriptMenuAction | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [override] [read-only]
The unique ID of the ScriptMenuAction. | ScriptMenuAction | ||
index : Number [override] [read-only]
The index of the ScriptMenuAction within its containing object. | ScriptMenuAction | ||
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | ScriptMenuAction | ||
label : String [override]
A property that can be set to any string. | ScriptMenuAction | ||
name : String [override]
The name of the ScriptMenuAction. | ScriptMenuAction | ||
ON_INVOKE : String [static] [read-only]
Dispatched when the ScriptMenuAction is invoked. | ScriptMenuAction | ||
parent : Application [override] [read-only]
The parent of the ScriptMenuAction (a Application). | ScriptMenuAction | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | ScriptMenuAction | ||
title : String [override]
The name of the ScriptMenuAction for display in the user interface. | ScriptMenuAction |
Method | Defined By | ||
---|---|---|---|
![]() | addEventListenerMenuAction(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | MenuAction | |
addEventListenerScriptMenuAction(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | ScriptMenuAction | ||
extractLabel(keyParam:String = null):String [override]
Gets the label value associated with the specified key. | ScriptMenuAction | ||
![]() | 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. | ScriptMenuAction | ||
![]() | 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 | |
insertLabel(keyParam:String = null, valueParam:String = null):void [override]
Sets the label to the value associated with the specified key. | ScriptMenuAction | ||
invoke():void [override]
Invoke the action. | ScriptMenuAction | ||
![]() | 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
Deletes the ScriptMenuAction. | ScriptMenuAction | ||
![]() | removeEventListenerMenuAction(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | MenuAction | |
removeEventListenerScriptMenuAction(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | ScriptMenuAction | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | ScriptMenuAction | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
AFTER_INVOKE | property |
AFTER_INVOKE:String
[read-only] Since : | CS5 |
Dispatched after the ScriptMenuAction is invoked. This event does not bubble. This event is not cancelable.
public static function get AFTER_INVOKE():String
area | property |
area:String
[override] Since : | CS5 |
The menu action area.
public function get area():String
public function set area(value:String):void
BEFORE_DISPLAY | property |
BEFORE_DISPLAY:String
[read-only] Since : | CS5 |
Dispatched before the ScriptMenuAction is displayed. This event does not bubble. This event is not cancelable.
public static function get BEFORE_DISPLAY():String
BEFORE_INVOKE | property |
BEFORE_INVOKE:String
[read-only] Since : | CS5 |
Dispatched before the ScriptMenuAction is invoked. This event does not bubble. This event is cancelable.
public static function get BEFORE_INVOKE():String
checked | property |
checked:Boolean
[override] Since : | CS5 |
If true, the menu item associated with the menu action is checked.
public function get checked():Boolean
public function set checked(value:Boolean):void
enabled | property |
enabled:Boolean
[override] Since : | CS5 |
If true, the ScriptMenuAction is enabled.
public function get enabled():Boolean
public function set enabled(value:Boolean):void
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] [override] Since : | CS5 |
The unique ID of the ScriptMenuAction.
public function get id():Number
index | property |
index:Number
[read-only] [override] Since : | CS5 |
The index of the ScriptMenuAction 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
label | property |
label:String
[override] Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
name | property |
name:String
[override] Since : | CS5 |
The name of the ScriptMenuAction.
public function get name():String
public function set name(value:String):void
ON_INVOKE | property |
ON_INVOKE:String
[read-only] Since : | CS5 |
Dispatched when the ScriptMenuAction is invoked. This event does not bubble. This event is not cancelable.
public static function get ON_INVOKE():String
parent | property |
parent:Application
[read-only] [override] Since : | CS5 |
The parent of the ScriptMenuAction (a Application).
public function get parent():Application
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
[override] Since : | CS5 |
The name of the ScriptMenuAction 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
public function set title(value:String):void
addEventListenerScriptMenuAction | () | method |
public function addEventListenerScriptMenuAction(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 |
extractLabel | () | method |
override public function extractLabel(keyParam:String = null):String
Since : | CS5 |
Gets the label value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
|
String |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
insertLabel | () | method |
override public function insertLabel(keyParam:String = null, valueParam:String = null):void
Since : | CS5 |
Sets the label to the value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
| |
valueParam:String (default = null ) — (String) The value.
|
invoke | () | method |
override public function invoke():void
Since : | CS5 |
Invoke the action.
remove | () | method |
public function remove():void
Since : | CS5 |
Deletes the ScriptMenuAction.
removeEventListenerScriptMenuAction | () | method |
public function removeEventListenerScriptMenuAction(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 |
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |