Package | com.adobe.illustrator |
Class | public class TextFrame |
Inheritance | TextFrame ![]() ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
anchor : Array
The position of the anchor point (start of base line for point text)
| TextFrame | ||
antialias : TextAntialias
the type of a text anti-aliasing on text frame item
| TextFrame | ||
![]() | artworkKnockout : KnockoutState
Is the artwork used to create a knockout. | PageItem | |
![]() | blendingMode : BlendModes
The mode used when compositing an object. | PageItem | |
characters : Characters [read-only]
All the characters in this text range. | TextFrame | ||
columnCount : Number
The column count in the text frame (area text only)
| TextFrame | ||
columnGutter : Number
The column gutter in the text frame (area text only)
| TextFrame | ||
contents : String
The text contents of this text frame. | TextFrame | ||
contentVariable : Object
The content variable bound to this text art item. | TextFrame | ||
![]() | controlBounds : Array [read-only]
The bounds of the artwork including stroke width and controls. | PageItem | |
![]() | editable : Boolean [read-only]
Can the art item be modified. | PageItem | |
endTValue : Number
The end position of text along a path, as a value relative to the path's segments (path text only)
| TextFrame | ||
flowLinksHorizontally : Boolean
Flow text between linked frame horizontally first. | TextFrame | ||
![]() | geometricBounds : Array [read-only]
The bounds of the artwork excluding stroke width. | PageItem | |
![]() | height : Number
The height of the art item. | PageItem | |
![]() | hidden : Boolean
Is this artwork item hidden?
| PageItem | |
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
insertionPoints : InsertionPoints [read-only]
All the insertion points in this text range. | TextFrame | ||
![]() | isIsolated : Boolean
Is the artwork isolated. | PageItem | |
kind : TextType [read-only]
The type of a text frame item. | TextFrame | ||
![]() | layer : Layer [read-only]
The layer to which this artwork belongs. | PageItem | |
![]() | left : Number
The left position of the art item. | PageItem | |
lines : Lines [read-only]
All the lines in this text range. | TextFrame | ||
![]() | locked : Boolean
Is this artwork item locked?
| PageItem | |
matrix : Matrix [read-only]
The transformation matrix of the text frame object. | TextFrame | ||
![]() | name : String
The item's name. | PageItem | |
nextFrame : TextFrame
The linked text frame following this one. | TextFrame | ||
![]() | note : String
The note assigned to this artwork item. | PageItem | |
![]() | opacity : Number
The object's opacity (between 0.0 and 100.0) ( 0.0 - 100.0 )
| PageItem | |
opticalAlignment : Boolean
Is the optical alignment active?
| TextFrame | ||
orientation : TextOrientation
The orientation of the text in the frame. | TextFrame | ||
paragraphs : Paragraphs [read-only]
All the paragraphs in this text range. | TextFrame | ||
![]() | parent : * [read-only] | IllustratorHostObject | |
![]() | pixelAligned : Boolean
is this artwork item aligned to Pixel Grid?
| PageItem | |
![]() | position : Array
The position of the top left corner of the art item. | PageItem | |
previousFrame : TextFrame
The linked text frame preceding this one. | TextFrame | ||
rowCount : Number
The row count in the text frame (area text only)
| TextFrame | ||
rowGutter : Number
The row gutter in the text frame (area text only)
| TextFrame | ||
![]() | selected : Boolean
Is this artwork item selected?
| PageItem | |
![]() | sliced : Boolean
Is the art item sliced (default: false)
| PageItem | |
spacing : Number
The amount of spacing (path text only)
| TextFrame | ||
startTValue : Number
The start position of text along a path, as a value relative to the path's segments (path text only)
| TextFrame | ||
story : Story [read-only]
The story of the text frame. | TextFrame | ||
![]() | tags : Tags [read-only]
The collection of tags associated with this page item. | PageItem | |
textPath : TextPath [read-only]
The path for the text frame (area and path text)
| TextFrame | ||
textRange : TextRange [read-only]
The text range of the text frame. | TextFrame | ||
textRanges : TextRanges [read-only]
All the text in this text range. | TextFrame | ||
textSelection : Object [read-only]
The selected text (ranges) in the story. | TextFrame | ||
![]() | top : Number
The top position of the art item. | PageItem | |
![]() | uRL : String
The value of the Adobe URL tag assigned to this artwork item. | PageItem | |
![]() | visibilityVariable : Object
The visibility variable bound to this page item. | PageItem | |
![]() | visibleBounds : Array [read-only]
The visible bounds of the artwork including stroke width. | PageItem | |
![]() | width : Number
The width of the art item. | PageItem | |
words : Words [read-only]
All the words in this text range. | TextFrame | ||
![]() | wrapInside : Boolean
Should the text frame object be wrapped inside this object?
| PageItem | |
![]() | wrapOffset : Number
Use this offset when wrapping text around this object. | PageItem | |
![]() | wrapped : Boolean
Wrap text frame objects around this object (text frame must be above the object)
| PageItem | |
![]() | zOrderPosition : Number [read-only]
The drawing order of the art within it's group or layer. | PageItem |
Method | Defined By | ||
---|---|---|---|
![]() | bringInPerspective(positionX:Number, positionY:Number, perspectiveGridPlane:PerspectiveGridPlaneType = null):void
Place art object(s)in perspective grid at spedified perspective plane and coordinate
| PageItem | |
Convert text item to path items. | TextFrame | ||
![]() |
create a duplicate of the object
| PageItem | |
![]() | 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 | |
![]() | 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 | |
![]() | 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 | |
![]() | move(relativeObject:Object, insertionLocation:ElementPlacement):void
move the object
| PageItem | |
![]() | remove():void
delete the object
| PageItem | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
![]() | resize(scaleX:Number, scaleY:Number, changePositions:Boolean = true, changeFillPatterns:Boolean = true, changeFillGradients:Boolean = true, changeStrokePattern:Boolean = true, changeLineWidths:Number = 100.0, scaleAbout:Transformation = null):void
Scale art object(s)
| PageItem | |
![]() | rotate(angle:Number, changePositions:Boolean = true, changeFillPatterns:Boolean = true, changeFillGradients:Boolean = true, changeStrokePattern:Boolean = true, rotateAbout:Transformation = null):void
Rotate art object(s)
| PageItem | |
![]() | transform(transformationMatrix:Matrix, changePositions:Boolean = true, changeFillPatterns:Boolean = true, changeFillGradients:Boolean = true, changeStrokePattern:Boolean = true, changeLineWidths:Number = 100.0, transformAbout:Transformation = null):void
Transform art object(s) using a transformation matrix. | PageItem | |
![]() | translate(deltaX:Number = 0.0, deltaY:Number = 0.0, transformObjects:Boolean = true, transformFillPatterns:Boolean = true, transformFillGradients:Boolean = true, transformStrokePattern:Boolean = true):void
Reposition art object(s)
| PageItem | |
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject | |
![]() | zOrder(zOrderCmd:ZOrderMethod):void
Arranges the art relative to other art in the group or layer. | PageItem |
anchor | property |
anchor:Array
Since : | CS5 |
The position of the anchor point (start of base line for point text)
public function get anchor():Array
public function set anchor(value:Array):void
antialias | property |
antialias:TextAntialias
Since : | CS5.5 |
the type of a text anti-aliasing on text frame item
public function get antialias():TextAntialias
public function set antialias(value:TextAntialias):void
characters | property |
characters:Characters
[read-only] Since : | CS5 |
All the characters in this text range.
public function get characters():Characters
columnCount | property |
columnCount:Number
Since : | CS5 |
The column count in the text frame (area text only)
public function get columnCount():Number
public function set columnCount(value:Number):void
columnGutter | property |
columnGutter:Number
Since : | CS5 |
The column gutter in the text frame (area text only)
public function get columnGutter():Number
public function set columnGutter(value:Number):void
contents | property |
contents:String
Since : | CS5 |
The text contents of this text frame.
public function get contents():String
public function set contents(value:String):void
contentVariable | property |
contentVariable:Object
Since : | CS5 |
The content variable bound to this text art item.
public function get contentVariable():Object
public function set contentVariable(value:Object):void
endTValue | property |
endTValue:Number
Since : | CS5 |
The end position of text along a path, as a value relative to the path's segments (path text only)
public function get endTValue():Number
public function set endTValue(value:Number):void
flowLinksHorizontally | property |
flowLinksHorizontally:Boolean
Since : | CS5 |
Flow text between linked frame horizontally first. (area text only)
public function get flowLinksHorizontally():Boolean
public function set flowLinksHorizontally(value:Boolean):void
insertionPoints | property |
insertionPoints:InsertionPoints
[read-only] Since : | CS5 |
All the insertion points in this text range.
public function get insertionPoints():InsertionPoints
kind | property |
kind:TextType
[read-only] Since : | CS5 |
The type of a text frame item.
public function get kind():TextType
lines | property |
lines:Lines
[read-only] Since : | CS5 |
All the lines in this text range.
public function get lines():Lines
matrix | property |
matrix:Matrix
[read-only] Since : | CS5 |
The transformation matrix of the text frame object.
public function get matrix():Matrix
nextFrame | property |
nextFrame:TextFrame
Since : | CS5 |
The linked text frame following this one.
public function get nextFrame():TextFrame
public function set nextFrame(value:TextFrame):void
opticalAlignment | property |
opticalAlignment:Boolean
Since : | CS5 |
Is the optical alignment active?
public function get opticalAlignment():Boolean
public function set opticalAlignment(value:Boolean):void
orientation | property |
orientation:TextOrientation
Since : | CS5 |
The orientation of the text in the frame.
public function get orientation():TextOrientation
public function set orientation(value:TextOrientation):void
paragraphs | property |
paragraphs:Paragraphs
[read-only] Since : | CS5 |
All the paragraphs in this text range.
public function get paragraphs():Paragraphs
previousFrame | property |
previousFrame:TextFrame
Since : | CS5 |
The linked text frame preceding this one.
public function get previousFrame():TextFrame
public function set previousFrame(value:TextFrame):void
rowCount | property |
rowCount:Number
Since : | CS5 |
The row count in the text frame (area text only)
public function get rowCount():Number
public function set rowCount(value:Number):void
rowGutter | property |
rowGutter:Number
Since : | CS5 |
The row gutter in the text frame (area text only)
public function get rowGutter():Number
public function set rowGutter(value:Number):void
spacing | property |
spacing:Number
Since : | CS5 |
The amount of spacing (path text only)
public function get spacing():Number
public function set spacing(value:Number):void
startTValue | property |
startTValue:Number
Since : | CS5 |
The start position of text along a path, as a value relative to the path's segments (path text only)
public function get startTValue():Number
public function set startTValue(value:Number):void
story | property |
story:Story
[read-only] Since : | CS5 |
The story of the text frame.
public function get story():Story
textPath | property |
textPath:TextPath
[read-only] Since : | CS5 |
The path for the text frame (area and path text)
public function get textPath():TextPath
textRange | property |
textRange:TextRange
[read-only] Since : | CS5 |
The text range of the text frame.
public function get textRange():TextRange
textRanges | property |
textRanges:TextRanges
[read-only] Since : | CS5 |
All the text in this text range.
public function get textRanges():TextRanges
textSelection | property |
textSelection:Object
[read-only] Since : | CS5 |
The selected text (ranges) in the story.
public function get textSelection():Object
words | property |
words:Words
[read-only] Since : | CS5 |
All the words in this text range.
public function get words():Words
createOutline | () | method |
public function createOutline():GroupItem
Since : | CS5 |
Convert text item to path items.
ReturnsGroupItem |