PreflightRuleInstance
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| description | string | readonly | The description of the PreflightRuleInstance. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| flag | PreflightRuleFlag: PreflightRuleFlag.RULE_IS_DISABLED PreflightRuleFlag.RETURN_AS_ERROR PreflightRuleFlag.RETURN_AS_WARNING PreflightRuleFlag.RETURN_AS_INFORMATIONAL |
r/w | 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 | 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 | readonly | The name of the PreflightRuleInstance. |
| parent | PreflightProfile | readonly | The parent of the PreflightRuleInstance (a PreflightProfile). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| ruleDataObjects | RuleDataObjects | readonly | A collection of prefight rule data objects. |
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) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of PreflightRuleInstance getElements ()
Resolves the object specifier, creating an array of object references.
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 PreflightRuleInstance.
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) |
string toSource ()
Generates a string which, if executed, will return the PreflightRuleInstance.
string toSpecifier ()
Retrieves the object specifier.
Element of
RuleDataObject.parent
Used in:
PreflightRuleInstance PreflightRuleInstances.nextItem (obj: PreflightRuleInstance)
PreflightRuleInstance PreflightRuleInstances.previousItem (obj: PreflightRuleInstance)
Return
Array of PreflightRuleInstance PreflightRuleInstance.getElements ()
PreflightRuleInstance PreflightRuleInstances.[] (index: number)
PreflightRuleInstance PreflightRuleInstances.anyItem ()
Array of PreflightRuleInstance PreflightRuleInstances.everyItem ()
PreflightRuleInstance PreflightRuleInstances.firstItem ()
PreflightRuleInstance PreflightRuleInstances.item (index: varies)
PreflightRuleInstance PreflightRuleInstances.itemByID (id: number)
PreflightRuleInstance PreflightRuleInstances.itemByName (name: string)
Array of PreflightRuleInstance PreflightRuleInstances.itemByRange (from: varies, to: varies)
PreflightRuleInstance PreflightRuleInstances.lastItem ()
PreflightRuleInstance PreflightRuleInstances.middleItem ()
PreflightRuleInstance PreflightRuleInstances.nextItem (obj: PreflightRuleInstance)
PreflightRuleInstance PreflightRuleInstances.previousItem (obj: PreflightRuleInstance)
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |