Packagecom.adobe.illustrator
Classpublic class TextFrames
InheritanceTextFrames Inheritance IllustratorHostObject Inheritance CSHostObject Inheritance flash.utils.Proxy

Since : CS5

A collection of text frame items



Public Properties
 PropertyDefined By
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  length : Number
[read-only] number of elements in the collection
TextFrames
 Inheritedparent : *
[read-only]
IllustratorHostObject
Public Methods
 MethodDefined By
  
create a point text frame item
TextFrames
  
areaText(textPath:PathItem, orientation:TextOrientation = null, baseFrame:TextFrame = null, postFix:Boolean = true):TextFrame
Create an area text frame item.
TextFrames
 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
  
getByName(nameParam:String):TextFrame
Get the first element in the collection with the provided name.
TextFrames
 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
 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
  
index(idx:Number):TextFrame
Get the element in the collection at the provided index.
TextFrames
 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
  
pathText(textPath:PathItem, startTValue:Number = 0.0, endTValue:Number = 0.0, orientation:TextOrientation = null, baseFrame:TextFrame = null, postFix:Boolean = true):TextFrame
Create an on-path text frame item.
TextFrames
  
pointText(anchor:Array, orientation:TextOrientation = null):TextFrame
Create a point text frame item.
TextFrames
  
removeAll():void
TextFrames
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
 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
  
nextNameIndex(idx:int):int
[override] Overriding this allows us to support for each...in
TextFrames
  
nextValue(index:int):*
[override] Overriding this allows us to support for each...in
TextFrames
Property Detail
lengthproperty
length:Number  [read-only]

Since : CS5

number of elements in the collection


Implementation
    public function get length():Number
Method Detail
add()method
public function add():TextFrame

Since : CS5

create a point text frame item

Returns
TextFrame
areaText()method 
public function areaText(textPath:PathItem, orientation:TextOrientation = null, baseFrame:TextFrame = null, postFix:Boolean = true):TextFrame

Since : CS5

Create an area text frame item.

Parameters

textPath:PathItem — (com.adobe.illustrator.PathItem) the path item associated with the text frame
 
orientation:TextOrientation (default = null) — (com.adobe.illustrator.TextOrientation) the orientation of the text ( default: TextOrientation.HORIZONTAL )
 
baseFrame:TextFrame (default = null) — (com.adobe.illustrator.TextFrame) the base text frame if it has one
 
postFix:Boolean (default = true) — (Boolean) whether to postfix/prefix the new text frame to the specified base text frame ( default: true )

Returns
TextFrame
getByName()method 
public function getByName(nameParam:String):TextFrame

Since : CS5

Get the first element in the collection with the provided name.

Parameters

nameParam:String

Returns
TextFrame
index()method 
public function index(idx:Number):TextFrame

Since : CS5

Get the element in the collection at the provided index.

Parameters

idx:Number

Returns
TextFrame
nextNameIndex()method 
override flash_proxy function nextNameIndex(idx:int):int

Since : CS5

Overriding this allows us to support for each...in

Parameters

idx:int

Returns
int
nextValue()method 
override flash_proxy function nextValue(index:int):*

Since : CS5

Overriding this allows us to support for each...in

Parameters

index:int

Returns
*
pathText()method 
public function pathText(textPath:PathItem, startTValue:Number = 0.0, endTValue:Number = 0.0, orientation:TextOrientation = null, baseFrame:TextFrame = null, postFix:Boolean = true):TextFrame

Since : CS5

Create an on-path text frame item.

Parameters

textPath:PathItem — (com.adobe.illustrator.PathItem) the path item associated with the text frame
 
startTValue:Number (default = 0.0) — (Number) the start position of text along a path, as a value relative to the path's segments (path text only) ( default: 0.0 )
 
endTValue:Number (default = 0.0) — (Number) the end position of text along a path, as a value relative to the path's segments (path text only) ( default: 0.0 )
 
orientation:TextOrientation (default = null) — (com.adobe.illustrator.TextOrientation) the orientation of the text ( default: TextOrientation.HORIZONTAL )
 
baseFrame:TextFrame (default = null) — (com.adobe.illustrator.TextFrame) the base text frame if it has one
 
postFix:Boolean (default = true) — (Boolean) whether to postfix/prefix the new text frame to the specified base text frame ( default: true )

Returns
TextFrame
pointText()method 
public function pointText(anchor:Array, orientation:TextOrientation = null):TextFrame

Since : CS5

Create a point text frame item.

Parameters

anchor:Array — (Array) the position (coordinates) of the anchor point
 
orientation:TextOrientation (default = null) — (com.adobe.illustrator.TextOrientation) the orientation of the text ( default: TextOrientation.HORIZONTAL )

Returns
TextFrame
removeAll()method 
public function removeAll():void

Since : CS5