KoolMoves AS3 API Documentation | All Packages | All Classes | Index | Frames No Frames |
Class RichTextEditor

Package | km.components
Class | public class RichTextEditor
Inheritance | RichTextEditor UIComponent flash.display.Sprite

The RichTextEditor component class.
The minimum size of this component is 226 x 125 pixels.

Example

    import km.components.*;

    var rt:RichTextEditor = new RichTextEditor();
    rt.duotone = [0x402000,0xfff8f0];
    rt.setSize(300,140);
    rt.move(20,20);
    rt.defaultTextFormat = new TextFormat('_sans',14);
    rt.text = 'Enter your text';
    addChild(rt);

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined by
--- | --- | ---
|  | advancedEditFeature : int Gets or sets the advanced edit feature. 0 = none, 1 = link edit, 2 = find and replace | RichTextEditor
|  | allowFontSelection : Boolean [write-only] When set to false, font selection is not possible. | RichTextEditor
|  | backgroundAlpha : Number | RichTextEditor
|  | defaultTextFormat : TextFormat [write-only] | RichTextEditor
|  | duotone : Array The duotone property can be used to convert the colors of the component into duotone. | UIComponent
|  | embedFonts : Boolean [write-only] | RichTextEditor
|  | enabled : Boolean Specifies if the component is enabled. If a component is disabled, it will be turned into grayscale and become partly transparent. | UIComponent
|  | height : Number | UIComponent
|  | htmlText : String | RichTextEditor
|  | linkTarget : String = "_blank" The target used when a link is set. | RichTextEditor
|  | text : String | RichTextEditor
|  | toolTip : String Text to use as toolTip when ToolTip is enabled. | UIComponent
|  | width : Number | UIComponent
|  | x : Number | UIComponent
|  | y : Number | UIComponent

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined by
--- | --- | ---
|  | RichTextEditor() | RichTextEditor
|  | move(x:int, y:int, animationMode:int = 0, animationFrames:int = 12, easeInOut:Boolean = false):void Moves the component to the specified coordinates. | UIComponent
|  | setProperties(o:Object):void Sets a number of properties at once. | UIComponent
|  | setSize(w:int, h:int):void Sets the size width and height. | UIComponent
|  | setText(text:String, html:Boolean = true):void | RichTextEditor

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined by
--- | --- | --- | ---
|  | animationComplete | The animationComplete event is broadcasted when an animated move is completed. | UIComponent

Property detail

advancedEditFeature | property

`advancedEditFeature:int` [read-write]

Gets or sets the advanced edit feature.
0 = none, 1 = link edit, 2 = find and replace

Implementation
`public function get advancedEditFeature():int`
`public function set advancedEditFeature(value:int):void`

allowFontSelection | property |

`allowFontSelection:Boolean` [write-only]

When set to false, font selection is not possible.

Implementation
`public function set allowFontSelection(value:Boolean):void`

backgroundAlpha | property |

`backgroundAlpha:Number` [read-write]

Implementation
`public function get backgroundAlpha():Number`
`public function set backgroundAlpha(value:Number):void`

defaultTextFormat | property |

`defaultTextFormat:TextFormat` [write-only]

Implementation
`public function set defaultTextFormat(value:TextFormat):void`

embedFonts | property |

`embedFonts:Boolean` [write-only]

Implementation
`public function set embedFonts(value:Boolean):void`

htmlText | property |

`htmlText:String` [read-write]

Implementation
`public function get htmlText():String`
`public function set htmlText(value:String):void`

linkTarget | property |

`public var linkTarget:String = "_blank"`

The target used when a link is set.

text | property |

`text:String` [read-write]

Implementation
`public function get text():String`
`public function set text(value:String):void`
Constructor detail

RichTextEditor | () | constructor

`public function RichTextEditor()`
Method detail

setText | () | method

`public function setText(text:String, html:Boolean = true):void`

Parameters

| `text:String`
| `html:Boolean` (default = `true`)``

Last update : 04/05/2008