Package | com.adobe.incopy |
Class | public class Note |
Inheritance | Note ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
characters : Characters [read-only]
A collection of characters. | Note | ||
collapsed : Boolean
If true, the note is collapsed in galley view. | Note | ||
creationDate : Date [read-only]
The date and time the note was created. | Note | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | Note | ||
events : Events [read-only]
A collection of events. | Note | ||
hiddenTexts : HiddenTexts [read-only]
A collection of hidden text objects. | Note | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [read-only]
The unique ID of the Note. | Note | ||
index : Number [read-only]
The index of the Note within its containing object. | Note | ||
insertionPoints : InsertionPoints [read-only]
A collection of insertion points. | Note | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | Note | ||
label : String
A property that can be set to any string. | Note | ||
lines : Lines [read-only]
A collection of lines. | Note | ||
modificationDate : Date [read-only]
The date and time the note was last modified. | Note | ||
name : String
The name of the Note; this is an alias to the Note's label property. | Note | ||
paragraphs : Paragraphs [read-only]
A collection of paragraphs. | Note | ||
parent : Object [read-only]
The parent of the Note (a XmlStory, Story, TextFrame, InsertionPoint or Cell). | Note | ||
properties : Object
A property that allows setting of several properties at the same time. | Note | ||
storyOffset : InsertionPoint [read-only]
The insertion point before the table in the story containing the table. | Note | ||
textColumns : TextColumns [read-only]
A collection of text columns. | Note | ||
texts : Texts [read-only]
A collection of text objects. | Note | ||
textStyleRanges : TextStyleRanges [read-only]
A collection of text style ranges. | Note | ||
textVariableInstances : TextVariableInstances [read-only]
A collection of text variable instances. | Note | ||
userName : String [read-only]
The user who made the note. | Note | ||
words : Words [read-only]
A collection of words. | Note |
Method | Defined By | ||
---|---|---|---|
addEventListenerNote(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Note | ||
convertToText():void
Converts the note to story text. | Note | ||
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key. | Note | ||
![]() | 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
Resolves the object specifier, creating an array of object references. | Note | ||
![]() | 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 | |
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key. | Note | ||
![]() | 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 | |
Moves the note to the specified location. | Note | ||
remove():void
Deletes the Note. | Note | ||
removeEventListenerNote(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Note | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String
Retrieves the object specifier. | Note | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
characters | property |
characters:Characters
[read-only] Since : | CS5 |
A collection of characters.
public function get characters():Characters
collapsed | property |
collapsed:Boolean
Since : | CS5 |
If true, the note is collapsed in galley view.
public function get collapsed():Boolean
public function set collapsed(value:Boolean):void
creationDate | property |
creationDate:Date
[read-only] Since : | CS5 |
The date and time the note was created.
public function get creationDate():Date
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
hiddenTexts | property |
hiddenTexts:HiddenTexts
[read-only] Since : | CS5 |
A collection of hidden text objects.
public function get hiddenTexts():HiddenTexts
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the Note.
public function get id():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the Note within its containing object.
public function get index():Number
insertionPoints | property |
insertionPoints:InsertionPoints
[read-only] Since : | CS5 |
A collection of insertion points.
public function get insertionPoints():InsertionPoints
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
label | property |
label:String
Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
lines | property |
lines:Lines
[read-only] Since : | CS5 |
A collection of lines.
public function get lines():Lines
modificationDate | property |
modificationDate:Date
[read-only] Since : | CS5 |
The date and time the note was last modified.
public function get modificationDate():Date
name | property |
name:String
Since : | CS5 |
The name of the Note; this is an alias to the Note's label property.
public function get name():String
public function set name(value:String):void
paragraphs | property |
paragraphs:Paragraphs
[read-only] Since : | CS5 |
A collection of paragraphs.
public function get paragraphs():Paragraphs
parent | property |
parent:Object
[read-only] Since : | CS5 |
The parent of the Note (a XmlStory, Story, TextFrame, InsertionPoint or Cell).
public function get parent():Object
properties | property |
properties:Object
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
storyOffset | property |
storyOffset:InsertionPoint
[read-only] Since : | CS5 |
The insertion point before the table in the story containing the table.
public function get storyOffset():InsertionPoint
textColumns | property |
textColumns:TextColumns
[read-only] Since : | CS5 |
A collection of text columns.
public function get textColumns():TextColumns
texts | property |
texts:Texts
[read-only] Since : | CS5 |
A collection of text objects.
public function get texts():Texts
textStyleRanges | property |
textStyleRanges:TextStyleRanges
[read-only] Since : | CS5 |
A collection of text style ranges.
public function get textStyleRanges():TextStyleRanges
textVariableInstances | property |
textVariableInstances:TextVariableInstances
[read-only] Since : | CS5 |
A collection of text variable instances.
public function get textVariableInstances():TextVariableInstances
userName | property |
userName:String
[read-only] Since : | CS5 |
The user who made the note.
public function get userName():String
words | property |
words:Words
[read-only] Since : | CS5 |
A collection of words.
public function get words():Words
addEventListenerNote | () | method |
public function addEventListenerNote(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 |
convertToText | () | method |
public function convertToText():void
Since : | CS5 |
Converts the note to story text.
extractLabel | () | method |
public function extractLabel(keyParam:String = null):String
Since : | CS5 |
Gets the label value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
|
String |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
insertLabel | () | method |
public function insertLabel(keyParam:String = null, valueParam:String = null):void
Since : | CS5 |
Sets the label to the value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
| |
valueParam:String (default = null ) — (String) The value.
|
move | () | method |
public function move(toParam:LocationOptions = null, referenceParam:Object = null):Note
Since : | CS5 |
Moves the note to the specified location.
Parameters
toParam:LocationOptions (default = null ) — (LocationOptions) The new location relative to the reference object or within the containing object.
| |
referenceParam:Object (default = null ) — (Object) The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text or Story. (Optional)
|
Note |
remove | () | method |
public function remove():void
Since : | CS5 |
Deletes the Note.
removeEventListenerNote | () | method |
public function removeEventListenerNote(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 |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |