Packagecom.yworks.canvas.input
Interfacepublic interface ITextEditor extends mx.core.IUIComponent

A common interface for text editor implementations that can be used by a TextEditorInputMode.

See also

com.yworks.canvas.input.TextEditorInputMode


Public Properties
 PropertyDefined By
  htmlText : String
A String containing HTML markup that is rendered by this editor
ITextEditor
  numLines : int
[read-only] The number of lines of the text that is rendered by this editor
ITextEditor
  text : String
The String that is rendered by this editor
ITextEditor
  textHeight : Number
[read-only] The height of the text that is rendered by this editor
ITextEditor
  textWidth : Number
[read-only] The width of the text that is rendered by this editor
ITextEditor
Public Methods
 MethodDefined By
  
clear():void
Clears the text of this instance.
ITextEditor
  
getLineMetrics(lineIndex:int):TextLineMetrics
Returns the line metrics of a line in the text that is rendered by this editor.
ITextEditor
Property Detail
htmlTextproperty
htmlText:String

A String containing HTML markup that is rendered by this editor


Implementation
    public function get htmlText():String
    public function set htmlText(value:String):void
numLinesproperty 
numLines:int  [read-only]

The number of lines of the text that is rendered by this editor


Implementation
    public function get numLines():int
textproperty 
text:String

The String that is rendered by this editor


Implementation
    public function get text():String
    public function set text(value:String):void
textHeightproperty 
textHeight:Number  [read-only]

The height of the text that is rendered by this editor


Implementation
    public function get textHeight():Number
textWidthproperty 
textWidth:Number  [read-only]

The width of the text that is rendered by this editor


Implementation
    public function get textWidth():Number
Method Detail
clear()method
public function clear():void

Clears the text of this instance.

getLineMetrics()method 
public function getLineMetrics(lineIndex:int):TextLineMetrics

Returns the line metrics of a line in the text that is rendered by this editor.

Parameters

lineIndex:int — The index of the queried line.

Returns
TextLineMetrics — The TextLineMetrics of the queried line.

See also

flash.text.TextLineMetrics