TextInput class

Inheritance MovieClip > UIObject class > UIComponent class > TextInput

ActionScript Class Name mx.controls.TextInput

The properties of the TextInput class let you set the text content, formatting, and horizontal position at runtime. You can also indicate whether the field is editable, and whether it is a "password" field. You can also restrict the characters that a user can enter.

Setting a property of the TextInput class with ActionScript overrides the parameter of the same name set in the Property inspector or Component inspector.

The TextInput component uses the Focus Manager to override the default Flash Player focus rectangle and draw a custom focus rectangle with rounded corners. For more information, see FocusManager class.

The TextInput component supports CSS styles and any additional HTML styles supported by Flash Player. For information about CSS support, see the W3C specification at www.w3.org/TR/REC-CSS2/.

You can manipulate the text string by using the string returned by the text object.

Each component class has a version property, which is a class property. Class properties are available only on the class itself. The version property returns a string that indicates the version of the component. To access this property, use the following code:

trace(mx.controls.TextInput.version);

NOTE

The code trace(myTextInputInstance.version); returns undefined.

Method summary for the TextInput class

There are no methods exclusive to the TextInput class.

Methods inherited from the UIObject class

The following table lists the methods the TextInput class inherits from the UIObject class. When calling these methods from the TextInput object, use the form TextInputInstance.methodName.

Method	Description
UIObject.createClassObject()	Creates an object on the specified class.
UIObject.createObject()	Creates a subobject on an object.
UIObject.destroyObject()	Destroys a component instance.
UIObject.doLater()	Calls a function when parameters have been set in the Property and Component inspectors.
UIObject.getStyle()	Gets the style property from the style declaration or object.
UIObject.invalidate()	Marks the object so it is redrawn on the next frame interval.
UIObject.move()	Moves the object to the requested position.
UIObject.redraw()	Forces validation of the object so it is drawn in the current frame.
UIObject.setSize()	Resizes the object to the requested size.
UIObject.setSkin()	Sets a skin in the object.
UIObject.setStyle()	Sets the style property on the style declaration or object.

Methods inherited from the UIComponent class

The following table lists the methods the TextInput class inherits from the UIComponent class. When calling these methods from the TextInput object, use the form TextInputInstance.methodName.

Method	Description
UIComponent.getFocus()	Returns a reference to the object that has focus.
UIComponent.setFocus()	Sets focus to the component instance.

Property summary for the TextInput class

The following table lists properties of the TextInput class.

Property	Description
TextInput.editable	A Boolean value indicating whether the field is editable (`true`) or not (`false`).
TextInput.hPosition	The horizontal scrolling position of the text in the field.
TextInput.length	Read-only; the number of characters in a TextInput component.
TextInput.maxChars	The maximum number of characters that a user can enter in the text field.
TextInput.maxHPosition	Read-only; the maximum possible value for `TextField.hPosition`.
TextInput.password	A Boolean value that indicates whether the text field is a password field that hides the entered characters.
TextInput.restrict	Indicates which characters a user can enter in a text field.
TextInput.text	Sets the text content of a TextInput component.

Properties inherited from the UIObject class

The following table lists the properties the TextInput class inherits from the UIObject class. When accessing these properties from the TextInput object, use the form TextInputInstance.propertyName.

Property	Description
UIObject.bottom	Read-only; the position of the bottom edge of the object, relative to the bottom edge of its parent.
UIObject.height	Read-only; the height of the object, in pixels.
UIObject.left	Read-only; the left edge of the object, in pixels.
UIObject.right	Read-only; the position of the right edge of the object, relative to the right edge of its parent.
UIObject.scaleX	A number indicating the scaling factor in the x direction of the object, relative to its parent.
UIObject.scaleY	A number indicating the scaling factor in the y direction of the object, relative to its parent.
UIObject.top	Read-only; the position of the top edge of the object, relative to its parent.
UIObject.visible	A Boolean value indicating whether the object is visible (`true`) or not (`false`).
UIObject.width	Read-only; the width of the object, in pixels.
UIObject.x	Read-only; the left edge of the object, in pixels.
UIObject.y	Read-only; the top edge of the object, in pixels.

Properties inherited from the UIComponent class

The following table lists the properties the TextInput class inherits from the UIComponent class. When accessing these properties from the TextInput object, use the form TextInputInstance.propertyName.

Property	Description
UIComponent.enabled	Indicates whether the component can receive focus and input.
UIComponent.tabIndex	A number indicating the tab order for a component in a document.

Event summary for the TextInput class

The following table lists events of the TextInput class.

Event	Description
TextInput.change	Broadcast when the TextInput field changes.
TextInput.enter	Broadcast when the Enter key is pressed.

Events inherited from the UIObject class

The following table lists the events the TextInput class inherits from the UIObject class.

Event	Description
UIObject.draw	Broadcast when an object is about to draw its graphics.
UIObject.hide	Broadcast when an object's state changes from visible to invisible.
UIObject.load	Broadcast when subobjects are being created.
UIObject.move	Broadcast when the object has moved.
UIObject.resize	Broadcast when an object has been resized.
UIObject.reveal	Broadcast when an object's state changes from invisible to visible.
UIObject.unload	Broadcast when the subobjects are being unloaded.

Events inherited from the UIComponent class

The following table lists the events the TextInput class inherits from the UIComponent class.

Event	Description
UIComponent.focusIn	Broadcast when an object receives focus.
UIComponent.focusOut	Broadcast when an object loses focus.
UIComponent.keyDown	Broadcast when a key is pressed.
UIComponent.keyUp	Broadcast when a key is released.

Version 8

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/flash/8/main/00004068.html