XMLRuleProcessor
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| halted | bool | readonly | If true, the XML rule process has halted. |
| id | number | readonly | The unique ID of the XMLRuleProcessor. |
| index | number | readonly | The index of the XMLRuleProcessor within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| label | string | r/w | A property that can be set to any string. |
| name | string | r/w | The name of the XMLRuleProcessor; this is an alias to the XMLRuleProcessor's label property. |
| parent | Application | readonly | The parent of the XMLRuleProcessor (a Application). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rulePaths | Array of string | readonly | The XPath condition paths of the rules in the rule set. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
void endProcessingRuleSet ()
Stop processing XML rule set.
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
XMLRuleMatchData findNextMatch ()
Finds the next matching XML element.
Array of XMLRuleProcessor getElements ()
Resolves the object specifier, creating an array of object references.
void halt ()
Halt the XML rule processor.
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
void remove ()
Deletes the XMLRuleProcessor.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
void skipChildren ()
Do not process XML elements (children) of the current XML element.
XMLRuleMatchData startProcessingRuleSet (initialElement:
XMLElement)
Start processing an XML rule set.
| Parameter | Type | Description |
|---|---|---|
| initialElement | XMLElement | The XML element at which to start processing the rule set. |
XMLRuleMatchData startProcessingSubtree ()
Process the XML elements of the current XML element.
string toSource ()
Generates a string which, if executed, will return the XMLRuleProcessor.
string toSpecifier ()
Retrieves the object specifier.
Element of
XMLRuleMatchData.parent
Used in:
XMLRuleProcessor XMLRuleProcessors.nextItem (obj: XMLRuleProcessor)
XMLRuleProcessor XMLRuleProcessors.previousItem (obj: XMLRuleProcessor)
Return
Array of XMLRuleProcessor XMLRuleProcessor.getElements ()
XMLRuleProcessor XMLRuleProcessors.[] (index: number)
XMLRuleProcessor XMLRuleProcessors.add (rulePaths: Array of string[, prefixMappingTable: Array of varies][, withProperties: Object])
XMLRuleProcessor XMLRuleProcessors.anyItem ()
Array of XMLRuleProcessor XMLRuleProcessors.everyItem ()
XMLRuleProcessor XMLRuleProcessors.firstItem ()
XMLRuleProcessor XMLRuleProcessors.item (index: varies)
XMLRuleProcessor XMLRuleProcessors.itemByID (id: number)
XMLRuleProcessor XMLRuleProcessors.itemByName (name: string)
Array of XMLRuleProcessor XMLRuleProcessors.itemByRange (from: varies, to: varies)
XMLRuleProcessor XMLRuleProcessors.lastItem ()
XMLRuleProcessor XMLRuleProcessors.middleItem ()
XMLRuleProcessor XMLRuleProcessors.nextItem (obj: XMLRuleProcessor)
XMLRuleProcessor XMLRuleProcessors.previousItem (obj: XMLRuleProcessor)
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |