Packagecom.adobe.photoshop
Classpublic class TextItem
InheritanceTextItem Inheritance PhotoshopHostObject Inheritance CSHostObject Inheritance flash.utils.Proxy

The text object contained in an art layer.



Public Properties
 PropertyDefined By
  alternateLigatures : Boolean
If true, alternate ligatures are used.
TextItem
  antiAliasMethod : AntiAlias
The method of anti-aliasing to use.
TextItem
  autoKerning : AutoKernType
Options for auto kerning.
TextItem
  autoLeadingAmount : Number
The percentage to use for auto leading.
TextItem
  baselineShift : String
The amount of baseline offset of text.
TextItem
  capitalization : TextCase
The case of the text.
TextItem
  color : SolidColor
The text color.
TextItem
  contents : String
The actual text in the layer.
TextItem
  desiredGlyphScaling : Number
The desired amount (as a percentage) to scale the horizontal size of the text letters.
TextItem
  desiredLetterScaling : Number
The amount of space (as a percentage) between letters.
TextItem
  desiredWordScaling : Number
The amount (as a percentage) of space between words.
TextItem
  direction : Direction
The text orientation.
TextItem
  fauxBold : Boolean
If true, faux bold is used.
TextItem
  fauxItalic : Boolean
If true, faux italic is used.
TextItem
  firstLineIndent : String
The amount to indent the first line of paragraphs.
TextItem
  font : String
The text face of the character.
TextItem
  hangingPuntuation : Boolean
If true, uses Roman hanging punctuation.
TextItem
  height : String
The height of the bounding box for paragraph text.
TextItem
  horizontalScale : Number
Character scaling (horizontal) in proportion to horizontal scale.
TextItem
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  hyphenateAfterFirst : Number
The number of letters after which hyphenation in word wrap is allowed.
TextItem
  hyphenateBeforeLast : Number
The number of letters before which hyphenation in word wrap is allowed.
TextItem
  hyphenateCapitalWords : Boolean
If true, capitalized words can be hyphenated.
TextItem
  hyphenateWordsLongerThan : Number
The minimum number of letters a word must have in order for hyphenation in word wrap to be allowed.
TextItem
  hyphenation : Boolean
If true, hyphenation is used.
TextItem
  hyphenationZone : String
The distance at the end of a line that will cause a word to break in unjustified type.
TextItem
  hyphenLimit : Number
The maximum number of consecutive lines that can end with a hyphenated word.
TextItem
  justification : Justification
The paragraph justification.
TextItem
  kind : TextType
The type of text.
TextItem
  language : Language
The language.
TextItem
  leading : String
The leading amount.
TextItem
  leftIndent : String
The amount to indent text from the left.
TextItem
  ligatures : Boolean
If true, ligatures are used.
TextItem
  maximumGlyphScaling : Number
The maximum amount (as a percentage) to scale the horizontal size of the text letters.
TextItem
  maximumLetterScaling : Number
The maximum amount (as a percentage) of space between letters.
TextItem
  maximumWordScaling : Number
The maximum amount (as a percentage) of space between words (0 -1000; at 100, no additional space is added between words).
TextItem
  minimumGlyphScaling : Number
The minimum amount (as a percentage) to scale the horizontal size of the text letters.
TextItem
  minimumLetterScaling : Number
The minimum amount of space (as a percentage) between letters.
TextItem
  minimumWordScaling : Number
The minimum amount (as a percentage) of space between words.
TextItem
  noBreak : Boolean
If true, words are not allowed to break at the end of a line.
TextItem
  oldStyle : Boolean
If true, old style is used.
TextItem
 Inheritedparent : *
[read-only]
PhotoshopHostObject
  position : Array
The position of the origin for the text.
TextItem
  rightIndent : String
The amount to indent text from the right.
TextItem
  size : String
The font size.
TextItem
  spaceAfter : String
The amount of space after each paragraph.
TextItem
  spaceBefore : String
The amount of space before each paragraph.
TextItem
  strikeThru : StrikeThruType
The strike through option to use.
TextItem
  textComposer : TextComposer
The text composing engine to use.
TextItem
  tracking : Number
The amount of uniform spacing between multiple characters.
TextItem
  underline : UnderlineType
Options for underlining the text.
TextItem
  useAutoLeading : Boolean
If true, uses the font's built-in leading information.
TextItem
  verticalScale : Number
Character scaling (vertical) in proportion to horizontal scale.
TextItem
  warpBend : Number
The warp bend percentage.
TextItem
  warpDirection : Direction
The warp direction.
TextItem
  warpHorizontalDistortion : Number
The warp horizontal distortion percentage.
TextItem
  warpStyle : WarpStyle
The style of warp.
TextItem
  warpVerticalDistortion : Number
The warp vertical distortion percentage.
TextItem
  width : String
The width of the bounding box for paragraph text.
TextItem
Public Methods
 MethodDefined By
  
Converts the text object and its containing layer to a fill layer with the text changed to a clipping path.
TextItem
  
createPath():void
Creates a clipping path from the outlines of the actual text items (such as letters or words).
TextItem
 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
 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
 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
 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
Property Detail
alternateLigaturesproperty
alternateLigatures:Boolean

If true, alternate ligatures are used.


Implementation
    public function get alternateLigatures():Boolean
    public function set alternateLigatures(value:Boolean):void
antiAliasMethodproperty 
antiAliasMethod:AntiAlias

The method of anti-aliasing to use.


Implementation
    public function get antiAliasMethod():AntiAlias
    public function set antiAliasMethod(value:AntiAlias):void
autoKerningproperty 
autoKerning:AutoKernType

Options for auto kerning.


Implementation
    public function get autoKerning():AutoKernType
    public function set autoKerning(value:AutoKernType):void
autoLeadingAmountproperty 
autoLeadingAmount:Number

The percentage to use for auto leading. Range: 0.01 to 5000.00.


Implementation
    public function get autoLeadingAmount():Number
    public function set autoLeadingAmount(value:Number):void
baselineShiftproperty 
baselineShift:String

The amount of baseline offset of text.


Implementation
    public function get baselineShift():String
    public function set baselineShift(value:String):void
capitalizationproperty 
capitalization:TextCase

The case of the text.


Implementation
    public function get capitalization():TextCase
    public function set capitalization(value:TextCase):void
colorproperty 
color:SolidColor

The text color.


Implementation
    public function get color():SolidColor
    public function set color(value:SolidColor):void
contentsproperty 
contents:String

The actual text in the layer.


Implementation
    public function get contents():String
    public function set contents(value:String):void
desiredGlyphScalingproperty 
desiredGlyphScaling:Number

The desired amount (as a percentage) to scale the horizontal size of the text letters. Range: 50 - 200; at 100, the width of characters is not scaled. Valid only for justified text.


Implementation
    public function get desiredGlyphScaling():Number
    public function set desiredGlyphScaling(value:Number):void
desiredLetterScalingproperty 
desiredLetterScaling:Number

The amount of space (as a percentage) between letters. Range: 100 - 500; at 0, no space is added between letters. Valid only for justified text.


Implementation
    public function get desiredLetterScaling():Number
    public function set desiredLetterScaling(value:Number):void
desiredWordScalingproperty 
desiredWordScaling:Number

The amount (as a percentage) of space between words. Range: 0 -1000; at 100, no additional space is added between words. Valid only for justified text.


Implementation
    public function get desiredWordScaling():Number
    public function set desiredWordScaling(value:Number):void
directionproperty 
direction:Direction

The text orientation.


Implementation
    public function get direction():Direction
    public function set direction(value:Direction):void
fauxBoldproperty 
fauxBold:Boolean

If true, faux bold is used.


Implementation
    public function get fauxBold():Boolean
    public function set fauxBold(value:Boolean):void
fauxItalicproperty 
fauxItalic:Boolean

If true, faux italic is used.


Implementation
    public function get fauxItalic():Boolean
    public function set fauxItalic(value:Boolean):void
firstLineIndentproperty 
firstLineIndent:String

The amount to indent the first line of paragraphs. Range: -1296 to 1296.


Implementation
    public function get firstLineIndent():String
    public function set firstLineIndent(value:String):void
fontproperty 
font:String

The text face of the character.


Implementation
    public function get font():String
    public function set font(value:String):void
hangingPuntuationproperty 
hangingPuntuation:Boolean

If true, uses Roman hanging punctuation.


Implementation
    public function get hangingPuntuation():Boolean
    public function set hangingPuntuation(value:Boolean):void
heightproperty 
height:String

The height of the bounding box for paragraph text.


Implementation
    public function get height():String
    public function set height(value:String):void
horizontalScaleproperty 
horizontalScale:Number

