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

Creates a new CharacterStyleGroup.

Parameters

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

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

Returns any CharacterStyleGroup in the collection.

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

Displays the number of elements in the CharacterStyleGroup.

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

Returns every CharacterStyleGroup in the collection.

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

Returns the first CharacterStyleGroup in the collection.

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

Returns the CharacterStyleGroup with the specified index or name.

Parameters

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

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

Returns the CharacterStyleGroup with the specified ID.

Parameters

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

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

Returns the CharacterStyleGroup with the specified name.

Parameters

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

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

Returns the CharacterStyleGroups within the specified range.

Parameters

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

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

Returns the last CharacterStyleGroup in the collection.

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

Returns the middle CharacterStyleGroup in the collection.

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

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

Parameters

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

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

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

Parameters

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

Returns
CharacterStyleGroup