Package | com.adobe.photoshop |
Class | public class TextItem |
Inheritance | TextItem ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined 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 : Object
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 : Object
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 : Object
The height of the bounding box for paragraph text. | TextItem | ||
horizontalScale : Number
Character scaling (horizontal) in proportion to horizontal scale. | TextItem | ||
![]() | hostObjectDelegate : 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 : Object
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 : Object
The leading amount. | TextItem | ||
leftIndent : Object
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 | ||
![]() | parent : * [read-only] | PhotoshopHostObject | |
position : Array
The position of the origin for the text. | TextItem | ||
rightIndent : Object
The amount to indent text from the right. | TextItem | ||
size : Object
The font size. | TextItem | ||
spaceAfter : Object
The amount of space after each paragraph. | TextItem | ||
spaceBefore : Object
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 : Object
The width of the bounding box for paragraph text. | TextItem |
Method | Defined By | ||
---|---|---|---|
convertToShape():void
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 | ||
![]() | 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 | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
alternateLigatures | property |
alternateLigatures:Boolean
Since : | CS5 |
If true, alternate ligatures are used.
public function get alternateLigatures():Boolean
public function set alternateLigatures(value:Boolean):void
antiAliasMethod | property |
antiAliasMethod:AntiAlias
Since : | CS5 |
The method of anti-aliasing to use.
public function get antiAliasMethod():AntiAlias
public function set antiAliasMethod(value:AntiAlias):void
autoKerning | property |
autoKerning:AutoKernType
Since : | CS5 |
Options for auto kerning.
public function get autoKerning():AutoKernType
public function set autoKerning(value:AutoKernType):void
autoLeadingAmount | property |
autoLeadingAmount:Number
Since : | CS5 |
The percentage to use for auto leading. Range: 0.01 to 5000.00.
public function get autoLeadingAmount():Number
public function set autoLeadingAmount(value:Number):void
baselineShift | property |
baselineShift:Object
Since : | CS5 |
The amount of baseline offset of text.
public function get baselineShift():Object
public function set baselineShift(value:Object):void
capitalization | property |
capitalization:TextCase
Since : | CS5 |
The case of the text.
public function get capitalization():TextCase
public function set capitalization(value:TextCase):void
color | property |
color:SolidColor
Since : | CS5 |
The text color.
public function get color():SolidColor
public function set color(value:SolidColor):void
contents | property |
contents:String
Since : | CS5 |
The actual text in the layer.
public function get contents():String
public function set contents(value:String):void
desiredGlyphScaling | property |
desiredGlyphScaling:Number
Since : | CS5 |
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.
public function get desiredGlyphScaling():Number
public function set desiredGlyphScaling(value:Number):void
desiredLetterScaling | property |
desiredLetterScaling:Number
Since : | CS5 |
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.
public function get desiredLetterScaling():Number
public function set desiredLetterScaling(value:Number):void
desiredWordScaling | property |
desiredWordScaling:Number
Since : | CS5 |
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.
public function get desiredWordScaling():Number
public function set desiredWordScaling(value:Number):void
direction | property |
direction:Direction
Since : | CS5 |
The text orientation.
public function get direction():Direction
public function set direction(value:Direction):void
fauxBold | property |
fauxBold:Boolean
Since : | CS5 |
If true, faux bold is used.
public function get fauxBold():Boolean
public function set fauxBold(value:Boolean):void
fauxItalic | property |
fauxItalic:Boolean
Since : | CS5 |
If true, faux italic is used.
public function get fauxItalic():Boolean
public function set fauxItalic(value:Boolean):void
firstLineIndent | property |
firstLineIndent:Object
Since : | CS5 |
The amount to indent the first line of paragraphs. Range: -1296 to 1296.
public function get firstLineIndent():Object
public function set firstLineIndent(value:Object):void
font | property |
font:String
Since : | CS5 |
The text face of the character.
public function get font():String
public function set font(value:String):void
hangingPuntuation | property |
hangingPuntuation:Boolean
Since : | CS5 |
If true, uses Roman hanging punctuation.
public function get hangingPuntuation():Boolean
public function set hangingPuntuation(value:Boolean):void
height | property |
height:Object
Since : | CS5 |
The height of the bounding box for paragraph text.
public function get height():Object
public function set height(value:Object):void
horizontalScale | property |
horizontalScale:Number
Since : | CS5 |
Character scaling (horizontal) in proportion to horizontal scale. Range: 0 - 1000 as a percentage.
public function get horizontalScale():Number
public function set horizontalScale(value:Number):void
hyphenateAfterFirst | property |
hyphenateAfterFirst:Number
Since : | CS5 |
The number of letters after which hyphenation in word wrap is allowed. Range: 1 to 15.
public function get hyphenateAfterFirst():Number
public function set hyphenateAfterFirst(value:Number):void
hyphenateBeforeLast | property |
hyphenateBeforeLast:Number
Since : | CS5 |
The number of letters before which hyphenation in word wrap is allowed. Range: 1 to 15.
public function get hyphenateBeforeLast():Number
public function set hyphenateBeforeLast(value:Number):void
hyphenateCapitalWords | property |
hyphenateCapitalWords:Boolean
Since : | CS5 |
If true, capitalized words can be hyphenated.
public function get hyphenateCapitalWords():Boolean
public function set hyphenateCapitalWords(value:Boolean):void
hyphenateWordsLongerThan | property |
hyphenateWordsLongerThan:Number
Since : | CS5 |
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 )
public function get hyphenateWordsLongerThan():Number
public function set hyphenateWordsLongerThan(value:Number):void
hyphenation | property |
hyphenation:Boolean
Since : | CS5 |
If true, hyphenation is used.
public function get hyphenation():Boolean
public function set hyphenation(value:Boolean):void
hyphenationZone | property |
hyphenationZone:Object
Since : | CS5 |
The distance at the end of a line that will cause a word to break in unjustified type. Range: 0 - 720 picas.
public function get hyphenationZone():Object
public function set hyphenationZone(value:Object):void
hyphenLimit | property |
hyphenLimit:Number
Since : | CS5 |
The maximum number of consecutive lines that can end with a hyphenated word.
public function get hyphenLimit():Number
public function set hyphenLimit(value:Number):void
justification | property |
justification:Justification
Since : | CS5 |
The paragraph justification.
public function get justification():Justification
public function set justification(value:Justification):void
kind | property |
kind:TextType
Since : | CS5 |
The type of text.
public function get kind():TextType
public function set kind(value:TextType):void
language | property |
language:Language
Since : | CS5 |
The language.
public function get language():Language
public function set language(value:Language):void
leading | property |
leading:Object
Since : | CS5 |
The leading amount.
public function get leading():Object
public function set leading(value:Object):void
leftIndent | property |
leftIndent:Object
Since : | CS5 |
The amount to indent text from the left. Range: -1296 to 1296.
public function get leftIndent():Object
public function set leftIndent(value:Object):void
ligatures | property |
ligatures:Boolean
Since : | CS5 |
If true, ligatures are used.
public function get ligatures():Boolean
public function set ligatures(value:Boolean):void
maximumGlyphScaling | property |
maximumGlyphScaling:Number
Since : | CS5 |
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.
public function get maximumGlyphScaling():Number
public function set maximumGlyphScaling(value:Number):void
maximumLetterScaling | property |
maximumLetterScaling:Number
Since : | CS5 |
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.
public function get maximumLetterScaling():Number
public function set maximumLetterScaling(value:Number):void
maximumWordScaling | property |
maximumWordScaling:Number
Since : | CS5 |
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.
public function get maximumWordScaling():Number
public function set maximumWordScaling(value:Number):void
minimumGlyphScaling | property |
minimumGlyphScaling:Number
Since : | CS5 |
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.
public function get minimumGlyphScaling():Number
public function set minimumGlyphScaling(value:Number):void
minimumLetterScaling | property |
minimumLetterScaling:Number
Since : | CS5 |
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.
public function get minimumLetterScaling():Number
public function set minimumLetterScaling(value:Number):void
minimumWordScaling | property |
minimumWordScaling:Number
Since : | CS5 |
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.
public function get minimumWordScaling():Number
public function set minimumWordScaling(value:Number):void
noBreak | property |
noBreak:Boolean
Since : | CS5 |
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.
public function get noBreak():Boolean
public function set noBreak(value:Boolean):void
oldStyle | property |
oldStyle:Boolean
Since : | CS5 |
If true, old style is used.
public function get oldStyle():Boolean
public function set oldStyle(value:Boolean):void
position | property |
position:Array
Since : | CS5 |
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.
public function get position():Array
public function set position(value:Array):void
rightIndent | property |
rightIndent:Object
Since : | CS5 |
The amount to indent text from the right. Range: -1296 to 1296.
public function get rightIndent():Object
public function set rightIndent(value:Object):void
size | property |
size:Object
Since : | CS5 |
The font size.
public function get size():Object
public function set size(value:Object):void
spaceAfter | property |
spaceAfter:Object
Since : | CS5 |
The amount of space after each paragraph. Range: -1296 to 1296.
public function get spaceAfter():Object
public function set spaceAfter(value:Object):void
spaceBefore | property |
spaceBefore:Object
Since : | CS5 |
The amount of space before each paragraph. Range: -1296 to 1296.
public function get spaceBefore():Object
public function set spaceBefore(value:Object):void
strikeThru | property |
strikeThru:StrikeThruType
Since : | CS5 |
The strike through option to use.
public function get strikeThru():StrikeThruType
public function set strikeThru(value:StrikeThruType):void
textComposer | property |
textComposer:TextComposer
Since : | CS5 |
The text composing engine to use.
public function get textComposer():TextComposer
public function set textComposer(value:TextComposer):void
tracking | property |
tracking:Number
Since : | CS5 |
The amount of uniform spacing between multiple characters. Range: -1000 to 10000.
public function get tracking():Number
public function set tracking(value:Number):void
underline | property |
underline:UnderlineType
Since : | CS5 |
Options for underlining the text.
public function get underline():UnderlineType
public function set underline(value:UnderlineType):void
useAutoLeading | property |
useAutoLeading:Boolean
Since : | CS5 |
If true, uses the font's built-in leading information.
public function get useAutoLeading():Boolean
public function set useAutoLeading(value:Boolean):void
verticalScale | property |
verticalScale:Number
Since : | CS5 |
Character scaling (vertical) in proportion to horizontal scale. Range: 0 - 1000 as a percentage.
public function get verticalScale():Number
public function set verticalScale(value:Number):void
warpBend | property |
warpBend:Number
Since : | CS5 |
The warp bend percentage. Range: -100 to 100.
public function get warpBend():Number
public function set warpBend(value:Number):void
warpDirection | property |
warpDirection:Direction
Since : | CS5 |
The warp direction.
public function get warpDirection():Direction
public function set warpDirection(value:Direction):void
warpHorizontalDistortion | property |
warpHorizontalDistortion:Number
Since : | CS5 |
The warp horizontal distortion percentage. Range: -100 to 100.
public function get warpHorizontalDistortion():Number
public function set warpHorizontalDistortion(value:Number):void
warpStyle | property |
warpStyle:WarpStyle
Since : | CS5 |
The style of warp.
public function get warpStyle():WarpStyle
public function set warpStyle(value:WarpStyle):void
warpVerticalDistortion | property |
warpVerticalDistortion:Number
Since : | CS5 |
The warp vertical distortion percentage. Range: -100 to 100.
public function get warpVerticalDistortion():Number
public function set warpVerticalDistortion(value:Number):void
width | property |
width:Object
Since : | CS5 |
The width of the bounding box for paragraph text.
public function get width():Object
public function set width(value:Object):void
convertToShape | () | method |
public function convertToShape():void
Since : | CS5 |
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
Since : | CS5 |
Creates a clipping path from the outlines of the actual text items (such as letters or words).