Package | com.adobe.indesign |
Class | public class TrackChangesPreference |
Inheritance | TrackChangesPreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
addedBackgroundColorChoice : ChangeBackgroundColorChoices
The background color option for added text. | TrackChangesPreference | ||
addedTextColorChoice : ChangeTextColorChoices
The color option for added text. | TrackChangesPreference | ||
backgroundColorForAddedText : Object
The background color for added text, specified as an InCopy UI color. | TrackChangesPreference | ||
backgroundColorForDeletedText : Object
The background color for deleted text, specified as an InCopy UI color. | TrackChangesPreference | ||
backgroundColorForMovedText : Object
The background color for moved text, specified as an InCopy UI color. | TrackChangesPreference | ||
changeBarColor : Object
The change bar color, specified as an InCopy UI color. | TrackChangesPreference | ||
deletedBackgroundColorChoice : ChangeBackgroundColorChoices
The background color option for deleted text. | TrackChangesPreference | ||
deletedTextColorChoice : ChangeTextColorChoices
The color option for deleted text. | TrackChangesPreference | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | TrackChangesPreference | ||
events : Events [override] [read-only]
A collection of events. | TrackChangesPreference | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | TrackChangesPreference | ||
locationForChangeBar : ChangebarLocations
The change bar location. | TrackChangesPreference | ||
markingForAddedText : ChangeMarkings
The marking that identifies added text. | TrackChangesPreference | ||
markingForDeletedText : ChangeMarkings
The marking that identifies deleted text. | TrackChangesPreference | ||
markingForMovedText : ChangeMarkings
The marking that identifies moved text. | TrackChangesPreference | ||
movedBackgroundColorChoice : ChangeBackgroundColorChoices
The background color option for moved text. | TrackChangesPreference | ||
movedTextColorChoice : ChangeTextColorChoices
The color option for moved text. | TrackChangesPreference | ||
parent : Object [override] [read-only]
The parent of the TrackChangesPreference (a Application). | TrackChangesPreference | ||
preventDuplicateColor : Boolean
If true, prevent duplicate user color for tracked changes background color. | TrackChangesPreference | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | TrackChangesPreference | ||
showAddedText : Boolean
If true, displays added text. | TrackChangesPreference | ||
showChangeBars : Boolean
If true, displays change bars,
| TrackChangesPreference | ||
showDeletedText : Boolean
If true, displays deleted text. | TrackChangesPreference | ||
showMovedText : Boolean
If true, displays moved text. | TrackChangesPreference | ||
spellCheckDeletedText : Boolean
If true, includes deleted text when using the Spell Check command. | TrackChangesPreference | ||
textColorForAddedText : Object
The color for added text, specified as an InCopy UI color. | TrackChangesPreference | ||
textColorForDeletedText : Object
The color for deleted text, specified as an InCopy UI color. | TrackChangesPreference | ||
textColorForMovedText : Object
The color for moved text, specified as an InCopy UI color. | TrackChangesPreference |
Method | Defined By | ||
---|---|---|---|
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
addEventListenerTrackChangesPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | TrackChangesPreference | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | getClassObjectForName(className:String):HostObject [static] This returns a "Class" object, meaning, a HostObject that can be used
to make static function calls or get static properties
| CSHostObject | |
getElements():Object [override]
Resolves the object specifier, creating an array of object references. | TrackChangesPreference | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):* [static]
Implements a safe get of a static property on the host
Used by for instance, all the enum implementations. | CSHostObject | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | isDescendedFrom(clz:Class, ancClass:Class):Boolean [static] Efficiently determines whether or not one class descends from
another in inheritance hierarchy- class relationships are cached
by the ClassUtils implementation-
(uses org.as3commons lib to quickly discover class hierarchy. | CSHostObject | |
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
removeEventListenerTrackChangesPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | TrackChangesPreference | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | TrackChangesPreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
addedBackgroundColorChoice | property |
addedBackgroundColorChoice:ChangeBackgroundColorChoices
Since : | CS5 |
The background color option for added text.
public function get addedBackgroundColorChoice():ChangeBackgroundColorChoices
public function set addedBackgroundColorChoice(value:ChangeBackgroundColorChoices):void
addedTextColorChoice | property |
addedTextColorChoice:ChangeTextColorChoices
Since : | CS5 |
The color option for added text.
public function get addedTextColorChoice():ChangeTextColorChoices
public function set addedTextColorChoice(value:ChangeTextColorChoices):void
backgroundColorForAddedText | property |
backgroundColorForAddedText:Object
Since : | CS5 |
The background color for added text, specified as an InCopy UI color. Note: Valid only when added background color choice is change background uses change pref color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.
public function get backgroundColorForAddedText():Object
public function set backgroundColorForAddedText(value:Object):void
backgroundColorForDeletedText | property |
backgroundColorForDeletedText:Object
Since : | CS5 |
The background color for deleted text, specified as an InCopy UI color. Note: Valid only when deleted background color choice is change background uses change pref color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.
public function get backgroundColorForDeletedText():Object
public function set backgroundColorForDeletedText(value:Object):void
backgroundColorForMovedText | property |
backgroundColorForMovedText:Object
Since : | CS5 |
The background color for moved text, specified as an InCopy UI color. Note: Valid only when moved background color choice is change background uses change pref color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.
public function get backgroundColorForMovedText():Object
public function set backgroundColorForMovedText(value:Object):void
changeBarColor | property |
changeBarColor:Object
Since : | CS5 |
The change bar color, specified as an InCopy UI color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.
public function get changeBarColor():Object
public function set changeBarColor(value:Object):void
deletedBackgroundColorChoice | property |
deletedBackgroundColorChoice:ChangeBackgroundColorChoices
Since : | CS5 |
The background color option for deleted text.
public function get deletedBackgroundColorChoice():ChangeBackgroundColorChoices
public function set deletedBackgroundColorChoice(value:ChangeBackgroundColorChoices):void
deletedTextColorChoice | property |
deletedTextColorChoice:ChangeTextColorChoices
Since : | CS5 |
The color option for deleted text.
public function get deletedTextColorChoice():ChangeTextColorChoices
public function set deletedTextColorChoice(value:ChangeTextColorChoices):void
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
locationForChangeBar | property |
locationForChangeBar:ChangebarLocations
Since : | CS5 |
The change bar location.
public function get locationForChangeBar():ChangebarLocations
public function set locationForChangeBar(value:ChangebarLocations):void
markingForAddedText | property |
markingForAddedText:ChangeMarkings
Since : | CS5 |
The marking that identifies added text.
public function get markingForAddedText():ChangeMarkings
public function set markingForAddedText(value:ChangeMarkings):void
markingForDeletedText | property |
markingForDeletedText:ChangeMarkings
Since : | CS5 |
The marking that identifies deleted text.
public function get markingForDeletedText():ChangeMarkings
public function set markingForDeletedText(value:ChangeMarkings):void
markingForMovedText | property |
markingForMovedText:ChangeMarkings
Since : | CS5 |
The marking that identifies moved text.
public function get markingForMovedText():ChangeMarkings
public function set markingForMovedText(value:ChangeMarkings):void
movedBackgroundColorChoice | property |
movedBackgroundColorChoice:ChangeBackgroundColorChoices
Since : | CS5 |
The background color option for moved text.
public function get movedBackgroundColorChoice():ChangeBackgroundColorChoices
public function set movedBackgroundColorChoice(value:ChangeBackgroundColorChoices):void
movedTextColorChoice | property |
movedTextColorChoice:ChangeTextColorChoices
Since : | CS5 |
The color option for moved text.
public function get movedTextColorChoice():ChangeTextColorChoices
public function set movedTextColorChoice(value:ChangeTextColorChoices):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the TrackChangesPreference (a Application).
public function get parent():Object
preventDuplicateColor | property |
preventDuplicateColor:Boolean
Since : | CS5 |
If true, prevent duplicate user color for tracked changes background color.
public function get preventDuplicateColor():Boolean
public function set preventDuplicateColor(value:Boolean):void
properties | property |
properties:Object
[override] Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
showAddedText | property |
showAddedText:Boolean
Since : | CS5 |
If true, displays added text.
public function get showAddedText():Boolean
public function set showAddedText(value:Boolean):void
showChangeBars | property |
showChangeBars:Boolean
Since : | CS5 |
If true, displays change bars,
public function get showChangeBars():Boolean
public function set showChangeBars(value:Boolean):void
showDeletedText | property |
showDeletedText:Boolean
Since : | CS5 |
If true, displays deleted text.
public function get showDeletedText():Boolean
public function set showDeletedText(value:Boolean):void
showMovedText | property |
showMovedText:Boolean
Since : | CS5 |
If true, displays moved text.
public function get showMovedText():Boolean
public function set showMovedText(value:Boolean):void
spellCheckDeletedText | property |
spellCheckDeletedText:Boolean
Since : | CS5 |
If true, includes deleted text when using the Spell Check command.
public function get spellCheckDeletedText():Boolean
public function set spellCheckDeletedText(value:Boolean):void
textColorForAddedText | property |
textColorForAddedText:Object
Since : | CS5 |
The color for added text, specified as an InCopy UI color. Note: Valid only when added text color choice is change uses change pref color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.
public function get textColorForAddedText():Object
public function set textColorForAddedText(value:Object):void
textColorForDeletedText | property |
textColorForDeletedText:Object
Since : | CS5 |
The color for deleted text, specified as an InCopy UI color. Note: Valid only when deleted text color choice is change uses change pref color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.
public function get textColorForDeletedText():Object
public function set textColorForDeletedText(value:Object):void
textColorForMovedText | property |
textColorForMovedText:Object
Since : | CS5 |
The color for moved text, specified as an InCopy UI color. Note: Valid only when moved text color choice is change uses change pref color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.
public function get textColorForMovedText():Object
public function set textColorForMovedText(value:Object):void
addEventListenerTrackChangesPreference | () | method |
public function addEventListenerTrackChangesPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
Adds an event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The event type.
| |
handlerParam:Object (default = null ) — (Object) The event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
EventListener |
getElements | () | method |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerTrackChangesPreference | () | method |
public function removeEventListenerTrackChangesPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
Removes the event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The registered event type.
| |
handlerParam:Object (default = null ) — (Object) The registered event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
Boolean |
toSpecifier | () | method |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |