Condition
A condition for conditional text.
Go to Property Listing | Method Listing
Methods:
addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier
Objects:
Boolean, ConditionIndicatorMethod, ConditionUnderlineIndicatorAppearance, EventListeners, Events, Number, Object, String, UIColors,
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
A collection of event listeners. |
||
|
readonly |
A collection of events. |
||
|
readonly |
The unique ID of the Condition. |
||
|
readonly |
The index of the Condition within its containing object. |
||
|
Array of 3 Reals (0 - 255) |
read/write |
The color for the condition indicator; specified either as an array of three doubles representing RGB values in the range 0 to 255, or as a UI color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. |
|
|
read/write |
The condition indicator method. |
||
|
readonly |
Returns true if the object specifier resolves to valid objects. |
||
|
read/write |
A property that can be set to any string. |
||
|
read/write |
The name of the Condition. |
||
|
readonly |
The parent of the Condition (a Application or Document). |
||
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
read/write |
The condition underline indicator appearance. |
||
|
read/write |
If true, the Condition is visible. |
Method Listing
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
String extractLabel (key:String)
Gets the label value associated with the specified key.
|
Parameter |
Type |
Description |
|---|---|---|
|
key |
The key. |
Condition 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.
undefined remove (replacingWith:Varies Condition String)
Delete the condition.
|
Parameter |
Type |
Description |
|---|---|---|
|
replacingWith |
The condition to apply to text in place of the deleted condition. By default, no condition is applied in place of the deleted condition. Can accept: Condition or String. (Optional) |
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
JavaScriptFunction |
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 Condition.
String toSpecifier ()
Retrieves the object specifier.
Object of
Text.appliedConditions
Character.appliedConditions
Word.appliedConditions
Line.appliedConditions
TextColumn.appliedConditions
Paragraph.appliedConditions
TextStyleRange.appliedConditions
InsertionPoint.appliedConditions
Event.parent
EventListener.parent
MutationEvent.parent
Return
Conditions.[]()