Character scaling (horizontal) in proportion to horizontal scale. Range: 0 - 1000 as a percentage.


Implementation
    public function get horizontalScale():Number
    public function set horizontalScale(value:Number):void
hyphenateAfterFirstproperty 
hyphenateAfterFirst:Number

The number of letters after which hyphenation in word wrap is allowed. Range: 1 to 15.


Implementation
    public function get hyphenateAfterFirst():Number
    public function set hyphenateAfterFirst(value:Number):void
hyphenateBeforeLastproperty 
hyphenateBeforeLast:Number

The number of letters before which hyphenation in word wrap is allowed. Range: 1 to 15.


Implementation
    public function get hyphenateBeforeLast():Number
    public function set hyphenateBeforeLast(value:Number):void
hyphenateCapitalWordsproperty 
hyphenateCapitalWords:Boolean

If true, capitalized words can be hyphenated.


Implementation
    public function get hyphenateCapitalWords():Boolean
    public function set hyphenateCapitalWords(value:Boolean):void
hyphenateWordsLongerThanproperty 
hyphenateWordsLongerThan:Number

The minimum number of letters a word must have in order for hyphenation in word wrap to be allowed. Range: 2 to 25. ( minimum 0 )


Implementation
    public function get hyphenateWordsLongerThan():Number
    public function set hyphenateWordsLongerThan(value:Number):void
hyphenationproperty 
hyphenation:Boolean

If true, hyphenation is used.


Implementation
    public function get hyphenation():Boolean
    public function set hyphenation(value:Boolean):void
hyphenationZoneproperty 
hyphenationZone:String

The distance at the end of a line that will cause a word to break in unjustified type. Range: 0 - 720 picas.


Implementation
    public function get hyphenationZone():String
    public function set hyphenationZone(value:String):void
hyphenLimitproperty 
hyphenLimit:Number

The maximum number of consecutive lines that can end with a hyphenated word.


Implementation
    public function get hyphenLimit():Number
    public function set hyphenLimit(value:Number):void
justificationproperty 
justification:Justification

The paragraph justification.


Implementation
    public function get justification():Justification
    public function set justification(value:Justification):void
kindproperty 
kind:TextType

The type of text.


Implementation
    public function get kind():TextType
    public function set kind(value:TextType):void
languageproperty 
language:Language

The language.


Implementation
    public function get language():Language
    public function set language(value:Language):void
leadingproperty 
leading:String

The leading amount.


Implementation
    public function get leading():String
    public function set leading(value:String):void
leftIndentproperty 
leftIndent:String

The amount to indent text from the left. Range: -1296 to 1296.


Implementation
    public function get leftIndent():String
    public function set leftIndent(value:String):void
ligaturesproperty 
ligatures:Boolean

If true, ligatures are used.


Implementation
    public function get ligatures():Boolean
    public function set ligatures(value:Boolean):void
maximumGlyphScalingproperty 
maximumGlyphScaling:Number

The maximum amount (as a percentage) to scale the horizontal size of the text letters. Range: 50 - 200; at 100, the width of characters is not scaled. Valid only for justified text.


Implementation
    public function get maximumGlyphScaling():Number
    public function set maximumGlyphScaling(value:Number):void
maximumLetterScalingproperty 
maximumLetterScaling:Number

The maximum amount (as a percentage) of space between letters. Range: 100 - 500; at 0, no space is added between letters. Valid only for justified text.


Implementation
    public function get maximumLetterScaling():Number
    public function set maximumLetterScaling(value:Number):void
maximumWordScalingproperty 
maximumWordScaling:Number

The maximum amount (as a percentage) of space between words (0 -1000; at 100, no additional space is added between words). Valid only for justified text.


Implementation
    public function get maximumWordScaling():Number
    public function set maximumWordScaling(value:Number):void
minimumGlyphScalingproperty 
minimumGlyphScaling:Number

The minimum amount (as a percentage) to scale the horizontal size of the text letters. Range: 50 - 200; at 100, the width of characters is not scaled. Valid only for justified text.


Implementation
    public function get minimumGlyphScaling():Number
    public function set minimumGlyphScaling(value:Number):void
minimumLetterScalingproperty 
minimumLetterScaling:Number

The minimum amount of space (as a percentage) between letters. Range: 100 to 500; at 0, no space is added between letters. Valid only for justified text.


