Packagecom.adobe.linguistics.spelling.framework.ui
Classpublic class TLFHighlighter
InheritanceTLFHighlighter Inheritance Object
Implements IHighlighter

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

This class facilitates drawing of squiggly lines below words for TLF TextFlow class.

The TextFlow class is responsible for managing all the text content of a story. In TextLayout, text is stored in a hierarchical tree of elements. TextFlow is the root object of the element tree. All elements on the tree derive from the base class, FlowElement.

TLFHighlighter could be used for drawing squiggly lines in any of the custom visual components(probably based on Sprite) which make use of TextFlow to display text.



Public Properties
 PropertyDefined By
  offsetPoint : Point
Get offset point information for scrollable controls.
TLFHighlighter
Public Methods
 MethodDefined By
  
TLFHighlighter(textFlow:TextFlow)
The constructor for TLFHighlighter.
TLFHighlighter
  
Clear all squiggly lines in the component.
TLFHighlighter
  
drawSquiggleAt(token:Token):void
Draw squiggly lines below a given token.
TLFHighlighter
Property Detail
offsetPointproperty
offsetPoint:Point

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

Get offset point information for scrollable controls. This is used by the highlighter to move the squiggly lines as the text scrolls inside the control.


Implementation
    public function get offsetPoint():Point
    public function set offsetPoint(value:Point):void
Constructor Detail
TLFHighlighter()Constructor
public function TLFHighlighter(textFlow:TextFlow)

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

The constructor for TLFHighlighter.

Parameters
textFlow:TextFlowTextFlow in which to enable highlighting.
Method Detail
clearSquiggles()method
public function clearSquiggles():void

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

Clear all squiggly lines in the component.

drawSquiggleAt()method 
public function drawSquiggleAt(token:Token):void

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

Draw squiggly lines below a given token.

Parameters

token:TokenToken information of the word to be highlighted.