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

Create a new XMLRuleProcessor

Parameters

rulePathsParam:Array (default = null) — (Array) The XPath condition paths of the rules in the rule set.
 
prefixMappingTableParam:Array (default = null) — (Array) The namespace mapping table. Can accept: Array of Arrays of 2 Strings. (Optional)
 
withPropertiesParam:Object (default = null) — (Object) Initial values for properties of the new XMLRuleProcessor (Optional)

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

Returns any XMLRuleProcessor in the collection.

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

Displays the number of elements in the XMLRuleProcessor.

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

Returns every XMLRuleProcessor in the collection.

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

Returns the first XMLRuleProcessor in the collection.

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

Returns the XMLRuleProcessor with the specified index or name.

Parameters

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

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

Returns the XMLRuleProcessor with the specified ID.

Parameters

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

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

Returns the XMLRuleProcessor with the specified name.

Parameters

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

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

Returns the XMLRuleProcessors within the specified range.

Parameters

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

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

Returns the last XMLRuleProcessor in the collection.

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

Returns the middle XMLRuleProcessor in the collection.

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

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

Parameters

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

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

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

Parameters

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

Returns
XMLRuleProcessor