Implementation
    public function get minimumLetterScaling():Number
    public function set minimumLetterScaling(value:Number):void
minimumWordScalingproperty 
minimumWordScaling:Number

The minimum amount (as a percentage) of space between words. Range: 0 -1000; at 100, no additional space is added between words. Valid only for justified text.


Implementation
    public function get minimumWordScaling():Number
    public function set minimumWordScaling(value:Number):void
noBreakproperty 
noBreak:Boolean

If true, words are not allowed to break at the end of a line. When enacted on large amounts of consecutive characters, can prevent word wrap and thus may prevent some text from appearing on the screen.


Implementation
    public function get noBreak():Boolean
    public function set noBreak(value:Boolean):void
oldStyleproperty 
oldStyle:Boolean

If true, old style is used.


Implementation
    public function get oldStyle():Boolean
    public function set oldStyle(value:Boolean):void
positionproperty 
position:Array

The position of the origin for the text. The array must contain two values. Setting this property is basically equivalent to clicking the text tool at a point in the document to create the point of origin for text.


Implementation
    public function get position():Array
    public function set position(value:Array):void
rightIndentproperty 
rightIndent:String

The amount to indent text from the right. Range: -1296 to 1296.


Implementation
    public function get rightIndent():String
    public function set rightIndent(value:String):void
sizeproperty 
size:String

The font size.


Implementation
    public function get size():String
    public function set size(value:String):void
spaceAfterproperty 
spaceAfter:String

The amount of space after each paragraph. Range: -1296 to 1296.


Implementation
    public function get spaceAfter():String
    public function set spaceAfter(value:String):void
spaceBeforeproperty 
spaceBefore:String

The amount of space before each paragraph. Range: -1296 to 1296.


Implementation
    public function get spaceBefore():String
    public function set spaceBefore(value:String):void
strikeThruproperty 
strikeThru:StrikeThruType

The strike through option to use.


Implementation
    public function get strikeThru():StrikeThruType
    public function set strikeThru(value:StrikeThruType):void
textComposerproperty 
textComposer:TextComposer

The text composing engine to use.


Implementation
    public function get textComposer():TextComposer
    public function set textComposer(value:TextComposer):void
trackingproperty 
tracking:Number

The amount of uniform spacing between multiple characters. Range: -1000 to 10000.


Implementation
    public function get tracking():Number
    public function set tracking(value:Number):void
underlineproperty 
underline:UnderlineType

Options for underlining the text.


Implementation
    public function get underline():UnderlineType
    public function set underline(value:UnderlineType):void
useAutoLeadingproperty 
useAutoLeading:Boolean

If true, uses the font's built-in leading information.


Implementation
    public function get useAutoLeading():Boolean
    public function set useAutoLeading(value:Boolean):void
verticalScaleproperty 
verticalScale:Number

Character scaling (vertical) in proportion to horizontal scale. Range: 0 - 1000 as a percentage.


Implementation
    public function get verticalScale():Number
    public function set verticalScale(value:Number):void
warpBendproperty 
warpBend:Number

The warp bend percentage. Range: -100 to 100.


Implementation
    public function get warpBend():Number
    public function set warpBend(value:Number):void
warpDirectionproperty 
warpDirection:Direction

The warp direction.


Implementation
    public function get warpDirection():Direction
    public function set warpDirection(value:Direction):void
warpHorizontalDistortionproperty 
warpHorizontalDistortion:Number

The warp horizontal distortion percentage. Range: -100 to 100.


Implementation
    public function get warpHorizontalDistortion():Number
    public function set warpHorizontalDistortion(value:Number):void
warpStyleproperty 
warpStyle:WarpStyle

The style of warp.


Implementation
    public function get warpStyle():WarpStyle
    public function set warpStyle(value:WarpStyle):void
warpVerticalDistortionproperty 
warpVerticalDistortion:Number

The warp vertical distortion percentage. Range: -100 to 100.


Implementation
    public function get warpVerticalDistortion():Number
    public function set warpVerticalDistortion(value:Number):void
widthproperty 
width:String

The width of the bounding box for paragraph text.


Implementation
    public function get width():String
    public function set width(value:String):void
Method Detail
convertToShape()method
public function convertToShape():void

Converts the text object and its containing layer to a fill layer with the text changed to a clipping path.

createPath()method 
public function createPath():void

Creates a clipping path from the outlines of the actual text items (such as letters or words).