Package | com.adobe.incopy |
Class | public class NotePreference |
Inheritance | NotePreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | NotePreference | ||
events : Events [override] [read-only]
A collection of events. | NotePreference | ||
findAndReplaceNoteContents : Boolean
If true, includes inline notes content when using Find/Change commands (in Galley and Story views only). | NotePreference | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | NotePreference | ||
noteBackgroundColor : NoteBackgrounds
The background color for notes. | NotePreference | ||
noteColor : Object
The note color, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as an InCopy UI color. | NotePreference | ||
noteColorChoices : NoteColorChoices
The color to use for notes. | NotePreference | ||
parent : Object [override] [read-only]
The parent of the NotePreference (a Application). | NotePreference | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | NotePreference | ||
showNoteTips : Boolean
If true, displays note information and some note content when the mouse pointer hovers over a note anchor in layout view or a note bookend in galley or story view. | NotePreference | ||
spellCheckNotes : Boolean
If true, includes inline notes content when using Spell Check (in Galley and Story views only). | NotePreference |
Method | Defined By | ||
---|---|---|---|
addEventListenerNotePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | NotePreference | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
![]() | 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. | NotePreference | ||
![]() | 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 | |
removeEventListenerNotePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | NotePreference | ||
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | NotePreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
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
findAndReplaceNoteContents | property |
findAndReplaceNoteContents:Boolean
Since : | CS5 |
If true, includes inline notes content when using Find/Change commands (in Galley and Story views only).
public function get findAndReplaceNoteContents():Boolean
public function set findAndReplaceNoteContents(value:Boolean):void
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
noteBackgroundColor | property |
noteBackgroundColor:NoteBackgrounds
Since : | CS5 |
The background color for notes.
public function get noteBackgroundColor():NoteBackgrounds
public function set noteBackgroundColor(value:NoteBackgrounds):void
noteColor | property |
noteColor:Object
Since : | CS5 |
The note color, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as an InCopy UI color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.
public function get noteColor():Object
public function set noteColor(value:Object):void
noteColorChoices | property |
noteColorChoices:NoteColorChoices
Since : | CS5 |
The color to use for notes.
public function get noteColorChoices():NoteColorChoices
public function set noteColorChoices(value:NoteColorChoices):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the NotePreference (a Application).
public function get parent():Object
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
showNoteTips | property |
showNoteTips:Boolean
Since : | CS5 |
If true, displays note information and some note content when the mouse pointer hovers over a note anchor in layout view or a note bookend in galley or story view.
public function get showNoteTips():Boolean
public function set showNoteTips(value:Boolean):void
spellCheckNotes | property |
spellCheckNotes:Boolean
Since : | CS5 |
If true, includes inline notes content when using Spell Check (in Galley and Story views only).
public function get spellCheckNotes():Boolean
public function set spellCheckNotes(value:Boolean):void
addEventListenerNotePreference | () | method |
public function addEventListenerNotePreference(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 |
removeEventListenerNotePreference | () | method |
public function removeEventListenerNotePreference(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 |