Packagecom.adobe.indesign
Classpublic class NotePreference
InheritanceNotePreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined 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
 InheritedhostObjectDelegate : 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
Public Methods
 MethodDefined By
  
addEventListenerNotePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
NotePreference
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
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
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
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
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
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
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
NotePreference
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
eventListenersproperty
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only] [override]

A collection of events.


Implementation
    public function get events():Events
findAndReplaceNoteContentsproperty 
findAndReplaceNoteContents:Boolean

If true, includes inline notes content when using Find/Change commands (in Galley and Story views only).


Implementation
    public function get findAndReplaceNoteContents():Boolean
    public function set findAndReplaceNoteContents(value:Boolean):void
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
noteBackgroundColorproperty 
noteBackgroundColor:NoteBackgrounds

The background color for notes.


Implementation
    public function get noteBackgroundColor():NoteBackgrounds
    public function set noteBackgroundColor(value:NoteBackgrounds):void
noteColorproperty 
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. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.


Implementation
    public function get noteColor():Object
    public function set noteColor(value:Object):void
noteColorChoicesproperty 
noteColorChoices:NoteColorChoices

The color to use for notes.


Implementation
    public function get noteColorChoices():NoteColorChoices
    public function set noteColorChoices(value:NoteColorChoices):void
parentproperty 
parent:Object  [read-only] [override]

The parent of the NotePreference (a Application).


Implementation
    public function get parent():Object
propertiesproperty 
properties:Object[override]

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
showNoteTipsproperty 
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.


Implementation
    public function get showNoteTips():Boolean
    public function set showNoteTips(value:Boolean):void
spellCheckNotesproperty 
spellCheckNotes:Boolean

If true, includes inline notes content when using Spell Check (in Galley and Story views only).


Implementation
    public function get spellCheckNotes():Boolean
    public function set spellCheckNotes(value:Boolean):void
Method Detail
addEventListenerNotePreference()method
public function addEventListenerNotePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

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)

Returns
EventListener
getElements()method 
override public function getElements():Object

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

Returns
Object
removeEventListenerNotePreference()method 
public function removeEventListenerNotePreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

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)

Returns
Boolean
toSpecifier()method 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String