| Package | lunas.components.textinputs |
| Class | public class CoreTextInput |
| Inheritance | CoreTextInput  CoreComponent Background CoreSprite flash.display.Sprite |
| Implements | TextInput |
| Subclasses | SimpleTextInput, VisualTextInput |
ITextInput interface, to minimize the effort required to implement this interface.
| Property | Defined By | ||
|---|---|---|---|
 | align : uint
The alignement of the background. | Background | |
| autoSize : Boolean
Indicates if the background is resizing when the stage resize event is invoked. | Background | |
| border : EdgeMetrics
Indicates the thickness, in pixels, of the four edge regions around a visual component. | CoreComponent | |
| bottomLeftRadius : Number
The radius of the bottom-left corner, in pixels. | Background | |
| bottomRightRadius : Number
The radius of the bottom-right corner, in pixels. | Background | |
| bubbles : Boolean = true
Indicates if the events use bubbling when are dispatched. | CoreComponent | |
| builder : Builder
Indicates the Builder reference of this instance. | CoreComponent | |
| componentInspectorSetting : Boolean
Initialize when the Flash component settings are initialized (only in Flash with a compiled component). | CoreComponent | |
| condenseWhite : Boolean
Specifies whether extra white space (spaces, line breaks, and so on) should be removed in a TextInput control with HTML text. | CoreTextInput | ||
| data : *
Indicates the data value object of the component. | CoreTextInput | ||
| defaultTextFormat : TextFormat
Specifies the format applied to newly inserted text, such as text entered by a user or text inserted with the replaceSelectedText() method. | CoreTextInput | ||
| direction : String
Indicates the direction value of the background when the display is in this "full" mode (default value is null). | Background | |
| displayAsPassword : Boolean
Indicates whether this control is used for entering passwords. | CoreTextInput | ||
| editable : Boolean
Indicates whether the user is allowed to edit the text in this control. | CoreTextInput | ||
| embedFonts : Boolean
Specifies whether to render by using embedded font outlines. | CoreTextInput | ||
| enabled : Boolean
Indicates the enabled state of the component. | CoreComponent | |
| fill : IFillStyle
Determinates the IFillStyle reference of this display. | Background | |
| gradientMatrix : Matrix
The matrix value to draw the gradient fill. | Background | |
| gradientRotation : Number = 0
The rotation value to draw the gradient fill. | Background | |
| gradientTranslation : Point
The translation vector to draw the gradient fill. | Background | |
| group : Boolean
Indicates with a boolean if this object is grouped. | CoreComponent | |
| groupName : String
Indicates the name of the group of this object. | CoreComponent | |
| h : Number
Determinates the virtual height value of this component. | Background | |
| horizontalScrollPosition : Number
Horizontal scroll position. | CoreTextInput | ||
| htmlText : String
Specifies the text displayed by the TextInput component, including HTML markup that expresses the styles of that text. | CoreTextInput | ||
| isFull : Boolean
Indicates if the background use full size (use Stage.stageWidth and Stage.stageHeight to resize the background). | Background | |
| layout : Layout
Determinates the layout of this container. | CoreComponent | |
| line : ILineStyle
Determinates the ILineStyle reference of this display. | Background | |
| logger : Logger
Determinates the internal ILogger reference of this Logable object. | CoreSprite | |
| maxChars : int
Maximum number of characters that users can enter in the text field. | CoreTextInput | ||
| maxHeight : Number
This property defined the maximum height of this display. | Background | |
| maxWidth : Number
Defines the maximum width of this display. | Background | |
| minHeight : Number
This property defined the mimimun height of this display (This value is >= 0). | Background | |
| minWidth : Number
This property defined the mimimun width of this display (This value is >= 0). | Background | |
| multiline : Boolean
Indicates whether the text field is a multiline text field. | CoreTextInput | ||
| restrict : String
Indicates the set of characters that a user can enter into the control. | CoreTextInput | ||
| selected : Boolean
A flag that indicates whether this control is selected. | CoreTextInput | ||
| style : Style
Returns the style of this component. | CoreComponent | |
| tabIndex : int [override]
Specifies the tab ordering of objects in a SWF file. | CoreTextInput | ||
| tabManager : TabManager
The tab manager of this component. | CoreTextInput | ||
| text : String
Plain text that appears in the component. | CoreTextInput | ||
| textField : TextField
The internal TextField that renders the text of this TextInput. | CoreTextInput | ||
| topLeftRadius : Number
The radius of the upper-left corner, in pixels. | Background | |
| topRightRadius : Number
The radius of the upper-right corner, in pixels. | Background | |
| useGradientBox : Boolean
Indicates if the IFillStyle of this display use gradient box matrix (only if the IFillStyle is a FillGradientStyle). | Background | |
| w : Number
Determinates the virtual height value of this component. | Background | |
| wordWrap : Boolean
A Boolean value that indicates whether the text field has word wrap. | CoreTextInput | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new CoreTextInput instance. | CoreTextInput | ||
| doLater():void
Launch an event with a delayed interval. | Background | |
| draw(... arguments):void
Draw the display. | Background | |
| getBuilderRenderer():Class
Returns the Builder constructor use to initialize this component. | CoreComponent | |
| getStyleRenderer():Class
Returns the Style constructor use to initialize this component. | CoreComponent | |
groupPolicyChanged():void [override]
Invoked when the group property or the groupName property changed. | CoreTextInput | ||
| hide():void
Hides the component. | CoreComponent | |
| initBackgroundPen(graphic:* = null):IPen
Init the pen to draw the background of this display. | Background | |
| initialize():void
Initialize the component. | CoreComponent | |
| isLocked():Boolean
Returns true if the object is locked. | CoreSprite | |
| isVisible():Boolean
Returns true if the component is visible. | CoreComponent | |
| lock():void [override]
Locks the object. | CoreComponent | |
maxHorizontalScrollPosition():Number
Maximum value of horizontalScrollPosition. | CoreTextInput | ||
| move(x:Number, y:Number):void
Moves the component. | CoreComponent | |
| notifyChanged():void
Notify a change in this component. | CoreComponent | |
| notifyEnabled():void
Notify an event when the enabled property is changed. | CoreComponent | |
| notifyResized():void
Notify an event when you resize the component. | Background | |
| refresh(init:*):void
Refresh and initialize the display with a generic object and invoke the "update" method. | Background | |
| registerView(scope:DisplayObjectContainer = null):void
Registers the view of this component. | CoreComponent | |
| resetLock():void
Reset the lock security of the display. | CoreSprite | |
| resize(e:Event = null):void
Resize and update the background. | Background | |
| scope():DisplayObject
Returns the real scope reference of this component. | CoreComponent | |
| setCornerRadius(n:Number):void
Defines all corner radius of the background (upper-left, upper-right, bottom-left and bottom-right). | Background | |
| setSize(w:Number, h:Number):void
Sets the virtual width (w) and height (h) values of the component. | Background | |
| setStyle(... args):void
Sets the style property on the style declaration or object. | CoreComponent | |
| show():void
Shows the component. | CoreComponent | |
| unlock():void [override]
Unlocks the display. | CoreComponent | |
| unregisterView():void
Unregisters the view of this component. | CoreComponent | |
| update():void [override]
Updates the component. | CoreComponent | |
| viewChanged():void
This method is invoked after the draw() method in the update() method. | Background | |
| viewDestroyed(e:Event = null):void
Invoked when the component is removed. | CoreComponent | |
| viewEnabled():void
Invoked when the enabled property of the component change. | Background | |
| viewResize():void
Invoked when the component is resized. | Background | |
| viewStyleChanged(e:Event = null):void
Invoked when the component Style changed. | CoreComponent | |
| Method | Defined By | ||
|---|---|---|---|
| addedToStage(e:Event = null):void
Invoked when the display is added to the stage. | CoreSprite | |
| addedToStageResize(e:Event = null):void
Invoked when the display is removed from the stage to enable the autoSize mode. | Background | |
| fireComponentEvent(type:String):void
Dispatchs a ComponentEvent with the specified type. | CoreComponent | |
focusIn(e:FocusEvent):void
Invoked when the focus is in in the component textfield. | CoreTextInput | ||
focusOut(e:FocusEvent):void
Invoked when the focus is out in the component textfield. | CoreTextInput | ||
keyDown(e:KeyboardEvent):void
Invoked when the component is focused and when a key is down. | CoreTextInput | ||
removedFromStage(e:Event = null):void [override]
Invoked when the display is removed from the stage. | CoreTextInput | ||
| removedFromStageResize(e:Event = null):void
Invoked when the display is removed from the stage to disable the autoSize mode. | Background | |
| renderLayout(layout:Layout = null):void
Receives a message when the layout emit when is rendered. | CoreComponent | |
| updateLayout(layout:Layout = null):void
Receives a message when the layout emit when is updated. | CoreComponent | |
viewEditableChanged():void
Called when the editable attributes are invoked. | CoreTextInput | ||
viewHTMLTextChanged():void
Called when the htmlText attributes are invoked. | CoreTextInput | ||
viewTextChanged():void
Called when the text attributes are invoked. | CoreTextInput | ||
| condenseWhite | property |
Hide Inherited Public Properties
Show Inherited Public PropertiescondenseWhite:BooleanSpecifies whether extra white space (spaces, line breaks, and so on) should be removed in a TextInput control with HTML text.
public function get condenseWhite():Boolean public function set condenseWhite(value:Boolean):void| data | property |
data:*Indicates the data value object of the component.
public function get data():* public function set data(value:any):void| defaultTextFormat | property |
defaultTextFormat:TextFormatSpecifies the format applied to newly inserted text, such as text entered by a user or text inserted with the replaceSelectedText() method.
public function get defaultTextFormat():TextFormat public function set defaultTextFormat(value:TextFormat):void| displayAsPassword | property |
displayAsPassword:BooleanIndicates whether this control is used for entering passwords.
public function get displayAsPassword():Boolean public function set displayAsPassword(value:Boolean):void| editable | property |
editable:BooleanIndicates whether the user is allowed to edit the text in this control.
public function get editable():Boolean public function set editable(value:Boolean):void| embedFonts | property |
embedFonts:BooleanSpecifies whether to render by using embedded font outlines.
public function get embedFonts():Boolean public function set embedFonts(value:Boolean):void| horizontalScrollPosition | property |
horizontalScrollPosition:NumberHorizontal scroll position.
public function get horizontalScrollPosition():Number public function set horizontalScrollPosition(value:Number):void| htmlText | property |
htmlText:StringSpecifies the text displayed by the TextInput component, including HTML markup that expresses the styles of that text.
public function get htmlText():String public function set htmlText(value:String):void| maxChars | property |
maxChars:intMaximum number of characters that users can enter in the text field.
public function get maxChars():int public function set maxChars(value:int):void| multiline | property |
multiline:BooleanIndicates whether the text field is a multiline text field. If the value is true, the text field is multiline; if the value is false, the text field is a single-line text field.
public function get multiline():Boolean public function set multiline(value:Boolean):void| restrict | property |
restrict:StringIndicates the set of characters that a user can enter into the control.
If the value of the restrict property is null, you can enter any character.
If the value of the restrict property is an empty string, you cannot enter any character.
This property only restricts user interaction; a script can put any text into the text field.
If the value of the restrict property is a string of characters, you may enter only characters in that string into the text field.
The default value is null.
public function get restrict():String public function set restrict(value:String):voidSee also
| selected | property |
selected:BooleanA flag that indicates whether this control is selected.
public function get selected():Boolean public function set selected(value:Boolean):void| tabIndex | property |
tabIndex:int[override] Specifies the tab ordering of objects in a SWF file.
public function get tabIndex():int public function set tabIndex(value:int):void| tabManager | property |
public var tabManager:TabManagerThe tab manager of this component.
| text | property |
text:StringPlain text that appears in the component.
public function get text():String public function set text(value:String):void| textField | property |
textField:TextFieldThe internal TextField that renders the text of this TextInput. Warning, if you use the setter of this virtual attribute the component is cleaned.
public function get textField():TextField public function set textField(value:TextField):void| wordWrap | property |
wordWrap:BooleanA Boolean value that indicates whether the text field has word wrap. If the value of wordWrap is true, the text field has word wrap; if the value is false, the text field does not have word wrap. The default value is false.
public function get wordWrap():Boolean public function set wordWrap(value:Boolean):void| CoreTextInput | () | Constructor |
public function CoreTextInput()Creates a new CoreTextInput instance.
| focusIn | () | method |
protected function focusIn(e:FocusEvent):voidInvoked when the focus is in in the component textfield.
Parameters
e:FocusEvent |
| focusOut | () | method |
protected function focusOut(e:FocusEvent):voidInvoked when the focus is out in the component textfield.
Parameters
e:FocusEvent |
| groupPolicyChanged | () | method |
override public function groupPolicyChanged():voidInvoked when the group property or the groupName property changed. Overrides this method in concrete class.
| keyDown | () | method |
protected function keyDown(e:KeyboardEvent):voidInvoked when the component is focused and when a key is down.
Parameters
e:KeyboardEvent |
| maxHorizontalScrollPosition | () | method |
public function maxHorizontalScrollPosition():NumberMaximum value of horizontalScrollPosition.
ReturnsNumber |
| removedFromStage | () | method |
override protected function removedFromStage(e:Event = null):voidInvoked when the display is removed from the stage.
Parameters
e:Event (default = null) |
| viewEditableChanged | () | method |
protected function viewEditableChanged():voidCalled when the editable attributes are invoked.
| viewHTMLTextChanged | () | method |
protected function viewHTMLTextChanged():voidCalled when the htmlText attributes are invoked.
| viewTextChanged | () | method |
protected function viewTextChanged():voidCalled when the text attributes are invoked.