| Package | mx.core |
| Class | public class UITextField |
| Inheritance | UITextField FlexTextField TextField InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IIMESupport, IInvalidating, ISimpleStyleClient, IToolTipManagerClient, IUIComponent |
| Subclasses | DataGridItemRenderer |
The UITextField class extends the flash.text.TextField class to support additional functionality required by Flex, such as CSS styles, invalidation/measurement/layout, enabling/disabling, tooltips, and IME (Input Method Editor) support for entering Chinese, Japanese, and Korean text.
See also
| Property | Defined by | ||
|---|---|---|---|
![]() | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
| DisplayObject | |
![]() | alpha : Number
Indicates the alpha transparency value of the object specified.
| DisplayObject | |
![]() | alwaysShowSelection : Boolean
When set to
true and the text field is not in focus, Flash Player highlights the
selection in the text field in gray. | TextField | |
![]() | antiAliasType : String
The type of anti-aliasing used for this text field.
| TextField | |
![]() | autoSize : String
Controls automatic sizing and alignment of text fields.
| TextField | |
![]() | background : Boolean
Specifies whether the text field has a background fill.
| TextField | |
![]() | backgroundColor : uint
The color of the text field background.
| TextField | |
| baselinePosition : Number
[read-only]
Determines the baseline y-coordinate
of the first line of text of the component.
| UITextField | ||
![]() | blendMode : String
A value from the BlendMode class that specifies which blend mode to use.
| DisplayObject | |
![]() | border : Boolean
Specifies whether the text field has a border.
| TextField | |
![]() | borderColor : uint
The color of the text field border.
| TextField | |
![]() | bottomScrollV : int
An integer (1-based index) that indicates the bottommost line that is currently visible in
the specified text field.
| TextField | |
![]() | cacheAsBitmap : Boolean
If set to
true, Flash Player caches an internal bitmap representation of the
display object. | DisplayObject | |
![]() | caretIndex : int
The index of the insertion point (caret) position.
| TextField | |
| className : String
[read-only]
The name of this instance's class, such as
"DataGridItemRenderer". | UITextField | ||
![]() | condenseWhite : Boolean
A Boolean value that specifies whether extra white space (spaces, line breaks, and so on)
in a text field with HTML text should be removed.
| TextField | |
![]() | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
![]() | contextMenu : ContextMenu
Specifies the context menu associated with this object.
| InteractiveObject | |
![]() | defaultTextFormat : TextFormat
Specifies the format applied to newly inserted text, such as text inserted with the
replaceSelectedText() method or text entered by a user. | TextField | |
![]() | displayAsPassword : Boolean
Specifies whether the text field is a password text field.
| TextField | |
| document : Object
A reference to the document object associated with this UITextField object.
| UITextField | ||
![]() | doubleClickEnabled : Boolean
Specifies whether the object receives
doubleClick events. | InteractiveObject | |
![]() | embedFonts : Boolean
Specifies whether to render by using embedded font outlines.
| TextField | |
| enabled : Boolean
A Boolean value that indicates whether the component is enabled.
| UITextField | ||
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
| UITextField | ||
| explicitMaxHeight : Number
[read-only]
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UITextField | ||
| explicitMaxWidth : Number
[read-only]
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UITextField | ||
| explicitMinHeight : Number
[read-only]
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UITextField | ||
| explicitMinWidth : Number
[read-only]
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UITextField | ||
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UITextField | ||
![]() | filters : Array
An indexed array that contains each filter object currently associated with the display object.
| DisplayObject | |
| focusPane : Sprite
A single Sprite object that is shared among components
and used as an overlay for drawing focus.
| UITextField | ||
![]() | focusRect : Object
Specifies whether this object displays a focus rectangle.
| InteractiveObject | |
![]() | gridFitType : String
The type of grid fitting used for this text field.
| TextField | |
![]() | height : Number
Indicates the height of the display object, in pixels.
| DisplayObject | |
![]() | htmlText : String
Contains the HTML representation of the text field's contents.
| TextField | |
| ignorePadding : Boolean
If
true, the paddingLeft and
paddingRight styles will not add space
around the text of the component. | UITextField | ||
| imeMode : String
Specifies the IME (input method editor) mode.
| UITextField | ||
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container.
| UITextField | ||
| inheritingStyles : Object
The beginning of this UITextField's chain of inheriting styles.
| UITextField | ||
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required)
| UITextField | ||
![]() | length : int
The number of characters in a text field.
| TextField | |
![]() | loaderInfo : LoaderInfo
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs.
| DisplayObject | |
![]() | mask : DisplayObject
The calling display object is masked by the specified
mask object. | DisplayObject | |
![]() | maxChars : int
The maximum number of characters that the text field can contain, as entered by a user.
| TextField | |
| maxHeight : Number
[read-only]
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UITextField | ||
![]() | maxScrollH : int
The maximum value of
scrollH. | TextField | |
![]() | maxScrollV : int
The maximum value of
scrollV. | TextField | |
| maxWidth : Number
[read-only]
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UITextField | ||
| measuredHeight : Number
[read-only]
The default height of the component, in pixels.
| UITextField | ||
| measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UITextField | ||
| measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UITextField | ||
| measuredWidth : Number
[read-only]
The default width of the component, in pixels.
| UITextField | ||
| minHeight : Number
[read-only]
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UITextField | ||
| minWidth : Number
[read-only]
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UITextField | ||
![]() | mouseEnabled : Boolean
Specifies whether this object receives mouse messages.
| InteractiveObject | |
![]() | mouseWheelEnabled : Boolean
A Boolean value that indicates whether Flash Player should automatically scroll multiline
text fields when the user clicks a text field and rolls the mouse wheel.
| TextField | |
![]() | mouseX : Number
Indicates the x coordinate of the mouse position, in pixels.
| DisplayObject | |
![]() | mouseY : Number
Indicates the y coordinate of the mouse position, in pixels.
| DisplayObject | |
![]() | multiline : Boolean
Indicates whether the text field is a multiline text field.
| TextField | |
![]() | name : String
Indicates the instance name of the DisplayObject.
| DisplayObject | |
| nestLevel : int
Depth of this object in the containment hierarchy.
| UITextField | ||
| nonInheritingStyles : Object
The beginning of this UITextField's chain of non-inheriting styles.
| UITextField | ||
![]() | numLines : int
Defines the number of text lines in a multiline text field.
| TextField | |
![]() | opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
| DisplayObject | |
| owner : DisplayObjectContainer
By default, set to the parent container of this object.
| UITextField | ||
| parent : DisplayObjectContainer
[read-only]
The parent container or component for this component.
| UITextField | ||
| percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UITextField | ||
| percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UITextField | ||
| processedDescriptors : Boolean
Set to
true after the createChildren()
method creates any internal component children. | UITextField | ||
![]() | prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
![]() | restrict : String
Indicates the set of characters that a user can enter into the text field.
| TextField | |
![]() | root : DisplayObject
For a display object in a loaded SWF file, the
root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
![]() | rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
| DisplayObject | |
![]() | scale9Grid : Rectangle
The current scaling grid that is in effect.
| DisplayObject | |
![]() | scaleX : Number
Indicates the horizontal scale (
percentage) of the object as applied from the registration point. | DisplayObject | |
![]() | scaleY : Number
Indicates the vertical scale (
percentage) of an object as applied from the registration point of the object. | DisplayObject | |
![]() | scrollH : int
The current horizontal scrolling position.
| TextField | |
![]() | scrollRect : Rectangle
The scroll rectangle bounds of the display object.
| DisplayObject | |
![]() | scrollV : int
The vertical position of text in a text field.
| TextField | |
![]() | selectable : Boolean
A Boolean value that indicates whether the text field is selectable.
| TextField | |
![]() | selectionBeginIndex : int
The zero-based character index value of the first character in the current selection.
| TextField | |
![]() | selectionEndIndex : int
The zero-based character index value of the last character in the current selection.
| TextField | |
![]() | sharpness : Number
The sharpness of the glyph edges in this text field.
| TextField | |
![]() | stage : Stage
The Stage of the display object.
| DisplayObject | |
| styleName : Object
The class style used by this component.
| UITextField | ||
![]() | styleSheet : StyleSheet
Attaches a style sheet to the text field.
| TextField | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UITextField | ||
![]() | tabEnabled : Boolean
Specifies whether this object is in the tab order.
| InteractiveObject | |
![]() | tabIndex : int
Specifies the tab ordering of objects in a SWF file.
| InteractiveObject | |
![]() | text : String
A string that is the current text in the text field.
| TextField | |
![]() | textColor : uint
The color of the text in a text field, in hexadecimal format.
| TextField | |
![]() | textHeight : Number
The height of the text in pixels.
| TextField | |
![]() | textWidth : Number
The width of the text in pixels.
| TextField | |
![]() | thickness : Number
The thickness of the glyph edges in this text field.
| TextField | |
| toolTip : String
Text to display in the ToolTip.
| UITextField | ||
![]() | transform : Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
| DisplayObject | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object.
| UITextField | ||
![]() | type : String
The type of the text field.
| TextField | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required)
| UITextField | ||
![]() | useRichTextClipboard : Boolean
Specifies whether to copy and paste the text formatting along with the text.
| TextField | |
![]() | visible : Boolean
Whether or not the display object is visible.
| DisplayObject | |
![]() | width : Number
Indicates the width of the display object, in pixels.
| DisplayObject | |
![]() | wordWrap : Boolean
A Boolean value that indicates whether the text field has word wrap.
| TextField | |
![]() | x : Number
Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer.
| DisplayObject | |
![]() | y : Number
Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer.
| DisplayObject | |
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| UITextField | ||
![]() |
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event.
| EventDispatcher | |
![]() |
Appends the string specified by the
newText parameter to the end of the text
of the TextField. | TextField | |
![]() |
Dispatches an event into the event flow.
| EventDispatcher | |
![]() |
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the
targetCoordinateSpace object. | DisplayObject | |
![]() |
Returns a rectangle that is the bounding box of the character.
| TextField | |
![]() |
Returns the zero-based index value of the character at the point specified by the
x
and y parameters. | TextField | |
|
A convenience method for determining whether to use the
explicit or measured height
| UITextField | ||
|
A convenience method for determining whether to use the
explicit or measured width
| UITextField | ||
![]() |
Given a character index, returns the index of the first character in the same paragraph.
| TextField | |
![]() |
Returns a DisplayObject reference for the given
id, for an image or SWF file
that has been added to an HTML-formatted text field by using an <img> tag. | TextField | |
![]() |
Returns the zero-based index value of the line at the point specified by the
x
and y parameters. | TextField | |
![]() |
Returns the zero-based index value of the line containing the character specified
by the
charIndex parameter. | TextField | |
![]() |
Returns the number of characters in a specific text line.
| TextField | |
![]() |
Returns metrics information about a given text line.
| TextField | |
![]() |
Returns the character index of the first character in the line that
the
lineIndex parameter specifies. | TextField | |
![]() |
Returns the text of the line specified by the
lineIndex parameter. | TextField | |
![]() |
Given a character index, returns the length of the paragraph containing the given character.
| TextField | |
![]() |
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the
targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain.
| UITextField | ||
![]() |
Returns a TextFormat object that contains formatting information for the range of text that the
beginIndex and endIndex parameters specify. | TextField | |
|
Returns the TextFormat object that represents
character formatting information for this UITextField object.
| UITextField | ||
|
Returns a UITextFormat object that contains formatting information for this component.
| UITextField | ||
![]() |
Converts the
point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
![]() |
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event.
| EventDispatcher | |
![]() |
Indicates whether an object has a specified property defined.
| Object | |
![]() |
Evaluates the display object to see if it overlaps or intersects with the
obj display object. | DisplayObject | |
![]() |
Evaluates the display object to see if it overlaps or intersects with the
point specified by the
x and y parameters. | DisplayObject | |
|
Initializes this component.
| UITextField | ||
|
Marks a component so that its
updateDisplayList()
method gets called during a later screen update. | UITextField | ||
|
Marks a component so that its
commitProperties()
method gets called during a later screen update. | UITextField | ||
|
Marks a component so that its
measure()
method gets called during a later screen update. | UITextField | ||
![]() |
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
![]() |
Converts the
point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Moves the component to a specified position within its parent.
| UITextField | ||
|
Returns
true if the child is parented or owned by this object. | UITextField | ||
|
This function is called when a UITextField object is assigned
a parent.
| UITextField | ||
![]() |
Indicates whether the specified property exists and is enumerable.
| Object | |
![]() |
Removes a listener from the EventDispatcher object.
| EventDispatcher | |
![]() |
Replaces the current selection with the contents of the
value parameter. | TextField | |
![]() |
Replaces the range of characters that the
beginIndex and
endIndex parameters specify with the contents
of the newText parameter. | TextField | |
|
Sizes the object.
| UITextField | ||
|
Sets the font color of the text.
| UITextField | ||
|
Sets the focus to this component.
| UITextField | ||
![]() |
Sets the availability of a dynamic property for loop operations.
| Object | |
![]() |
Sets as selected the text designated by the index values of the
first and last characters, which are specified with the
beginIndex
and endIndex parameters. | TextField | |
|
Does nothing.
| UITextField | ||
![]() |
Applies the text formatting that the
format parameter specifies to the specified text in a text field. | TextField | |
|
Sets the
visible property of this UITextField object. | UITextField | ||
|
Detects changes to style properties.
| UITextField | ||
![]() |
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexTextField | |
|
Truncate text to make it fit horizontally in the area defined for the control,
and append an ellipsis, three periods (...), to the text.
| UITextField | ||
|
Validate and update the properties and layout of this object
and redraw it, if necessary.
| UITextField | ||
![]() |
Returns the primitive value of the specified object.
| Object | |
![]() |
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type.
| EventDispatcher | |
| Style | Description | Defined by | ||
|---|---|---|---|---|
|
color
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. The default value is 0x0B333C. | UITextField | ||
|
disabledColor
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. The default value is 0xAAB3B3. | UITextField | ||
|
fontAntiAliasType
| Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields. The possible values are
"normal" (flash.text.AntiAliasType.NORMAL)
and "advanced" (flash.text.AntiAliasType.ADVANCED).
The default value is This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is"advanced". | UITextField | ||
|
fontFamily
| Type: String CSS Inheritance: yes Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is "Verdana". | UITextField | ||
|
fontGridFitType
| Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls.
The possible values are "none" (flash.text.GridFitType.NONE),
"pixel" (flash.text.GridFitType.PIXEL),
and "subpixel" (flash.text.GridFitType.SUBPIXEL).
This property only applies when you are using an embedded FlashType font
and the This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is"pixel". | UITextField | ||
|
fontSharpness
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls.
This property specifies the sharpness of the glyph edges. The possible values are Numbers
from -400 through 400.
This property only applies when you are using an embedded FlashType font
and the This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is0. | UITextField | ||
|
fontSize
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. The default value is 10. | UITextField | ||
|
fontStyle
| Type: String CSS Inheritance: yes Determines whether the text is italic font. Recognized values are "normal" and "italic".
The default value is "normal". | UITextField | ||
|
fontThickness
| Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls.
This property specifies the thickness of the glyph edges.
The possible values are Numbers from -200 to 200.
This property only applies when you are using an embedded FlashType font
and the This style has no effect on system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is0. | UITextField | ||
|
fontWeight
| Type: String CSS Inheritance: yes Determines whether the text is boldface. Recognized values are "normal" and "bold".
The default value is "normal". | UITextField | ||
|
leading
| Type: Number Format: Length CSS Inheritance: no Additional vertical space between lines of text. The default value is 2. | UITextField | ||
|
paddingLeft
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's left border and the left edge of its content area. The default value is 0. | UITextField | ||
|
paddingRight
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's right border and the right edge of its content area. The default value is 0. | UITextField | ||
|
textAlign
| Type: String CSS Inheritance: yes Alignment of text within a container. Possible values are "left", "right",
or "center".
The default value for most controls is | UITextField | ||
|
textDecoration
| Type: String CSS Inheritance: no Determines whether the text is underlined. Possible values are "none" and "underline".
The default value is "none". | UITextField | ||
|
textIndent
| Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. The default value is 0. | UITextField | ||
| baselinePosition | property |
baselinePosition:Number [read-only]Determines the baseline y-coordinate of the first line of text of the component. Any subclass of UITextField should override this property.
Implementation public function get baselinePosition():Number
| className | property |
className:String [read-only]
The name of this instance's class, such as
"DataGridItemRenderer".
This string does not include the package name.
If you need the package name as well, call the
getQualifiedClassName() method in the flash.utils package.
It will return a string such as
"mx.controls.dataGridClasses::DataGridItemRenderer".
public function get className():String
| document | property |
document:Object [read-write]A reference to the document object associated with this UITextField object. A document object is an Object at the top of the hierarchy of a Flex application, MXML component, or AS component.
Implementation public function get document():Object
public function set document(value:Object):void
| enabled | property |
enabled:Boolean [read-write]
A Boolean value that indicates whether the component is enabled.
This property only affects
the color of the text and not whether the UITextField is editable.
To control editability, use the
flash.text.TextField.type property.
The default value is true.
public function get enabled():Boolean
public function set enabled(value:Boolean):void
See also
| explicitHeight | property |
explicitHeight:Number [read-write]Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true explicitHeight with respect to its parent
is affected by the scaleY property.
Setting the height property also sets this property to
the specified height value.
public function get explicitHeight():Number
public function set explicitHeight(value:Number):void
| explicitMaxHeight | property |
explicitMaxHeight:Number [read-only]Number that specifies the maximum height of the component, in pixels, in the component's coordinates.
This value is used by the container in calculating the size
and position of the component.
It is not used by the component itself in determining its default size.
Thus this property may not have any effect if parented by Container,
or containers that don't factor in this property.
Because the value is in component coordinates, the true maxHeight
with respect to its parent is affected by the scaleY property.
The default value is NaN.
public function get explicitMaxHeight():Number
| explicitMaxWidth | property |
explicitMaxWidth:Number [read-only]Number that specifies the maximum width of the component, in pixels, in the component's coordinates.
This value is used by the container in calculating the size
and position of the component.
It is not used by the component itself in determining its default size.
Thus this property may not have any effect if parented by Container,
or containers that don't factor in this property.
Because the value is in component coordinates, the true maxWidth
with respect to its parent is affected by the scaleX property.
The default value is NaN.
public function get explicitMaxWidth():Number
| explicitMinHeight | property |
explicitMinHeight:Number [read-only]Number that specifies the minimum height of the component, in pixels, in the component's coordinates.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true minHeight with respect to its parent
is affected by the scaleY property.
public function get explicitMinHeight():Number
| explicitMinWidth | property |
explicitMinWidth:Number [read-only]Number that specifies the minimum width of the component, in pixels, in the component's coordinates.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true minWidth with respect to its parent
is affected by the scaleX property.
public function get explicitMinWidth():Number
| explicitWidth | property |
explicitWidth:Number [read-write]Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true explicitWidth with respect to its parent
is affected by the scaleX property.
Setting the width property also sets this property to
the specified width value.
public function get explicitWidth():Number
public function set explicitWidth(value:Number):void
| focusPane | property |
focusPane:Sprite [read-write]A single Sprite object that is shared among components and used as an overlay for drawing focus. Components share this object if their parent is a focused component, not if the component implements the IFocusManagerComponent interface.
Implementation public function get focusPane():Sprite
public function set focusPane(value:Sprite):void
| ignorePadding | property |
ignorePadding:Boolean [read-write]
If true, the paddingLeft and
paddingRight styles will not add space
around the text of the component.
The default value is true.
public function get ignorePadding():Boolean
public function set ignorePadding(value:Boolean):void
| imeMode | property |
imeMode:String [read-write]Specifies the IME (input method editor) mode. The IME enables users to enter text in Chinese, Japanese, and Korean. Flex sets the specified IME mode when the control gets the focus, and sets it back to the previous value when the control loses the focus.
The flash.system.IMEConversionMode class defines constants for the
valid values for this property.
You can also specify null to specify no IME.
The default value is null.
public function get imeMode():String
public function set imeMode(value:String):void
See also
| includeInLayout | property |
includeInLayout:Boolean [read-write]
Specifies whether this component is included in the layout of the
parent container.
If true, the object is included in its parent container's
layout. If false, the object is positioned by its parent
container as per its layout rules, but it is ignored for the purpose of
computing the position of the next child.
public function get includeInLayout():Boolean
public function set includeInLayout(value:Boolean):void
| inheritingStyles | property |
inheritingStyles:Object [read-write]
The beginning of this UITextField's chain of inheriting styles.
The getStyle() method accesses
inheritingStyles[styleName] to search the entire
prototype-linked chain.
This object is set up by the initProtoChain() method.
You typically never need to access this property directly.
public function get inheritingStyles():Object
public function set inheritingStyles(value:Object):void
| initialized | property |
initialized:Boolean [read-write]A flag that determines if an object has been through all three phases of layout validation (provided that any were required)
Implementation public function get initialized():Boolean
public function set initialized(value:Boolean):void
| maxHeight | property |
maxHeight:Number [read-only]Number that specifies the maximum height of the component, in pixels, in the component's coordinates.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true maxHeight with respect to its parent
is affected by the scaleY property.
Some components have no theoretical limit to their height.
In those cases their maxHeight will be set to
UIComponent.DEFAULT_MAX_HEIGHT.
public function get maxHeight():Number
| maxWidth | property |
maxWidth:Number [read-only]Number that specifies the maximum width of the component, in pixels, in the component's coordinates.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true maxWidth with respect to its parent
is affected by the scaleX property.
Some components have no theoretical limit to their width.
In those cases their maxWidth will be set to
UIComponent.DEFAULT_MAX_WIDTH.
public function get maxWidth():Number
| measuredHeight | property |
measuredHeight:Number [read-only]
The default height of the component, in pixels.
This value is set by the measure() method.
public function get measuredHeight():Number
| measuredMinHeight | property |
measuredMinHeight:Number [read-write]
The default minimum height of the component, in pixels.
This value is set by the measure() method.
public function get measuredMinHeight():Number
public function set measuredMinHeight(value:Number):void
| measuredMinWidth | property |
measuredMinWidth:Number [read-write]
The default minimum width of the component, in pixels.
This value is set by the measure() method.
public function get measuredMinWidth():Number
public function set measuredMinWidth(value:Number):void
| measuredWidth | property |
measuredWidth:Number [read-only]
The default width of the component, in pixels.
This value is set by the measure() method.
public function get measuredWidth():Number
| minHeight | property |
minHeight:Number [read-only]Number that specifies the minimum height of the component, in pixels, in the component's coordinates. The default value depends on the component implementation.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true minHeight with respect to its parent
is affected by the scaleY property.
public function get minHeight():Number
| minWidth | property |
minWidth:Number [read-only]Number that specifies the minimum width of the component, in pixels, in the component's coordinates. The default value depends on the component implementation.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true minWidth with respect to its parent
is affected by the scaleX property.
public function get minWidth():Number
| nestLevel | property |
nestLevel:int [read-write]Depth of this object in the containment hierarchy. This number is used by the measurement and layout code. The value is 0 if this component is not on the DisplayList.
Implementation public function get nestLevel():int
public function set nestLevel(value:int):void
| nonInheritingStyles | property |
nonInheritingStyles:Object [read-write]
The beginning of this UITextField's chain of non-inheriting styles.
The getStyle() method accesses
nonInheritingStyles[styleName] method to search the entire
prototype-linked chain.
This object is set up by the initProtoChain() method.
You typically never need to access this property directly.
public function get nonInheritingStyles():Object
public function set nonInheritingStyles(value:Object):void
| owner | property |
owner:DisplayObjectContainer [read-write]By default, set to the parent container of this object. However, if this object is a child component that is popped up by its parent, such as the dropdown list of a ComboBox control, the owner is the component that popped up this object.
This property is not managed by Flex, but by each component.
Therefore, if you use the PopUpManger.createPopUp() or
PopUpManger.addPopUp() method to pop up a child component,
you should set the owner property of the child component
to the component that popped it up.
The default value is the value of the parent property.
public function get owner():DisplayObjectContainer
public function set owner(value:DisplayObjectContainer):void
| parent | property |
parent:DisplayObjectContainer [read-only]The parent container or component for this component.
Implementation public function get parent():DisplayObjectContainer
| percentHeight | property |
percentHeight:Number [read-write]
Number that specifies the height of a component as a percentage
of its parent's size. Allowed values are 0-100. The default value is NaN.
Setting the height or explicitHeight properties
resets this property to NaN.
This property returns a numeric value only if the property was previously set; it does not reflect the exact size of the component in percent.
Implementation public function get percentHeight():Number
public function set percentHeight(value:Number):void
| percentWidth | property |
percentWidth:Number [read-write]
Number that specifies the width of a component as a percentage
of its parent's size. Allowed values are 0-100. The default value is NaN.
Setting the width or explicitWidth properties
resets this property to NaN.
This property returns a numeric value only if the property was previously set; it does not reflect the exact size of the component in percent.
Implementation public function get percentWidth():Number
public function set percentWidth(value:Number):void
| processedDescriptors | property |
processedDescriptors:Boolean [read-write]
Set to true after the createChildren()
method creates any internal component children.
public function get processedDescriptors():Boolean
public function set processedDescriptors(value:Boolean):void
| styleName | property |
styleName:Object [read-write]The class style used by this component. This can be a String, CSSStyleDeclaration or an IStyleClient.
If this is a String, it is the name of a class declaration
in an mx:Style tag or CSS file. You do not include the period in
the styleName. For example, if you have a class style named ".bigText",
set the styleName property to "bigText" (no period).
If this is an IStyleClient (typically a UIComponent), all styles in the styleName ojbect are used by this component.
Implementation public function get styleName():Object
public function set styleName(value:Object):void
| systemManager | property |
systemManager:ISystemManager [read-write]Returns the SystemManager object used by this component.
Implementation public function get systemManager():ISystemManager
public function set systemManager(value:ISystemManager):void
| toolTip | property |
toolTip:String [read-write]Text to display in the ToolTip.
Implementation public function get toolTip():String
public function set toolTip(value:String):void
| tweeningProperties | property |
tweeningProperties:Array [read-write]Array of properties that are currently being tweened on this object.
Used to alert the EffectManager that certain properties of this object are being tweened, so that the EffectManger doesn't attempt to animate the same properties.
Implementation public function get tweeningProperties():Array
public function set tweeningProperties(value:Array):void
| updateCompletePendingFlag | property |
updateCompletePendingFlag:Boolean [read-write]A flag that determines if an object has been through all three phases of layout validation (provided that any were required)
Implementation public function get updateCompletePendingFlag():Boolean
public function set updateCompletePendingFlag(value:Boolean):void
| UITextField | () | constructor |
public function UITextField()Constructor.
| getExplicitOrMeasuredHeight | () | method |
public function getExplicitOrMeasuredHeight():NumberA convenience method for determining whether to use the explicit or measured height
ReturnsNumber —
A Number which is explicitHeight if defined
or measuredHeight if not.
|
| getExplicitOrMeasuredWidth | () | method |
public function getExplicitOrMeasuredWidth():NumberA convenience method for determining whether to use the explicit or measured width
ReturnsNumber —
A Number which is explicitWidth if defined
or measuredWidth if not.
|
| getStyle | () | method |
public function getStyle(styleProp:String):*Gets a style property that has been set anywhere in this component's style lookup chain.
This same method is used to get any kind of style property, so the value returned may be a Boolean, String, Number, int, uint (for an RGB color), Class (for a skin), or any kind of object. Therefore the return type is simply specified as
If you are getting a particular style property, you will know its type and will often want to store the result in a variable of that type. No casting from to that type is necessary:
var backgroundColor:uint = getStyle("backgroundColor");
If the style property has not been set anywhere in the
style lookup chain, the value returned by getStyle()
will be undefined.
Note that undefined is a special value that is
not the same as false, "",
NaN, 0, or null.
No valid style value is ever undefined.
You can use the static method
StyleManager.isValidStyleValue()
to test whether the value was set.
styleProp:String — Name of the style property.
|
* — Style value.
|
| getTextStyles | () | method |
public function getTextStyles():TextFormatReturns the TextFormat object that represents character formatting information for this UITextField object.
ReturnsTextFormat —
A TextFormat object.
|
See also
| getUITextFormat | () | method |
public function getUITextFormat():UITextFormat
Returns a UITextFormat object that contains formatting information for this component.
This method is similar to the getTextFormat() method of the
flash.text.TextField class, but it returns a UITextFormat object instead
of a TextFormat object.
The UITextFormat class extends the TextFormat class to add the text measurement methods
measureText() and measureHTMLText().
UITextFormat —
An object that contains formatting information for this component.
|
See also
| initialize | () | method |
public function initialize():voidInitializes this component.
This method is required by the IUIComponent interface, but it actually does nothing for a UITextField.
| invalidateDisplayList | () | method |
public function invalidateDisplayList():void
Marks a component so that its updateDisplayList()
method gets called during a later screen update.
Invalidation is a useful mechanism for eliminating duplicate work by delaying processing of changes to a component until a later screen update. For example, if you want to change the width and height, it would be wasteful to update the component immediately after you change the width and then update again with the new height. It is more efficient to change both properties and then render the component with its new size once.
Invalidation methods rarely get called. In general, setting a property on a component automatically calls the appropriate invalidation method.
| invalidateProperties | () | method |
public function invalidateProperties():void
Marks a component so that its commitProperties()
method gets called during a later screen update.
Invalidation is a useful mechanism for eliminating duplicate work by delaying processing of changes to a component until a later screen update. For example, if you want to change the text color and size, it would be wasteful to update the color immediately after you change it and then update the size when it gets set. It is more efficient to change both properties and then render the text with its new size and color once.
Invalidation methods rarely get called. In general, setting a property on a component automatically calls the appropriate invalidation method.
| invalidateSize | () | method |
public function invalidateSize():void
Marks a component so that its measure()
method gets called during a later screen update.
Invalidation is a useful mechanism for eliminating duplicate work by delaying processing of changes to a component until a later screen update. For example, if you want to change the text and font size, it would be wasteful to update the text immediately after you change it and then update the size when it gets set. It is more efficient to change both properties and then render the text with its new size once.
Invalidation methods rarely get called. In general, setting a property on a component automatically calls the appropriate invalidation method.
| move | () | method |
public function move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
Calling this method is exactly the same as
setting the component's x and y properties.
If you are overriding the updateDisplayList() method
in a custom component, you should call the move() method
rather than setting the x and y properties.
The difference is that the move() method changes the location
of the component and then dispatches a move event when you
call the method, while setting the x and y
properties changes the location of the component and dispatches
the event on the next screen refresh.
x:Number — Left position of the component within its parent.
|
|
y:Number — Top position of the component within its parent.
|
| owns | () | method |
public function owns(child:DisplayObject):Boolean
Returns true if the child is parented or owned by this object.
child:DisplayObject — The child DisplayObject.
|
Boolean —
true if the child is parented or owned by this UITextField object.
|
See also
| parentChanged | () | method |
public function parentChanged(p:DisplayObjectContainer):voidThis function is called when a UITextField object is assigned a parent. You typically never need to call this method.
Parametersp:DisplayObjectContainer — The parent of this UITextField object.
|
| setActualSize | () | method |
public function setActualSize(w:Number, h:Number):void
Sizes the object.
Unlike directly setting the width and height
properties, calling the setActualSize() method
does not set the explictWidth and
explicitHeight properties, so a future layout
calculation may result in the object returning to its previous size.
This method is used primarily by component developers implementing
the updateDisplayList() method, by Effects,
and by the LayoutManager.
w:Number — Width of the object.
|
|
h:Number — Height of the object.
|
| setColor | () | method |
public function setColor(color:uint):voidSets the font color of the text.
Parameterscolor:uint — The new font color.
|
| setFocus | () | method |
public function setFocus():voidSets the focus to this component. The component may in turn pass focus to a subcomponent.
Note: Only the TextInput and TextArea controls show a highlight when this method sets the focus. All controls show a highlight when the user tabs to the control.
| setStyle | () | method |
public function setStyle(styleProp:String, value:*):voidDoes nothing. A UITextField cannot have inline styles.
ParametersstyleProp:String — Name of the style property.
|
|
value:* — New value for the style.
|
| setVisible | () | method |
public function setVisible(visible:Boolean, noEvent:Boolean = false):void
Sets the visible property of this UITextField object.
visible:Boolean — true to make this UITextField visible,
and false to make it invisible.
|
|
noEvent:Boolean (default = false) — true to suppress generating an event when you change visibility.
|
| styleChanged | () | method |
public function styleChanged(styleProp:String):void
Detects changes to style properties. When any style property is set,
Flex calls the styleChanged() method,
passing to it the name of the style being set.
This is an advanced method that you might override
when creating a subclass of UIComponent. When you create a custom component,
you can override the styleChanged() method
to check the style name passed to it, and handle the change accordingly.
This lets you override the default behavior of an existing style,
or add your own custom style properties.
If you handle the style property, your override of
the styleChanged() method should call the
invalidateDisplayList() method to cause Flex to execute
the component's updateDisplayList() method at the next screen update.
styleProp:String — The name of the style property, or null if all styles for this
component have changed.
|
| truncateToFit | () | method |
public function truncateToFit(truncationIndicator:String = null):BooleanTruncate text to make it fit horizontally in the area defined for the control, and append an ellipsis, three periods (...), to the text.
ParameterstruncationIndicator:String (default = null) — The text to be appended after truncation.
If you pass null, a localizable string
such as "..." will be used.
|
Boolean —
true if the text needed truncation.
|
| validateNow | () | method |
public function validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary.
Processing properties that require substantial computation are normally
not processed until the script finishes executing.
For example setting the width property is delayed, because it may
require recalculating the widths of the objects children or its parent.
Delaying the processing prevents it from being repeated
multiple times if the script sets the width property more than once.
This method lets you manually override this behavior.