| Package | mx.core |
| Class | public class UIComponent |
| Inheritance | UIComponent  FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IAutomationObject, IChildList, IDeferredInstantiationUIComponent, IFlexDisplayObject, IFlexModule, IInvalidating, ILayoutManagerClient, IPropertyChangeNotifier, IRepeaterClient, ISimpleStyleClient, IStyleClient, IToolTipManagerClient, IUIComponent, IValidatorListener |
| Subclasses | Button, ChartBase, ChartLabel, ComboBase, Container, DataGridDragProxy, DataTip, DateChooser, DualStyleObject, FormHeading, HRule, Label, LegendItem, ListItemDragProxy, ListItemRenderer, MenuBar, MenuBarItem, MenuItemRenderer, NumericStepper, PopUpButtonSkin, ProgressBar, Repeater, ScrollBar, ScrollControlBase, Slider, Spacer, SwatchSkin, SWFLoader, TextInput, TileListItemRenderer, ToolTip, TreeItemRenderer, VideoDisplay, VRule |
An interactive component can participate in tabbing and other kinds of keyboard focus manipulation, accept low-level events like keyboard and mouse input, and be disabled so that it does not receive keyboard and mouse input. This is in contrast to noninteractive components, like Label and ProgressBar, which simply display contents and are not manipulated by the user.
The UIComponent class is not used as an MXML tag, but is used as a base class for other classes.
MXML Syntax
Hide MXML Syntax
All user interface components in Flex extend the UIComponent class. Flex components inherit the following properties from the UIComponent class:
Show MXML Syntax
<mx:tagname
Properties
automationName="null"
cachePolicy="auto|on|off"
currentState="null"
doubleClickEnabled="true|false"
enabled="true|false"
explicitHeight="NaN"
explicitMaxHeight="NaN"
explicitMaxWidth="NaN"
explicitMinHeight="NaN"
explicitMinWidth="NaN"
explicitWidth="NaN"
focusEnabled="true|false"
height="0"
id=""
includeInLayout="true|false"
maxHeight="10000"
maxWidth="10000"
measuredHeight=
measuredMinHeight=
measuredMinWidth=
measuredWidth=
minHeight="0"
minWidth="0"
mouseFocusEnabled="true|false"
percentHeight="NaN"
percentWidth="NaN"
scaleX="1.0"
scaleY="1.0"
states="null"
styleName="undefined"
toolTip="null"
transitions=""
validationSubField
width="0"
x="0"
y="0"
Styles
bottom="undefined"
errorColor="0xFF0000"
focusBlendMode="normal"
focusSkin="HaloFocusRect""
focusThickness="2"
horizontalCenter="undefined"
left="undefined"
right="undefined"
themeColor="haloGreen"
top="undefined"
verticalCenter="undefined"
Effects
addedEffect="No default"
creationCompleteEffect="No default"
focusInEffect="No default"
focusOutEffect="No default"
hideEffect="No default"
mouseDownEffect="No default"
mouseUpEffect="No default"
moveEffect="No default"
removedEffect="No default"
resizeEffect="No default"
rollOutEffect="No default"
rollOverEffect="No default"
showEffect="No default"
Events
add="No default"
creationComplete="No default"
currentStateChange="No default"
currentStateChanging="No default"
dragComplete="No default"
dragDrop="No default"
dragEnter="No default"
dragExit="No default"
dragOver="No default"
effectEnd="No default"
effectStart="No default"
enterState="No default"
exitState="No default"
hide="No default"
initialize="No default"
invalid="No default"
mouseDownOutside="No default"
mouseWheelOutside="No default"
move="No default"
preinitialize="No default"
record="No default"
remove="No default"
resize="No default"
show="No default"
toolTipCreate="No default"
toolTipEnd="No default"
toolTipHide="No default"
toolTipShow="No default"
toolTipShown="No default"
toolTipStart="No default"
updateComplete="No default"
valid="No default"
valueCommit="No default"
>
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 | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality.
| UIComponent | ||
| automationName : String
Name that can be used as an identifier for this object.
| UIComponent | ||
| automationTabularData : Object
[read-only]
An implementation of the
IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | ||
| 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.
| UIComponent | ||
| baselinePosition : Number
[read-only]
Determines the baseline y-coordinate
of the first line of text of the component.
| UIComponent | ||
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use.
| DisplayObject | |
| buttonMode : Boolean
Specifies the button mode of this sprite.
| Sprite | |
| cacheAsBitmap : Boolean
If set to
true, Flash Player caches an internal bitmap representation of the
display object. | DisplayObject | |
| cacheHeuristic : Boolean
[write-only]
Used by Flex to suggest bitmap caching for the object.
| UIComponent | ||
| cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | ||
| className : String
[read-only]
The name of this instance's class, such as
"Button". | UIComponent | ||
| constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| contentMouseX : Number
[read-only]
Returns the x position of the mouse, in the content coordinate system.
| UIComponent | ||
| contentMouseY : Number
[read-only]
Returns the y position of the mouse, in the content coordinate system.
| UIComponent | ||
| contextMenu : ContextMenu
Specifies the context menu associated with this object.
| InteractiveObject | |
| currentState : String
The current view state of the component.
| UIComponent | ||
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the
createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | ||
| document : Object
A reference to the document object associated with this UIComponent.
| UIComponent | ||
| doubleClickEnabled : Boolean
Specifies whether the UIComponent object receives
doubleClick events. | UIComponent | ||
| dropTarget : DisplayObject
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped.
| Sprite | |
| enabled : Boolean
Whether the component can accept user interaction.
| UIComponent | ||
| errorString : String
The text that will be displayed by a component's error tip when a
component is monitored by a Validator and validation fails.
| UIComponent | ||
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
| explicitMaxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
| explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
| explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
| explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
| filters : Array
An indexed array that contains each filter object currently associated with the display object.
| DisplayObject | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when clicked on.
| UIComponent | ||
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers.
| UIComponent | ||
| focusPane : Sprite
The focus pane associated with this object.
| UIComponent | ||
| focusRect : Object
Specifies whether this object displays a focus rectangle.
| InteractiveObject | |
| graphics : Graphics
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur.
| Sprite | |
| height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| UIComponent | ||
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
| Sprite | |
| id : String
ID of the component.
| UIComponent | ||
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container.
| UIComponent | ||
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles.
| UIComponent | ||
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required).
| UIComponent | ||
| instanceIndex : int
[read-only]
The index of a repeated component.
| UIComponent | ||
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document.
| UIComponent | ||
| isDocument : Boolean
[read-only]
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
| UIComponent | ||
| isPopUp : Boolean
Set to
true by the PopUpManager to indicate
that component has been popped up. | UIComponent | ||
| 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 | |
| maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
| maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
| measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | ||
| measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | ||
| measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | ||
| measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | ||
| minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
| minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
| moduleFactory : IFlexModuleFactory | UIComponent | ||
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
| DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse messages.
| InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | ||
| 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 | |
| name : String
Indicates the instance name of the DisplayObject.
| DisplayObject | |
| nestLevel : int
Depth of this object in the containment hierarchy.
| UIComponent | ||
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
| UIComponent | ||
| numAutomationChildren : int
[read-only]
The number of automation children this container has.
| UIComponent | ||
| numChildren : int
Returns the number of children of this object.
| DisplayObjectContainer | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
| DisplayObject | |
| owner : DisplayObjectContainer
The owner of this UIComponent.
| UIComponent | ||
| parent : DisplayObjectContainer
[read-only]
The parent container or component for this component.
| UIComponent | ||
| parentApplication : Object
[read-only]
A reference to the Application object that contains this UIComponent
instance.
| UIComponent | ||
| parentDocument : Object
[read-only]
A reference to the parent document object for this UIComponent.
| UIComponent | ||
| percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | ||
| percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | ||
| processedDescriptors : Boolean
Set to
true after immediate or deferred child creation,
depending on which one happens. | UIComponent | ||
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| repeater : IRepeater
[read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent.
| UIComponent | ||
| repeaterIndex : int
[read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent.
| UIComponent | ||
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent.
| UIComponent | ||
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent.
| UIComponent | ||
| 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
Number that specifies the horizontal scaling factor.
| UIComponent | ||
| scaleY : Number
Number that specifies the vertical scaling percentage.
| UIComponent | ||
| screen : Rectangle
[read-only]
Returns an object that contains the size and position of the base
drawing surface for this object.
| UIComponent | ||
| scrollRect : Rectangle
The scroll rectangle bounds of the display object.
| DisplayObject | |
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | ||
| soundTransform : SoundTransform
Controls sound within this sprite.
| Sprite | |
| stage : Stage
The Stage of the display object.
| DisplayObject | |
| states : Array
The view states that are defined for this component.
| UIComponent | ||
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
| UIComponent | ||
| styleName : Object
The class style used by this component.
| UIComponent | ||
| systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UIComponent | ||
| tabChildren : Boolean
Determines whether the children of the object are tab enabled.
| DisplayObjectContainer | |
| 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 | |
| textSnapshot : TextSnapshot
Returns a TextSnapshot object for this DisplayObjectContainer instance.
| DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip.
| UIComponent | ||
| transform : Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
| DisplayObject | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs.
| UIComponent | ||
| tweeningProperties : Array
Array of properties that are currently being tweened on this object.
| UIComponent | ||
| uid : String
A unique identifier for the object.
| UIComponent | ||
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required).
| UIComponent | ||
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls
over a sprite in which the
buttonMode property is set to true. | Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component.
| UIComponent | ||
| visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | ||
| width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| UIComponent | ||
| x : Number
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | ||
| y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent | ||
| Property | Defined by | ||
|---|---|---|---|
| unscaledHeight : Number
[read-only]
A convenience method for determining the unscaled height
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this height, which is also passed
as an argument to
updateDisplayList(). | UIComponent | ||
| unscaledWidth : Number
[read-only]
A convenience method for determining the unscaled width
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this width, which is also passed
as an argument to
updateDisplayList(). | UIComponent | ||
| Method | Defined by | ||
|---|---|---|---|
|
Constructor.
| UIComponent | ||
|
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
| DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance.
| DisplayObjectContainer | |
|
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 | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the
DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
|
Queues a function to be called later.
| UIComponent | ||
|
Deletes a style property from this component instance.
| UIComponent | ||
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself.
| DisplayObjectContainer | |
|
Converts a
Point object from content coordinates to global coordinates. | UIComponent | ||
|
Converts a
Point object from content to local coordinates. | UIComponent | ||
|
Returns a set of properties that identify the child within
this container.
| UIComponent | ||
|
Creates an
id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
|
Deletes the
id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent.
| UIComponent | ||
| UIComponent | |||
|
Shows or hides the focus indicator around this component.
| UIComponent | ||
|
drawRoundRect(x:Number, y:Number, width:Number, height:Number, cornerRadius:Object = null, color:Object = null, alpha:Object = null, gradientMatrix:Matrix = null, gradientType:String = "linear", gradientRatios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
| UIComponent | ||
|
Called by the effect instance when it stops playing on the component.
| UIComponent | ||
|
Called by the effect instance when it starts playing on the component.
| UIComponent | ||
|
Ends all currently playing effects on the component.
| UIComponent | ||
|
Executes the data bindings into this UIComponent object.
| UIComponent | ||
|
Called after printing is complete.
| UIComponent | ||
|
Provides the automation object at the specified index.
| UIComponent | ||
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the
targetCoordinateSpace object. | DisplayObject | |
|
Returns the child display object instance that exists at the specified index.
| DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name.
| DisplayObjectContainer | |
|
Returns the index position of a
child DisplayObject instance. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance.
| UIComponent | ||
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | ||
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | ||
|
Gets the object that currently has focus.
| UIComponent | ||
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance.
| DisplayObjectContainer | |
|
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 | |
|
Returns the item in the
dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | ||
|
Gets a style property that has been set anywhere in this
component's style lookup chain.
| UIComponent | ||
|
Converts a
Point object from global to content coordinates. | UIComponent | ||
|
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 | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | ||
|
Initializes the internal structure of this component.
| UIComponent | ||
|
Initializes various properties which keep track of repeated instances
of this component.
| UIComponent | ||
|
Marks a component so that its
updateDisplayList()
method gets called during a later screen update. | UIComponent | ||
|
Marks a component so that its
commitProperties()
method gets called during a later screen update. | UIComponent | ||
|
Marks a component so that its
measure()
method gets called during a later screen update. | UIComponent | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
|
Converts a
Point object from local to content coordinates. | UIComponent | ||
|
Converts the
point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Measures the specified HTML text, which may contain HTML tags such
as
<font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | ||
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
| UIComponent | ||
|
Moves the component to a specified position within its parent.
| UIComponent | ||
|
Propagate style changes to the children.
| UIComponent | ||
|
Returns
true if the chain of owner properties
points from child to this UIComponent. | UIComponent | ||
|
Called by Flex when a UIComponent object is added to or removed from a parent.
| UIComponent | ||
|
Prepares an IFlexDisplayObject for printing.
| UIComponent | ||
|
Indicates whether the specified property exists and is enumerable.
| Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the
recursive parameter is true,
for all descendants of this component as well. | UIComponent | ||
|
For each effect event, register the EffectManager
as one of the event listeners.
| UIComponent | ||
|
Removes the specified
child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified
index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
|
Removes a listener from the EventDispatcher object.
| EventDispatcher | |
|
Replays the specified event.
| UIComponent | ||
|
Resolves a child by using the id provided.
| UIComponent | ||
|
[static]
Resumes the background processing of methods
queued by
callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | ||
|
Sizes the object.
| UIComponent | ||
|
Changes the position of an existing child in the display object container.
| DisplayObjectContainer | |
|
Set the current state.
| UIComponent | ||
|
Sets the focus to this component.
| UIComponent | ||
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
Sets a style property on this component instance.
| UIComponent | ||
|
Called when the
visible property changes. | UIComponent | ||
|
Lets the user drag the specified sprite.
| Sprite | |
|
Ends the
startDrag() method. | Sprite | |
|
Detects changes to style properties.
| UIComponent | ||
|
Flex calls the
stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | ||
|
[static]
Blocks the background processing of methods
queued by
callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | ||
|
Swaps the z-order (front-to-back order) of the two specified child objects.
| DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list.
| DisplayObjectContainer | |
|
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | |
|
Validates the position and size of children and draws other
visuals.
| UIComponent | ||