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

Adds a new preflight rule to the profile.

Parameters

idParam:String (default = null) — (String) The ID of the rule to be added
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new PreflightRuleInstance (Optional)

Returns
Object
anyItem()method 
public function anyItem():PreflightRuleInstance

Returns any PreflightRuleInstance in the collection.

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

Displays the number of elements in the PreflightRuleInstance.

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

Returns every PreflightRuleInstance in the collection.

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

Returns the first PreflightRuleInstance in the collection.

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

Returns the PreflightRuleInstance with the specified index or name.

Parameters

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

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

Returns the PreflightRuleInstance with the specified ID.

Parameters

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

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

Returns the PreflightRuleInstance with the specified name.

Parameters

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

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

Returns the PreflightRuleInstances within the specified range.

Parameters

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

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

Returns the last PreflightRuleInstance in the collection.

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

Returns the middle PreflightRuleInstance in the collection.

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

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

Parameters

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

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

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

Parameters

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

Returns
PreflightRuleInstance