RuleDataObject

A preflight rule data object.

Methods:

addEventListener, getElements, remove, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Number, Object, RuleDataType, String,

Property Listing

Property

Type

Access

Description

dataType

RuleDataType

RuleDataType.BOOLEAN_DATA_TYPE

RuleDataType.INTEGER_DATA_TYPE

RuleDataType.LIST_DATA_TYPE

RuleDataType.OBJECT_DATA_TYPE

RuleDataType.REAL_DATA_TYPE

RuleDataType.SHORT_INTEGER_DATA_TYPE

RuleDataType.STRING_DATA_TYPE

readonly

The type of data.

dataValue

Boolean

Booleans Boolean

LongInteger

LongIntegers

Object

Objects Object

Real

Reals

ShortInteger

ShortIntegers

String

Array of Strings String

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

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

id

String

readonly

The ID for this rule data object.

index

Number

readonly

The index of the RuleDataObject within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

name

String

readonly

The name of the RuleDataObject.

parent

PreflightProfileRule

PreflightRuleInstance

readonly

The parent of the RuleDataObject (a PreflightProfileRule or PreflightRuleInstance).

properties

Object

read/write

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

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

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 File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

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.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

Return

RuleDataObjects.add()

RuleDataObject.getElements()

RuleDataObjects.anyItem()

RuleDataObjects.everyItem()

RuleDataObjects.nextItem()

RuleDataObjects.previousItem()

RuleDataObjects.itemByID()

RuleDataObjects.item()

RuleDataObjects.[]()

RuleDataObjects.itemByName()

RuleDataObjects.itemByRange()

RuleDataObjects.firstItem()

RuleDataObjects.lastItem()

RuleDataObjects.middleItem()