Package | mx.core |
Class | public class UITextField |
Inheritance | UITextField FlexTextField flash.text.TextField |
Implements | IAutomationObject, IFlexModule, IIMESupport, IInvalidating, ISimpleStyleClient, IToolTipManagerClient, IUITextField |
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 | ||
---|---|---|---|
automationDelegate : Object
The delegate object which is handling the automation related functionality.
| UITextField | ||
automationName : String
Name that can be used as an identifier for this object.
| UITextField | ||
automationValue : Array [read-only]
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.
| UITextField | ||
baselinePosition : Number [read-only]
The y-coordinate of the baseline of the first line of text.
| UITextField | ||
className : String [read-only]
The name of this instance's class, such as
"DataGridItemRenderer" . | UITextField | ||
document : Object
A reference to the document object associated with this UITextField object.
| UITextField | ||
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, if the maxHeight property
is set.
| UITextField | ||
explicitMaxWidth : Number [read-only]
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates, if the maxWidth property
is set.
| 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 | ||
focusPane : Sprite
A single Sprite object that is shared among components
and used as an overlay for drawing focus.
| UITextField | ||
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 | ||
isPopUp : Boolean
Set to
true by the PopUpManager to indicate
that component has been popped up. | UITextField | ||
maxHeight : Number [read-only]
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UITextField | ||
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 | ||
moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
| UITextField | ||
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 | ||
nonZeroTextHeight : Number [read-only]
Unlike textHeight, this returns a non-zero value
even when the text is empty.
| UITextField | ||
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 | ||
styleName : Object
The class style used by this component.
| UITextField | ||
systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UITextField | ||
toolTip : String
Text to display in the ToolTip.
| UITextField | ||
tweeningProperties : Array
Array of properties that are currently being tweened on this object.
| UITextField | ||
updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required)
| UITextField |
Method | Defined by | ||
---|---|---|---|
Constructor.
| UITextField | ||
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UITextField | ||
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UITextField | ||
Gets a style property that has been set anywhere in this
component's style lookup chain.
| UITextField | ||
getTextStyles():TextFormat
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 | ||
initialize():void
Initializes this component.
| UITextField | ||
invalidateDisplayList():void
Marks a component so that its
updateDisplayList()
method gets called during a later screen update. | UITextField | ||
invalidateProperties():void
Marks a component so that its
commitProperties()
method gets called during a later screen update. | UITextField | ||
invalidateSize():void
Marks a component so that its
measure()
method gets called during a later screen update. | UITextField | ||
Moves the component to a specified position within its parent.
| UITextField | ||
owns(child:DisplayObject):Boolean
Returns
true if the child is parented or owned by this object. | UITextField | ||
parentChanged(p:DisplayObjectContainer):void
This function is called when a UITextField object is assigned
a parent.
| UITextField | ||
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
| UITextField | ||
Sizes the object.
| UITextField | ||
setColor(color:uint):void
Sets the font color of the text.
| UITextField | ||
setFocus():void
Sets the focus to this component.
| UITextField | ||
setStyle(styleProp:String, value:*):void
Does nothing.
| UITextField | ||
setVisible(visible:Boolean, noEvent:Boolean = false):void
Sets the
visible property of this UITextField object. | UITextField | ||
styleChanged(styleProp:String):void
Detects changes to style properties.
| UITextField | ||
toString():String
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexTextField | ||
truncateToFit(truncationIndicator:String = null):Boolean
Truncate text to make it fit horizontally in the area defined for the control,
and append an ellipsis, three periods (...), to the text.
| UITextField | ||
validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary.
| UITextField |
automationDelegate | property |
automationDelegate:Object
[read-write]The delegate object which is handling the automation related functionality.
Implementation public function get automationDelegate():Object
public function set automationDelegate(value:Object):void
automationName | property |
automationName:String
[read-write]Name that can be used as an identifier for this object.
Implementation public function get automationName():String
public function set automationName(value:String):void
automationValue | property |
automationValue:Array
[read-only]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.
Implementation public function get automationValue():Array
baselinePosition | property |
baselinePosition:Number
[read-only]The y-coordinate of the baseline of the first line of text.
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, 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
.
public function get explicitMaxHeight():Number
See also
explicitMaxWidth | property |
explicitMaxWidth:Number
[read-only]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
.
public function get explicitMaxWidth():Number
See also
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
isPopUp | property |
isPopUp:Boolean
[read-write]
Set to true
by the PopUpManager to indicate
that component has been popped up.
public function get isPopUp():Boolean
public function set isPopUp(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
moduleFactory | property |
moduleFactory:IFlexModuleFactory
[read-write]The moduleFactory that is used to create TextFields in the correct SWF context. This is necessary so that embedded fonts will work.
Implementation public function get moduleFactory():IFlexModuleFactory
public function set moduleFactory(value:IFlexModuleFactory):void
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
nonZeroTextHeight | property |
nonZeroTextHeight:Number
[read-only]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.
Implementation public function get nonZeroTextHeight():Number
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.
This property is always set to NaN for the UITextField control.
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.
This property is always set to NaN for the UITextField control.
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
object are used by this component.
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():Number
A 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():Number
A 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():TextFormat
Returns 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():void
Initializes 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):void
This 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.
|
replayAutomatableEvent | () | method |
public function replayAutomatableEvent(event:Event):Boolean
Replays the specified event. A component author should probably call super.replayAutomatableEvent in case default replay behavior has been defined in a superclass.
Parametersevent:Event — The event to replay.
|
Boolean — true if a replay was successful.
|
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):void
Sets the font color of the text.
Parameterscolor:uint — The new font color.
|
setFocus | () | method |
public function setFocus():void
Sets 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:*):void
Does 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):Boolean
Truncate 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.