Packagecom.adobe.indesign
Classpublic class XMLRuleProcessor
InheritanceXMLRuleProcessor Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  eventListeners : EventListeners
[read-only] A collection of event listeners.
XMLRuleProcessor
  events : Events
[read-only] A collection of events.
XMLRuleProcessor
  halted : Boolean
[read-only] If true, the XML rule process has halted.
XMLRuleProcessor
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the XMLRuleProcessor.
XMLRuleProcessor
  index : Number
[read-only] The index of the XMLRuleProcessor within its containing object.
XMLRuleProcessor
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
XMLRuleProcessor
  label : String
A property that can be set to any string.
XMLRuleProcessor
  name : String
The name of the XMLRuleProcessor; this is an alias to the XMLRuleProcessor's label property.
XMLRuleProcessor
  parent : Application
[read-only] The parent of the XMLRuleProcessor (a Application).
XMLRuleProcessor
  properties : Object
A property that allows setting of several properties at the same time.
XMLRuleProcessor
  rulePaths : Object
[read-only] The XPath condition paths of the rules in the rule set.
XMLRuleProcessor
Public Methods
 MethodDefined By
  
addEventListenerXMLRuleProcessor(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
XMLRuleProcessor
  
Stop processing XML rule set.
XMLRuleProcessor
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
XMLRuleProcessor
 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
  
Finds the next matching XML element.
XMLRuleProcessor
 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
  
getElements():Object
Resolves the object specifier, creating an array of object references.
XMLRuleProcessor
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
  
halt():void
Halt the XML rule processor.
XMLRuleProcessor
 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
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
XMLRuleProcessor
 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
  
remove():void
Deletes the XMLRuleProcessor.
XMLRuleProcessor
  
removeEventListenerXMLRuleProcessor(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
XMLRuleProcessor
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
Do not process XML elements (children) of the current XML element.
XMLRuleProcessor
  
Start processing an XML rule set.
XMLRuleProcessor
  
Process the XML elements of the current XML element.
XMLRuleProcessor
  
toSpecifier():String
Retrieves the object specifier.
XMLRuleProcessor
 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
Property Detail
eventListenersproperty
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
haltedproperty 
halted:Boolean  [read-only]

If true, the XML rule process has halted.


Implementation
    public function get halted():Boolean
idproperty 
id:Number  [read-only]

The unique ID of the XMLRuleProcessor.


Implementation
    public function get id():Number
indexproperty 
index:Number  [read-only]

The index of the XMLRuleProcessor within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
nameproperty 
name:String

The name of the XMLRuleProcessor; this is an alias to the XMLRuleProcessor's label property.


Implementation
    public function get name():String
    public function set name(value:String):void
parentproperty 
parent:Application  [read-only]

The parent of the XMLRuleProcessor (a Application).


Implementation
    public function get parent():Application
propertiesproperty 
properties:Object

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
rulePathsproperty 
rulePaths:Object  [read-only]

The XPath condition paths of the rules in the rule set.


Implementation
    public function get rulePaths():Object
Method Detail
addEventListenerXMLRuleProcessor()method
public function addEventListenerXMLRuleProcessor(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
endProcessingRuleSet()method 
public function endProcessingRuleSet():void

Stop processing XML rule set.

extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
findNextMatch()method 
public function findNextMatch():XMLRuleMatchData

Finds the next matching XML element.

Returns
XMLRuleMatchData
getElements()method 
public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
halt()method 
public function halt():void

Halt the XML rule processor.

insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

Sets the label to the value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

remove()method 
public function remove():void

Deletes the XMLRuleProcessor.

removeEventListenerXMLRuleProcessor()method 
public function removeEventListenerXMLRuleProcessor(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
skipChildren()method 
public function skipChildren():void

Do not process XML elements (children) of the current XML element.

startProcessingRuleSet()method 
public function startProcessingRuleSet(initialElementParam:XMLElement = null):XMLRuleMatchData

Start processing an XML rule set.

Parameters

initialElementParam:XMLElement (default = null) — (XMLElement) The XML element at which to start processing the rule set.

Returns
XMLRuleMatchData
startProcessingSubtree()method 
public function startProcessingSubtree():XMLRuleMatchData

Process the XML elements of the current XML element.

Returns
XMLRuleMatchData
toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String