A preflight rule data object.
Go to Property Listing | Method Listing
remove, toSource, getElements, toSpecifier, addEventListener, removeEventListener
Boolean, EventListeners, Events, Number, Object, PreflightProfileRule, PreflightRuleInstance, RuleDataType, String,
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
dataType |
RuleDataType.INTEGER_DATA_TYPE RuleDataType.SHORT_INTEGER_DATA_TYPE RuleDataType.REAL_DATA_TYPE RuleDataType.STRING_DATA_TYPE RuleDataType.BOOLEAN_DATA_TYPE RuleDataType.OBJECT_DATA_TYPE RuleDataType.LIST_DATA_TYPE |
readonly |
The type of data. |
|
dataValue |
Booleans Boolean LongInteger LongIntegers Objects Object Real Reals ShortInteger ShortIntegers Array of Arrays of Arrays of Strings |
read/write |
The value for this data object. Can return: 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. |
|
eventListeners |
readonly |
A collection of event listeners. |
|
|
events |
readonly |
A collection of events. |
|
|
id |
readonly |
The ID for this rule data object. |
|
|
index |
readonly |
The index of the RuleDataObject within its containing object. |
|
|
isValid |
readonly |
Returns true if the object specifier resolves to valid objects. |
|
|
name |
readonly |
The name of the RuleDataObject. |
|
|
parent |
readonly |
The parent of the RuleDataObject (a PreflightProfileRule or PreflightRuleInstance). |
|
|
properties |
read/write |
A property that allows setting of several properties at the same time. |
EventListener addEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
Varies |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
RuleDataObject getElements ()
Resolves the object specifier, creating an array of object references.
undefined remove ()
Deletes the RuleDataObject.
Boolean removeEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
Varies |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
String toSource ()
Generates a string which, if executed, will return the RuleDataObject.
String toSpecifier ()
Retrieves the object specifier.