Package | com.adobe.indesign |
Class | public class TextPath |
Inheritance | TextPath ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
AFTER_PLACE : String [static] [read-only]
Dispatched after a TextPath is placed. | TextPath | ||
BEFORE_PLACE : String [static] [read-only]
Dispatched before a TextPath is placed. | TextPath | ||
centerBracket : Number [read-only]
The halfway point between the start bracket and the end bracket. | TextPath | ||
characters : Characters [read-only]
A collection of characters. | TextPath | ||
contents : Object
The contents of the text frame. | TextPath | ||
endBracket : Number
The end of the type on a path. | TextPath | ||
endTextFrame : Object [read-only]
The last text frame in the thread. | TextPath | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | TextPath | ||
events : Events [read-only]
A collection of events. | TextPath | ||
flipPathEffect : FlipValues
The flip effect applied to the type on a path. | TextPath | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [read-only]
The unique ID of the TextPath. | TextPath | ||
index : Number [read-only]
The index of the TextPath within its containing object. | TextPath | ||
insertionPoints : InsertionPoints [read-only]
A collection of insertion points. | TextPath | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | TextPath | ||
label : String
A property that can be set to any string. | TextPath | ||
lines : Lines [read-only]
A collection of lines. | TextPath | ||
name : String
The name of the TextPath; this is an alias to the TextPath's label property. | TextPath | ||
nextTextFrame : Object
The next text frame in the thread. | TextPath | ||
overflows : Boolean [read-only]
If true, the story has overset text. | TextPath | ||
paragraphs : Paragraphs [read-only]
A collection of paragraphs. | TextPath | ||
parent : Object [read-only]
The parent of the TextPath (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, TextFrame or EPSText). | TextPath | ||
parentStory : Story [read-only]
The story that contains the text. | TextPath | ||
pathAlignment : PathTypeAlignments
The alignment of the type on a path. | TextPath | ||
pathEffect : TextPathEffects
The effect applied to the type on a path. | TextPath | ||
pathSpacing : Number
The spacing applied to the type on a path. | TextPath | ||
previousTextFrame : Object
The previous text frame in the thread. | TextPath | ||
properties : Object
A property that allows setting of several properties at the same time. | TextPath | ||
startBracket : Number
The location of the start of the type on the path, expressed in points. | TextPath | ||
startTextFrame : Object [read-only]
The first text frame in the thread. | TextPath | ||
textAlignment : TextTypeAlignments
The alignment applied to the type on a path. | TextPath | ||
textColumns : TextColumns [read-only]
A collection of text columns. | TextPath | ||
textFrameIndex : Number [read-only]
The index of the text frame within the story. | TextPath | ||
texts : Texts [read-only]
A collection of text objects. | TextPath | ||
textStyleRanges : TextStyleRanges [read-only]
A collection of text style ranges. | TextPath | ||
words : Words [read-only]
A collection of words. | TextPath |
Method | Defined By | ||
---|---|---|---|
addEventListenerTextPath(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | TextPath | ||
changeGlyph(reverseOrderParam:Boolean):Object
Finds glyphs that match the find what value and replaces the glyphs with the change to value. | TextPath | ||
changeGrep(reverseOrderParam:Boolean):Object
Finds text that matches the find what value and replaces the text with the change to value. | TextPath | ||
changeText(reverseOrderParam:Boolean):Object
Finds text that matches the find what value and replaces the text with the change to value. | TextPath | ||
changeTransliterate(reverseOrderParam:Boolean):Object
Finds text that matches the find character type value and replaces the text with the change character type value. | TextPath | ||
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key. | TextPath | ||
![]() | 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 | |
findGlyph(reverseOrderParam:Boolean):Object
Finds glyphs that match the find what value. | TextPath | ||
findGrep(reverseOrderParam:Boolean):Object
Finds text that matches the find what value. | TextPath | ||
findText(reverseOrderParam:Boolean):Object
Finds text that matches the find what value. | TextPath | ||
findTransliterate(reverseOrderParam:Boolean):Object
Finds text that matches the find character type value. | TextPath | ||
![]() | 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. | TextPath | ||
![]() | 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. | TextPath | ||
![]() | 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 | |
remove():void
Deletes the TextPath. | TextPath | ||
removeEventListenerTextPath(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | TextPath | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String
Retrieves the object specifier. | TextPath | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
AFTER_PLACE | property |
AFTER_PLACE:String
[read-only] Since : | CS5 |
Dispatched after a TextPath is placed. This event bubbles. This event is not cancelable.
public static function get AFTER_PLACE():String
BEFORE_PLACE | property |
BEFORE_PLACE:String
[read-only] Since : | CS5 |
Dispatched before a TextPath is placed. This event bubbles. This event is cancelable.
public static function get BEFORE_PLACE():String
centerBracket | property |
centerBracket:Number
[read-only] Since : | CS5 |
The halfway point between the start bracket and the end bracket.
public function get centerBracket():Number
characters | property |
characters:Characters
[read-only] Since : | CS5 |
A collection of characters.
public function get characters():Characters
contents | property |
contents:Object
Since : | CS5 |
The contents of the text frame. Can return: String, TextFrameContents enumerator or SpecialCharacters enumerator.
public function get contents():Object
public function set contents(value:Object):void
endBracket | property |
endBracket:Number
Since : | CS5 |
The end of the type on a path. Note: Additional text becomes overset text unless the text is linked to another path or text frame.
public function get endBracket():Number
public function set endBracket(value:Number):void
endTextFrame | property |
endTextFrame:Object
[read-only] Since : | CS5 |
The last text frame in the thread. Can return: TextFrame or TextPath.
public function get endTextFrame():Object
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
flipPathEffect | property |
flipPathEffect:FlipValues
Since : | CS5 |
The flip effect applied to the type on a path.
public function get flipPathEffect():FlipValues
public function set flipPathEffect(value:FlipValues):void
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the TextPath.
public function get id():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the TextPath 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
name | property |
name:String
Since : | CS5 |
The name of the TextPath; this is an alias to the TextPath's label property.
public function get name():String
public function set name(value:String):void
nextTextFrame | property |
nextTextFrame:Object
Since : | CS5 |
The next text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.
public function get nextTextFrame():Object
public function set nextTextFrame(value:Object):void
overflows | property |
overflows:Boolean
[read-only] Since : | CS5 |
If true, the story has overset text.
public function get overflows():Boolean
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 TextPath (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, TextFrame or EPSText).
public function get parent():Object
parentStory | property |
parentStory:Story
[read-only] Since : | CS5 |
The story that contains the text.
public function get parentStory():Story
pathAlignment | property |
pathAlignment:PathTypeAlignments
Since : | CS5 |
The alignment of the type on a path.
public function get pathAlignment():PathTypeAlignments
public function set pathAlignment(value:PathTypeAlignments):void
pathEffect | property |
pathEffect:TextPathEffects
Since : | CS5 |
The effect applied to the type on a path.
public function get pathEffect():TextPathEffects
public function set pathEffect(value:TextPathEffects):void
pathSpacing | property |
pathSpacing:Number
Since : | CS5 |
The spacing applied to the type on a path.
public function get pathSpacing():Number
public function set pathSpacing(value:Number):void
previousTextFrame | property |
previousTextFrame:Object
Since : | CS5 |
The previous text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.
public function get previousTextFrame():Object
public function set previousTextFrame(value:Object):void
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
startBracket | property |
startBracket:Number
Since : | CS5 |
The location of the start of the type on the path, expressed in points. Note: 0 is the first point on the path.
public function get startBracket():Number
public function set startBracket(value:Number):void
startTextFrame | property |
startTextFrame:Object
[read-only] Since : | CS5 |
The first text frame in the thread. Can return: TextFrame or TextPath.
public function get startTextFrame():Object
textAlignment | property |
textAlignment:TextTypeAlignments
Since : | CS5 |
The alignment applied to the type on a path.
public function get textAlignment():TextTypeAlignments
public function set textAlignment(value:TextTypeAlignments):void
textColumns | property |
textColumns:TextColumns
[read-only] Since : | CS5 |
A collection of text columns.
public function get textColumns():TextColumns
textFrameIndex | property |
textFrameIndex:Number
[read-only] Since : | CS5 |
The index of the text frame within the story.
public function get textFrameIndex():Number
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
words | property |
words:Words
[read-only] Since : | CS5 |
A collection of words.
public function get words():Words
addEventListenerTextPath | () | method |
public function addEventListenerTextPath(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 |
changeGlyph | () | method |
public function changeGlyph(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds glyphs that match the find what value and replaces the glyphs with the change to value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
changeGrep | () | method |
public function changeGrep(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find what value and replaces the text with the change to value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
changeText | () | method |
public function changeText(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find what value and replaces the text with the change to value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
changeTransliterate | () | method |
public function changeTransliterate(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find character type value and replaces the text with the change character type value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
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 |
findGlyph | () | method |
public function findGlyph(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds glyphs that match the find what value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
findGrep | () | method |
public function findGrep(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find what value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
findText | () | method |
public function findText(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find what value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
findTransliterate | () | method |
public function findTransliterate(reverseOrderParam:Boolean):Object
Since : | CS5 |
Finds text that matches the find character type value.
Parameters
reverseOrderParam:Boolean (default = NaN ) — (Boolean) If true, returns the results in reverse order. (Optional)
|
Object |
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.
|
remove | () | method |
public function remove():void
Since : | CS5 |
Deletes the TextPath.
removeEventListenerTextPath | () | method |
public function removeEventListenerTextPath(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 |