Packagecom.adobe.indesign
Classpublic class TextPath
InheritanceTextPath Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined 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
 InheritedhostObjectDelegate : 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
Public Methods
 MethodDefined 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
 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
  
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
 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
Resolves the object specifier, creating an array of object references.
TextPath
 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
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
TextPath
 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
  
remove():void
Deletes the TextPath.
TextPath
  
removeEventListenerTextPath(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
TextPath
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
TextPath
 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
AFTER_PLACEproperty
AFTER_PLACE:String  [read-only]

Dispatched after a TextPath is placed. This event bubbles. This event is not cancelable.


Implementation
    public static function get AFTER_PLACE():String
BEFORE_PLACEproperty 
BEFORE_PLACE:String  [read-only]

Dispatched before a TextPath is placed. This event bubbles. This event is cancelable.


Implementation
    public static function get BEFORE_PLACE():String
centerBracketproperty 
centerBracket:Number  [read-only]

The halfway point between the start bracket and the end bracket.


Implementation
    public function get centerBracket():Number
charactersproperty 
characters:Characters  [read-only]

A collection of characters.


Implementation
    public function get characters():Characters
contentsproperty 
contents:Object

The contents of the text frame. Can return: String, TextFrameContents enumerator or SpecialCharacters enumerator.


Implementation
    public function get contents():Object
    public function set contents(value:Object):void
endBracketproperty 
endBracket:Number

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.


Implementation
    public function get endBracket():Number
    public function set endBracket(value:Number):void
endTextFrameproperty 
endTextFrame:Object  [read-only]

The last text frame in the thread. Can return: TextFrame or TextPath.


Implementation
    public function get endTextFrame():Object
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


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

A collection of events.


Implementation
    public function get events():Events
flipPathEffectproperty 
flipPathEffect:FlipValues

The flip effect applied to the type on a path.


Implementation
    public function get flipPathEffect():FlipValues
    public function set flipPathEffect(value:FlipValues):void
idproperty 
id:Number  [read-only]

The unique ID of the TextPath.


Implementation
    public function get id():Number
indexproperty 
index:Number  [read-only]

The index of the TextPath within its containing object.


Implementation
    public function get index():Number
insertionPointsproperty 
insertionPoints:InsertionPoints  [read-only]

A collection of insertion points.


Implementation
    public function get insertionPoints():InsertionPoints
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
linesproperty 
lines:Lines  [read-only]

A collection of lines.


Implementation
    public function get lines():Lines
nameproperty 
name:String

The name of the TextPath; this is an alias to the TextPath's label property.


Implementation
    public function get name():String
    public function set name(value:String):void
nextTextFrameproperty 
nextTextFrame:Object

The next text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.


Implementation
    public function get nextTextFrame():Object
    public function set nextTextFrame(value:Object):void
overflowsproperty 
overflows:Boolean  [read-only]

If true, the story has overset text.


Implementation
    public function get overflows():Boolean
paragraphsproperty 
paragraphs:Paragraphs  [read-only]

A collection of paragraphs.


Implementation
    public function get paragraphs():Paragraphs
parentproperty 
parent:Object  [read-only]

The parent of the TextPath (a SplineItem, Polygon, GraphicLine, Rectangle, Oval, TextFrame or EPSText).


Implementation
    public function get parent():Object
parentStoryproperty 
parentStory:Story  [read-only]

The story that contains the text.


Implementation
    public function get parentStory():Story
pathAlignmentproperty 
pathAlignment:PathTypeAlignments

The alignment of the type on a path.


Implementation
    public function get pathAlignment():PathTypeAlignments
    public function set pathAlignment(value:PathTypeAlignments):void
pathEffectproperty 
pathEffect:TextPathEffects

The effect applied to the type on a path.


Implementation
    public function get pathEffect():TextPathEffects
    public function set pathEffect(value:TextPathEffects):void
pathSpacingproperty 
pathSpacing:Number

The spacing applied to the type on a path.


Implementation
    public function get pathSpacing():Number
    public function set pathSpacing(value:Number):void
previousTextFrameproperty 
previousTextFrame:Object

The previous text frame in the thread. Can return: TextFrame or TextPath. Can also accept: NothingEnum enumerator.


Implementation
    public function get previousTextFrame():Object
    public function set previousTextFrame(value:Object):void
propertiesproperty 
properties:Object

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
startBracketproperty 
startBracket:Number

The location of the start of the type on the path, expressed in points. Note: 0 is the first point on the path.


Implementation
    public function get startBracket():Number
    public function set startBracket(value:Number):void
startTextFrameproperty 
startTextFrame:Object  [read-only]

The first text frame in the thread. Can return: TextFrame or TextPath.


Implementation
    public function get startTextFrame():Object
textAlignmentproperty 
textAlignment:TextTypeAlignments

The alignment applied to the type on a path.


Implementation
    public function get textAlignment():TextTypeAlignments
    public function set textAlignment(value:TextTypeAlignments):void
textColumnsproperty 
textColumns:TextColumns  [read-only]

A collection of text columns.


Implementation
    public function get textColumns():TextColumns
textFrameIndexproperty 
textFrameIndex:Number  [read-only]

The index of the text frame within the story.


Implementation
    public function get textFrameIndex():Number
textsproperty 
texts:Texts  [read-only]

A collection of text objects.


Implementation
    public function get texts():Texts
textStyleRangesproperty 
textStyleRanges:TextStyleRanges  [read-only]

A collection of text style ranges.


Implementation
    public function get textStyleRanges():TextStyleRanges
wordsproperty 
words:Words  [read-only]

A collection of words.


Implementation
    public function get words():Words
Method Detail
addEventListenerTextPath()method
public function addEventListenerTextPath(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
changeGlyph()method 
public function changeGlyph(reverseOrderParam:Boolean):Object

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)

Returns
Object
changeGrep()method 
public function changeGrep(reverseOrderParam:Boolean):Object

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)

Returns
Object
changeText()method 
public function changeText(reverseOrderParam:Boolean):Object

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)

Returns
Object
changeTransliterate()method 
public function changeTransliterate(reverseOrderParam:Boolean):Object

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)

Returns
Object
extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
findGlyph()method 
public function findGlyph(reverseOrderParam:Boolean):Object

Finds glyphs that match the find what value.

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
findGrep()method 
public function findGrep(reverseOrderParam:Boolean):Object

Finds text that matches the find what value.

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
findText()method 
public function findText(reverseOrderParam:Boolean):Object

Finds text that matches the find what value.

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

Returns
Object
findTransliterate()method 
public function findTransliterate(reverseOrderParam:Boolean):Object

Finds text that matches the find character type value.

Parameters

reverseOrderParam:Boolean (default = NaN) — (Boolean) If true, returns the results in reverse order. (Optional)

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

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

Returns
Object
insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

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

Deletes the TextPath.

removeEventListenerTextPath()method 
public function removeEventListenerTextPath(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 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String