Packageflexlib.controls.textClasses
Classpublic class StringBoundaries



Public Properties
 PropertyDefined by
  isVisible : Boolean
[read-only] Indicates whether or not the character range has visible characters.
StringBoundaries
  rectangles : Array
[read-only] Returns the bounding rectangles of the current character range.
StringBoundaries
Public Methods
 MethodDefined by
  
StringBoundaries(textField:TextField, startIndex:int, endIndex:int, xOffset:Number = 0, yOffset:Number = 0)
Finds the bounding rectangle of a character range within a TextField object.
StringBoundaries
Public Constants
 ConstantDefined by
  X_CORRECTION : Number = 1
TextField.getCharBoundaries seems to be consistently innaccurate by this amount in the x-axis.
StringBoundaries
  Y_CORRECTION : Number = 2
TextField.getCharBoundaries seems to be consistently innaccurate by this amount in the y-axis.
StringBoundaries
Property detail
isVisibleproperty
isVisible:Boolean  [read-only]

Indicates whether or not the character range has visible characters.

Implementation
    public function get isVisible():Boolean
rectanglesproperty 
rectangles:Array  [read-only]

Returns the bounding rectangles of the current character range.

Implementation
    public function get rectangles():Array
Constructor detail
StringBoundaries()constructor
public function StringBoundaries(textField:TextField, startIndex:int, endIndex:int, xOffset:Number = 0, yOffset:Number = 0)

Finds the bounding rectangle of a character range within a TextField object. If the character range spans multiple lines, bounding rectangles are calculated for each line.

Parameters
textField:TextField — The TextField the string is in.
 
startIndex:int — The start index of the character range.
 
endIndex:int — The end index of the character range.
 
xOffset:Number (default = 0) — The horizontal offset to apply to the boundary rectangle.
 
yOffset:Number (default = 0) — The vertical offset to apply to the bounding rectangle.
Constant detail
X_CORRECTIONconstant
public const X_CORRECTION:Number = 1

TextField.getCharBoundaries seems to be consistently innaccurate by this amount in the x-axis.

Y_CORRECTIONconstant 
public const Y_CORRECTION:Number = 2

TextField.getCharBoundaries seems to be consistently innaccurate by this amount in the y-axis.