PreflightRuleInstance

Methods:

addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Objects:

Boolean, EventListeners, Events, Number, Object, PreflightRuleFlag, RuleDataObjects, String

Hierarchy:

Class: PreflightRuleInstance

Property Listing

Property	Type	Access	Description
description	String	readonly	The description of the PreflightRuleInstance.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
flag	PreflightRuleFlag PreflightRuleFlag.RETURN_AS_ERROR PreflightRuleFlag.RETURN_AS_INFORMATIONAL PreflightRuleFlag.RETURN_AS_WARNING PreflightRuleFlag.RULE_IS_DISABLED	read/write	Indicates whether or not the preflight rule is disabled, set for error, warning, or information level feedback.
id	String	readonly	The rule ID for this rule.
index	Number	readonly	The index of the PreflightRuleInstance within its containing object.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
label	String	read/write	A property that can be set to any string.
name	String	readonly	The name of the PreflightRuleInstance.
parent	PreflightProfile	readonly	The parent of the PreflightRuleInstance (a PreflightProfile).
properties	Object	read/write	A property that allows setting of several properties at the same time.
ruleDataObjects	RuleDataObjects RuleDataObject	readonly	A collection of prefight rule data objects.

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)

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)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

PreflightRuleInstance getElements ()

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

undefined 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.

undefined remove ()

Deletes the PreflightRuleInstance.

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)