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

Creates a new mixed ink group.

Parameters

inkListParam:Array (default = null) — (Array) The inks to include in the mix.
 
inkPercentagesParam:Array (default = null) — (Array) The percent of each ink in the ink list. (Range: 0 to 100 for each ink) (Optional)
 
repeatValuesParam:Array (default = null) — (Array) The number of repetitions for each ink in the ink list. (Range: 0 to 100 for each ink) (Optional)
 
incrementValuesParam:Array (default = null) — (Array) The increment percent per repetition for each ink. (Range: 0 to 100) Note: The cumulative ink percentage per ink cannot exceed 100.) (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new MixedInkGroup (Optional)

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

Returns any MixedInkGroup in the collection.

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

Displays the number of elements in the MixedInkGroup.

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

Returns every MixedInkGroup in the collection.

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

Returns the first MixedInkGroup in the collection.

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

Returns the MixedInkGroup with the specified index or name.

Parameters

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

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

Returns the MixedInkGroup with the specified ID.

Parameters

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

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

Returns the MixedInkGroup with the specified name.

Parameters

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

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

Returns the MixedInkGroups within the specified range.

Parameters

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

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

Returns the last MixedInkGroup in the collection.

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

Returns the middle MixedInkGroup in the collection.

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

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

Parameters

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

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

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

Parameters

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

Returns
MixedInkGroup