Packagecom.adobe.indesign
Classpublic class ObjectStyles
InheritanceObjectStyles 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.
ObjectStyles
Public Methods
 MethodDefined By
  
add(withPropertiesParam:Object = null):ObjectStyle
Creates a new ObjectStyle.
ObjectStyles
  
Returns any ObjectStyle in the collection.
ObjectStyles
  
count():Number
Displays the number of elements in the ObjectStyle.
ObjectStyles
  
everyItem():Object
Returns every ObjectStyle in the collection.
ObjectStyles
 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 ObjectStyle in the collection.
ObjectStyles
 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):ObjectStyle
Returns the ObjectStyle with the specified index or name.
ObjectStyles
  
itemByID(idParam:Number):ObjectStyle
Returns the ObjectStyle with the specified ID.
ObjectStyles
  
itemByName(nameParam:String = null):ObjectStyle
Returns the ObjectStyle with the specified name.
ObjectStyles
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the ObjectStyles within the specified range.
ObjectStyles
  
Returns the last ObjectStyle in the collection.
ObjectStyles
  
Returns the middle ObjectStyle in the collection.
ObjectStyles
  
Returns the ObjectStyle whose index follows the specified ObjectStyle in the collection.
ObjectStyles
  
Returns the ObjectStyle with the index previous to the specified index.
ObjectStyles
 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
ObjectStyles
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
ObjectStyles
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(withPropertiesParam:Object = null):ObjectStyle

Creates a new ObjectStyle.

Parameters

withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new ObjectStyle (Optional)

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

Returns any ObjectStyle in the collection.

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

Displays the number of elements in the ObjectStyle.

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

Returns every ObjectStyle in the collection.

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

Returns the first ObjectStyle in the collection.

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

Returns the ObjectStyle with the specified index or name.

Parameters

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

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

Returns the ObjectStyle with the specified ID.

Parameters

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

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

Returns the ObjectStyle with the specified name.

Parameters

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

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

Returns the ObjectStyles within the specified range.

Parameters

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

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

Returns the last ObjectStyle in the collection.

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

Returns the middle ObjectStyle in the collection.

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

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

Parameters

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

Returns
ObjectStyle
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:ObjectStyle = null):ObjectStyle

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

Parameters

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

Returns
ObjectStyle