Packagecom.adobe.indesign
Classpublic class Swatches
InheritanceSwatches 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.
Swatches
Public Methods
 MethodDefined By
  
Returns any Swatch in the collection.
Swatches
  
count():Number
Displays the number of elements in the Swatch.
Swatches
  
everyItem():Object
Returns every Swatch in the collection.
Swatches
 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 Swatch in the collection.
Swatches
 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):Swatch
Returns the Swatch with the specified index or name.
Swatches
  
itemByID(idParam:Number):Swatch
Returns the Swatch with the specified ID.
Swatches
  
itemByName(nameParam:String = null):Swatch
Returns the Swatch with the specified name.
Swatches
  
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the Swatches within the specified range.
Swatches
  
Returns the last Swatch in the collection.
Swatches
  
Returns the middle Swatch in the collection.
Swatches
  
nextItem(objParam:Swatch = null):Swatch
Returns the Swatch whose index follows the specified Swatch in the collection.
Swatches
  
previousItem(objParam:Swatch = null):Swatch
Returns the Swatch with the index previous to the specified index.
Swatches
 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
Swatches
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
Swatches
Property Detail
lengthproperty
length:Number  [read-only]

The number of objects in the collection.


Implementation
    public function get length():Number
Method Detail
anyItem()method
public function anyItem():Swatch

Returns any Swatch in the collection.

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

Displays the number of elements in the Swatch.

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

Returns every Swatch in the collection.

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

Returns the first Swatch in the collection.

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

Returns the Swatch with the specified index or name.

Parameters

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

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

Returns the Swatch with the specified ID.

Parameters

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

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

Returns the Swatch with the specified name.

Parameters

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

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

Returns the Swatches within the specified range.

Parameters

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

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

Returns the last Swatch in the collection.

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

Returns the middle Swatch in the collection.

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

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

Parameters

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

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

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

Parameters

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

Returns
Swatch