flexlib :: library Documentation | All Packages | All Classes | Index | Frames No Frames |
PromptingTextArea

Package | flexlib.controls
Class | public class PromptingTextArea
Inheritance | PromptingTextArea mx.controls.TextArea

The <codeph>PromptingTextArea</codeph> component is a small enhancement to standard <codeph>TextArea</codeph>. It adds the ability to specify a prompt value that displays when the text is empty, similar to how the prompt property of the <codeph>ComboBox</codeph> behaves when there is no selected value.

Public Properties

| Property | Defined By
--- | --- | ---
|  | displayAsPassword : Boolean [override] | PromptingTextArea
|  | prompt : String The string to use as the prompt value | PromptingTextArea
|  | promptFormat : String A format string to specify how the prompt is displayed. | PromptingTextArea
|  | text : String [override] Override the behavior of text so that it doesn't take into account the prompt. | PromptingTextArea

Public Methods

| Method | Defined By
--- | --- | ---
|  | PromptingTextArea() Constructor | PromptingTextArea

Property Detail

displayAsPassword | property

`displayAsPassword:Boolean`[override]

Implementation
`public function get displayAsPassword():Boolean`
`public function set displayAsPassword(value:Boolean):void`

prompt | property |

`prompt:String`

The string to use as the prompt value

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

promptFormat | property |

`promptFormat:String`

A format string to specify how the prompt is displayed. This is typically an HTML string that can set the font color and style. Use <codeph>[prompt]</codeph> within the string as a replacement token that will be replaced with the actual prompt text. The default value is "<font color="#999999"><i>[prompt]</i></font>"

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

text | property |

`text:String`[override]

Override the behavior of text so that it doesn't take into account the prompt. If the prompt is displaying, the text is just an empty string.

This property can be used as the source for data binding.

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

PromptingTextArea | () | Constructor

`public function PromptingTextArea()`

Constructor

Mercredi Juillet 6 2011, 09:45 PM +02:00