Packagecom.adobe.indesign
Classpublic class ScriptMenuActions
InheritanceScriptMenuActions Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  length : Number
[read-only] The number of objects in the collection.
ScriptMenuActions
Public Methods
 MethodDefined By
  
add(titleParam:String = null, withPropertiesParam:Object = null):ScriptMenuAction
Creates a new action.
ScriptMenuActions
  
Returns any ScriptMenuAction in the collection.
ScriptMenuActions
  
count():Number
Displays the number of elements in the ScriptMenuAction.
ScriptMenuActions
  
everyItem():Object
Returns every ScriptMenuAction in the collection.
ScriptMenuActions
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
  
Returns the first ScriptMenuAction in the collection.
ScriptMenuActions
 Inherited
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
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
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
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
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
  
item(indexParam:Object = null):ScriptMenuAction
Returns the ScriptMenuAction with the specified index or name.
ScriptMenuActions
  
itemByID(idParam:Number):ScriptMenuAction
Returns the ScriptMenuAction with the specified ID.
ScriptMenuActions
  
itemByName(nameParam:String = null):ScriptMenuAction
Returns the ScriptMenuAction with the specified name.
ScriptMenuActions
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the ScriptMenuActions within the specified range.
ScriptMenuActions
  
Returns the last ScriptMenuAction in the collection.
ScriptMenuActions
  
Returns the middle ScriptMenuAction in the collection.
ScriptMenuActions
  
Returns the ScriptMenuAction whose index follows the specified ScriptMenuAction in the collection.
ScriptMenuActions
  
Returns the ScriptMenuAction with the index previous to the specified index.
ScriptMenuActions
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
  
nextNameIndex(idx:int):int
[override] Overriding this allows us to support for each...in
ScriptMenuActions
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
ScriptMenuActions
Property Detail
lengthproperty
length:Number  [read-only]

The number of objects in the collection.


Implementation
    public function get length():Number
Method Detail
add()method
public function add(titleParam:String = null, withPropertiesParam:Object = null):ScriptMenuAction

Creates a new action.

Parameters

titleParam:String (default = null) — (String) 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. (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new ScriptMenuAction (Optional)

Returns
ScriptMenuAction
anyItem()method 
public function anyItem():ScriptMenuAction

Returns any ScriptMenuAction in the collection.

Returns
ScriptMenuAction
count()method 
public function count():Number

Displays the number of elements in the ScriptMenuAction.

Returns
Number
everyItem()method 
public function everyItem():Object

Returns every ScriptMenuAction in the collection.

Returns
Object
firstItem()method 
public function firstItem():ScriptMenuAction

Returns the first ScriptMenuAction in the collection.

Returns
ScriptMenuAction
item()method 
public function item(indexParam:Object = null):ScriptMenuAction

Returns the ScriptMenuAction with the specified index or name.

Parameters

indexParam:Object (default = null) — (Object) The index or name. Can accept: Long Integer or String.

Returns
ScriptMenuAction
itemByID()method 
public function itemByID(idParam:Number):ScriptMenuAction

Returns the ScriptMenuAction with the specified ID.

Parameters

idParam:Number (default = NaN) — (Number) The ID.

Returns
ScriptMenuAction
itemByName()method 
public function itemByName(nameParam:String = null):ScriptMenuAction

Returns the ScriptMenuAction with the specified name.

Parameters

nameParam:String (default = null) — (String) The name.

Returns
ScriptMenuAction
itemByRange()method 
public function itemByRange(fromParam:Object = null, toParam:Object = null):Object

Returns the ScriptMenuActions within the specified range.

Parameters

fromParam:Object (default = null) — (Object) The ScriptMenuAction, index, or name at the beginning of the range. Can accept: ScriptMenuAction, Long Integer or String.
 
toParam:Object (default = null) — (Object) The ScriptMenuAction, index, or name at the end of the range. Can accept: ScriptMenuAction, Long Integer or String.

Returns
Object
lastItem()method 
public function lastItem():ScriptMenuAction

Returns the last ScriptMenuAction in the collection.

Returns
ScriptMenuAction
middleItem()method 
public function middleItem():ScriptMenuAction

Returns the middle ScriptMenuAction in the collection.

Returns
ScriptMenuAction
nextItem()method 
public function nextItem(objParam:ScriptMenuAction = null):ScriptMenuAction

Returns the ScriptMenuAction whose index follows the specified ScriptMenuAction in the collection.

Parameters

objParam:ScriptMenuAction (default = null) — (ScriptMenuAction) The ScriptMenuAction whose index comes before the desired ScriptMenuAction.

Returns
ScriptMenuAction
nextNameIndex()method 
override flash_proxy function nextNameIndex(idx:int):int

Overriding this allows us to support for each...in

Parameters

idx:int

Returns
int
nextValue()method 
override flash_proxy function nextValue(index:int):*

Overriding this allows us to support for each...in

Parameters

index:int

Returns
*
previousItem()method 
public function previousItem(objParam:ScriptMenuAction = null):ScriptMenuAction

Returns the ScriptMenuAction with the index previous to the specified index.

Parameters

objParam:ScriptMenuAction (default = null) — (ScriptMenuAction) The index of the ScriptMenuAction that follows the desired ScriptMenuAction.

Returns
ScriptMenuAction