The delegate object which is handling the automation related functionality.

True if this component is enabled for automation, false otherwise.

Name that can be used as an identifier for this object.

The owner of this component for automation purposes.

The parent of this component for automation purposes.

This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application.

True if this component is visible for automation, false otherwise.

The y-coordinate of the baseline of the first line of text.

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".

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.

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.

See also

A flag that indicates whether the IME should be enabled when the component receives focus.

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.

Number that specifies the maximum height of the component, in pixels, in the component's coordinates, if the maxHeight property is set. Because maxHeight is read-only, this method returns NaN. You must override this method and add a setter to use this property.

The default value is NaN.

See also

Number that specifies the maximum width of the component, in pixels, in the component's coordinates, if the maxWidth property is set. Because maxWidth is read-only, this method returns NaN. You must override this method and add a setter to use this property.

The default value is NaN.

See also

The minimum recommended height of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels.

Application developers typically do not set the explicitMinHeight property. Instead, they set the value of the minHeight property, which sets the explicitMinHeight property. The value of minHeight does not change.

At layout time, if minHeight was explicitly set by the application developer, then the value of explicitMinHeight is used. Otherwise, the value of measuredMinHeight is used.

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.

The minimum recommended width of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels.

Application developers typically do not set the explicitMinWidth property. Instead, they set the value of the minWidth property, which sets the explicitMinWidth property. The value of minWidth does not change.

At layout time, if minWidth was explicitly set by the application developer, then the value of explicitMinWidth is used. Otherwise, the value of measuredMinWidth is used.

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.

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.

A single Sprite object that is shared among components and used as an overlay for drawing the focus indicator. Components share this object if their parent is a focused component, not if the component implements the IFocusManagerComponent interface.

If true, the paddingLeft and paddingRight styles will not add space around the text of the component.

The default value is true.

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.

See also

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 and is sized and positioned by its parent container as per its layout rules. If false, the object size and position are not affected by its parent container's layout.

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.

A flag that determines if an object has been through all three phases of layout validation (provided that any were required)

Set to true by the PopUpManager to indicate that component has been popped up.

The maximum recommended height of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels. The default value of this property is set by the component developer.

The component developer uses this property to set an upper limit on the height of the component.

If the application developer overrides the default value of maxHeight, the new value is stored in explicitMaxHeight. The default value of maxHeight does not change. As a result, at layout time, if maxHeight was explicitly set by the application developer, then the value of explicitMaxHeight is used for the component's maximum recommended height. If maxHeight is not set explicitly by the user, then the default value is used.

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 is set to UIComponent.DEFAULT_MAX_HEIGHT.

The maximum recommended width of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels. The default value of this property is set by the component developer.

The component developer uses this property to set an upper limit on the width of the component.

If the application developer overrides the default value of maxWidth, the new value is stored in explicitMaxWidth. The default value of maxWidth does not change. As a result, at layout time, if maxWidth was explicitly set by the application developer, then the value of explicitMaxWidth is used for the component's maximum recommended width. If maxWidth is not set explicitly by the user, then the default value is used.

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 is set to UIComponent.DEFAULT_MAX_WIDTH.

The default height of the component, in pixels. This value is set by the measure() method.

The default minimum height of the component, in pixels. This value is set by the measure() method.

The default minimum width of the component, in pixels. This value is set by the measure() method.

The default width of the component, in pixels. This value is set by the measure() method.

The minimum recommended height of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels. The default value depends on the component's implementation.

If the application developer sets the value of minHeight, the new value is stored in explicitMinHeight. The default value of minHeight does not change. As a result, at layout time, if minHeight was explicitly set by the application developer, then the value of explicitMinHeight is used for the component's minimum recommended height. If minHeight is not set explicitly by the application developer, then the value of measuredMinHeight is used.

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.

The minimum recommended width of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels. The default value depends on the component's implementation.

If the application developer sets the value of minWidth, the new value is stored in explicitMinWidth. The default value of minWidth does not change. As a result, at layout time, if minWidth was explicitly set by the application developer, then the value of explicitMinWidth is used for the component's minimum recommended width. If minWidth is not set explicitly by the application developer, then the value of measuredMinWidth is used.

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.

The moduleFactory that is used to create TextFields in the correct SWF context. This is necessary so that embedded fonts will work.

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.

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.

Unlike textHeight, this returns a non-zero value even when the text is empty. In this case, it returns what the textHeight would be if the text weren't empty.

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.

The parent container or component for this component.

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.

This property is always set to NaN for the UITextField control.

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.

This property is always set to NaN for the UITextField control.

Set to true after the createChildren() method creates any internal component children.

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 one or more whitespace delimited class declarations in an <fx: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 object are used by this component.

Returns the SystemManager object used by this component.

Text to display in the ToolTip.

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.

A flag that determines if an object has been through all three phases of layout validation (provided that any were required)

Constructor.

A convenience method for determining whether to use the explicit or measured height

A convenience method for determining whether to use the explicit or measured width

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 can 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 know its type and 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() is 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 method IStyleManager2.isValidStyleValue() to test whether the value was set.

Parameters

Returns the TextFormat object that represents character formatting information for this UITextField object.

See also

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().

See also

Initializes this component.

This method is required by the IUIComponent interface, but it actually does nothing for a UITextField.

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.

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.

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.

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, 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.

Parameters

Returns true if the child is parented or owned by this object.

Parameters

See also

This function is called when a UITextField object is assigned a parent. You typically never need to call this method.

Parameters

Replays the specified event. A component author should probably call super.replayAutomatableEvent in case default replay behavior has been defined in a superclass.

Parameters

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 can 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.

Parameters

Sets the font color of the text.

Parameters

Sets the focus to this component. The component can 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.

Does nothing. A UITextField cannot have inline styles.

Parameters

Sets the visible property of this UITextField object.

Parameters

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.

Parameters

Truncate text to make it fit horizontally in the area defined for the control, and append an ellipsis, three periods (...), to the text.

Parameters

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 can 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.