Package | com.adobe.indesign |
Class | public class RuleDataObjects |
Inheritance | RuleDataObjects ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
length : Number [read-only]
The number of objects in the collection. | RuleDataObjects |
Method | Defined By | ||
---|---|---|---|
add(nameParam:String = null, dataTypeParam:RuleDataType = null, dataValueParam:Object = null, withPropertiesParam:Object = null):RuleDataObject
Add a new preflight rule data to a preflight profile rule. | RuleDataObjects | ||
Returns any RuleDataObject in the collection. | RuleDataObjects | ||
count():Number
Displays the number of elements in the RuleDataObject. | RuleDataObjects | ||
everyItem():Object
Returns every RuleDataObject in the collection. | RuleDataObjects | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
Returns the first RuleDataObject in the collection. | RuleDataObjects | ||
![]() | 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 | |
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | 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):RuleDataObject
Returns the RuleDataObject with the specified index or name. | RuleDataObjects | ||
itemByID(idParam:Number):RuleDataObject
Returns the RuleDataObject with the specified ID. | RuleDataObjects | ||
itemByName(nameParam:String = null):RuleDataObject
Returns the RuleDataObject with the specified name. | RuleDataObjects | ||
itemByRange(fromParam:Object = null, toParam:Object = null):Object
Returns the RuleDataObjects within the specified range. | RuleDataObjects | ||
Returns the last RuleDataObject in the collection. | RuleDataObjects | ||
Returns the middle RuleDataObject in the collection. | RuleDataObjects | ||
Returns the RuleDataObject whose index follows the specified RuleDataObject in the collection. | RuleDataObjects | ||
Returns the RuleDataObject with the index previous to the specified index. | RuleDataObjects | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
Method | Defined By | ||
---|---|---|---|
![]() | createWithArgs(args:Array):void | CSHostObject | |
![]() | hostCreate(args:Array):void | CSHostObject | |
nextNameIndex(idx:int):int [override]
Overriding this allows us to support for each...in
| RuleDataObjects | ||
nextValue(index:int):* [override]
Overriding this allows us to support for each...in
| RuleDataObjects |
length | property |
length:Number
[read-only] Since : | CS5 |
The number of objects in the collection.
public function get length():Number
add | () | method |
public function add(nameParam:String = null, dataTypeParam:RuleDataType = null, dataValueParam:Object = null, withPropertiesParam:Object = null):RuleDataObject
Since : | CS5 |
Add a new preflight rule data to a preflight profile rule.
Parameters
nameParam:String (default = null ) — (String) The name of the rule data to add
| |
dataTypeParam:RuleDataType (default = null ) — (RuleDataType) The type of data
| |
dataValueParam:Object (default = null ) — (Object) The value of data. Can accept: String, Real, Long Integer, Short Integer, Boolean, Object or Array of Strings, Reals, Long Integers, Short Integers, Booleans, Objects or Arrays of Array of Arrays of Array of Strings, Reals, Long Integers, Short Integers, Booleans or Objects.
| |
withPropertiesParam:Object (default = null ) — (Object) Initial values for properties of the new RuleDataObject (Optional)
|
RuleDataObject |
anyItem | () | method |
public function anyItem():RuleDataObject
Since : | CS5 |
Returns any RuleDataObject in the collection.
ReturnsRuleDataObject |
count | () | method |
public function count():Number
Since : | CS5 |
Displays the number of elements in the RuleDataObject.
ReturnsNumber |
everyItem | () | method |
public function everyItem():Object
Since : | CS5 |
Returns every RuleDataObject in the collection.
ReturnsObject |
firstItem | () | method |
public function firstItem():RuleDataObject
Since : | CS5 |
Returns the first RuleDataObject in the collection.
ReturnsRuleDataObject |
item | () | method |
public function item(indexParam:Object = null):RuleDataObject
Since : | CS5 |
Returns the RuleDataObject with the specified index or name.
Parameters
indexParam:Object (default = null ) — (Object) The index or name. Can accept: Long Integer or String.
|
RuleDataObject |
itemByID | () | method |
public function itemByID(idParam:Number):RuleDataObject
Since : | CS5 |
Returns the RuleDataObject with the specified ID.
Parameters
idParam:Number (default = NaN ) — (Number) The ID.
|
RuleDataObject |
itemByName | () | method |
public function itemByName(nameParam:String = null):RuleDataObject
Since : | CS5 |
Returns the RuleDataObject with the specified name.
Parameters
nameParam:String (default = null ) — (String) The name.
|
RuleDataObject |
itemByRange | () | method |
public function itemByRange(fromParam:Object = null, toParam:Object = null):Object
Since : | CS5 |
Returns the RuleDataObjects within the specified range.
Parameters
fromParam:Object (default = null ) — (Object) The RuleDataObject, index, or name at the beginning of the range. Can accept: RuleDataObject, Long Integer or String.
| |
toParam:Object (default = null ) — (Object) The RuleDataObject, index, or name at the end of the range. Can accept: RuleDataObject, Long Integer or String.
|
Object |
lastItem | () | method |
public function lastItem():RuleDataObject
Since : | CS5 |
Returns the last RuleDataObject in the collection.
ReturnsRuleDataObject |
middleItem | () | method |
public function middleItem():RuleDataObject
Since : | CS5 |
Returns the middle RuleDataObject in the collection.
ReturnsRuleDataObject |
nextItem | () | method |
public function nextItem(objParam:RuleDataObject = null):RuleDataObject
Since : | CS5 |
Returns the RuleDataObject whose index follows the specified RuleDataObject in the collection.
Parameters
objParam:RuleDataObject (default = null ) — (RuleDataObject) The RuleDataObject whose index comes before the desired RuleDataObject.
|
RuleDataObject |
nextNameIndex | () | method |
override flash_proxy function nextNameIndex(idx:int):int
Since : | CS5 |
Overriding this allows us to support for each...in
Parameters
idx:int |
int |
nextValue | () | method |
override flash_proxy function nextValue(index:int):*
Since : | CS5 |
Overriding this allows us to support for each...in
Parameters
index:int |
* |
previousItem | () | method |
public function previousItem(objParam:RuleDataObject = null):RuleDataObject
Since : | CS5 |
Returns the RuleDataObject with the index previous to the specified index.
Parameters
objParam:RuleDataObject (default = null ) — (RuleDataObject) The index of the RuleDataObject that follows the desired RuleDataObject.
|
RuleDataObject |