BETA ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Hide Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes

Language Reference only
Filters: AIR 32.0 and earlier, Flash Player 32.0 and earlier, Flash Lite 4
None
Hide Filters
mx.core 

UIComponent  - AS3 Flex

Packagesx

Top Level
adobe.utils
air.desktop
air.net
air.update
air.update.events
coldfusion.air
coldfusion.air.errors
coldfusion.air.events
coldfusion.service
coldfusion.service.events
coldfusion.service.mxml
com.adobe.consulting.pst.vo
com.adobe.dct.event
com.adobe.dct.model
com.adobe.dct.service
com.adobe.dct.service.impl
com.adobe.dct.transfer
com.adobe.dct.util
com.adobe.exm.expression
com.adobe.exm.expression.error
com.adobe.exm.expression.event
com.adobe.exm.expression.impl
com.adobe.fiber.runtime.lib
com.adobe.fiber.services
com.adobe.fiber.services.wrapper
com.adobe.fiber.styles
com.adobe.fiber.util
com.adobe.fiber.valueobjects
com.adobe.icc.editors.events
com.adobe.icc.editors.handlers
com.adobe.icc.editors.managers
com.adobe.icc.editors.model
com.adobe.icc.editors.model.el
com.adobe.icc.editors.model.el.operands
com.adobe.icc.editors.model.el.operators
com.adobe.icc.enum
com.adobe.icc.obj
com.adobe.icc.services
com.adobe.icc.services.category
com.adobe.icc.services.config
com.adobe.icc.services.download
com.adobe.icc.services.export
com.adobe.icc.services.external
com.adobe.icc.services.fragmentlayout
com.adobe.icc.services.importexport
com.adobe.icc.services.layout
com.adobe.icc.services.letter
com.adobe.icc.services.locator
com.adobe.icc.services.module
com.adobe.icc.services.render
com.adobe.icc.services.submit
com.adobe.icc.services.user
com.adobe.icc.token
com.adobe.icc.vo
com.adobe.icc.vo.render
com.adobe.icomm.assetplacement.controller
com.adobe.icomm.assetplacement.controller.utils
com.adobe.icomm.assetplacement.model
com.adobe.livecycle.assetmanager.client
com.adobe.livecycle.assetmanager.client.event
com.adobe.livecycle.assetmanager.client.handler
com.adobe.livecycle.assetmanager.client.managers
com.adobe.livecycle.assetmanager.client.model
com.adobe.livecycle.assetmanager.client.model.cms
com.adobe.livecycle.assetmanager.client.service
com.adobe.livecycle.assetmanager.client.service.search
com.adobe.livecycle.assetmanager.client.service.search.cms
com.adobe.livecycle.assetmanager.client.utils
com.adobe.livecycle.rca.model
com.adobe.livecycle.rca.model.constant
com.adobe.livecycle.rca.model.document
com.adobe.livecycle.rca.model.participant
com.adobe.livecycle.rca.model.reminder
com.adobe.livecycle.rca.model.stage
com.adobe.livecycle.rca.service
com.adobe.livecycle.rca.service.core
com.adobe.livecycle.rca.service.core.delegate
com.adobe.livecycle.rca.service.process
com.adobe.livecycle.rca.service.process.delegate
com.adobe.livecycle.rca.token
com.adobe.mosaic.core
com.adobe.mosaic.core.events
com.adobe.mosaic.core.validators
com.adobe.mosaic.om.interfaces
com.adobe.mosaic.skins.aqua
com.adobe.mosaic.skins.aqua.organizer
com.adobe.mosaic.skins.aqua.tile
com.adobe.mosaic.skins.aqua.util
com.adobe.mosaic.skins.aqua.view
com.adobe.mosaic.skins.aqua.viewManager
com.adobe.mosaic.sparklib.editors
com.adobe.mosaic.sparklib.optionMenu
com.adobe.mosaic.sparklib.scrollableMenu
com.adobe.mosaic.sparklib.scrollableMenu.skins
com.adobe.mosaic.sparklib.tabLayout
com.adobe.mosaic.sparklib.tabLayout.events
com.adobe.mosaic.sparklib.tabLayout.layouts
com.adobe.mosaic.sparklib.tabLayout.skins
com.adobe.viewsource
fl.accessibility
fl.containers
fl.controls
fl.controls.dataGridClasses
fl.controls.listClasses
fl.controls.progressBarClasses
fl.core
fl.data
fl.display
fl.events
fl.ik
fl.lang
fl.livepreview
fl.managers
fl.motion
fl.motion.easing
fl.rsl
fl.text
fl.transitions
fl.transitions.easing
fl.video
flash.accessibility
flash.concurrent
flash.crypto
flash.data
flash.desktop
flash.display
flash.display3D
flash.display3D.textures
flash.errors
flash.events
flash.external
flash.filesystem
flash.filters
flash.geom
flash.globalization
flash.html
flash.media
flash.net
flash.net.dns
flash.net.drm
flash.notifications
flash.permissions
flash.printing
flash.profiler
flash.sampler
flash.security
flash.sensors
flash.system
flash.text
flash.text.engine
flash.text.ime
flash.ui
flash.utils
flash.xml
flashx.textLayout
flashx.textLayout.compose
flashx.textLayout.container
flashx.textLayout.conversion
flashx.textLayout.edit
flashx.textLayout.elements
flashx.textLayout.events
flashx.textLayout.factory
flashx.textLayout.formats
flashx.textLayout.operations
flashx.textLayout.utils
flashx.undo
ga.controls
ga.layouts
ga.model
ga.uiComponents
ga.util
ga.views
ga.wrappers
lc.foundation
lc.foundation.domain
lc.foundation.events
lc.foundation.ui
lc.foundation.util
lc.preloader
lc.procmgmt
lc.procmgmt.commands
lc.procmgmt.domain
lc.procmgmt.events
lc.procmgmt.formbridge
lc.procmgmt.impl
lc.procmgmt.ui.attachments
lc.procmgmt.ui.controls
lc.procmgmt.ui.controls.card
lc.procmgmt.ui.controls.renderer
lc.procmgmt.ui.endpoint
lc.procmgmt.ui.help
lc.procmgmt.ui.layout
lc.procmgmt.ui.presentationmodel
lc.procmgmt.ui.process
lc.procmgmt.ui.search
lc.procmgmt.ui.task
lc.procmgmt.ui.task.form
lc.procmgmt.ui.task.form.commands
lc.procmgmt.ui.tracking
mx.accessibility
mx.automation
mx.automation.air
mx.automation.delegates
mx.automation.delegates.advancedDataGrid
mx.automation.delegates.charts
mx.automation.delegates.containers
mx.automation.delegates.controls
mx.automation.delegates.controls.dataGridClasses
mx.automation.delegates.controls.fileSystemClasses
mx.automation.delegates.core
mx.automation.delegates.flashflexkit
mx.automation.events
mx.binding
mx.binding.utils
mx.charts
mx.charts.chartClasses
mx.charts.effects
mx.charts.effects.effectClasses
mx.charts.events
mx.charts.renderers
mx.charts.series
mx.charts.series.items
mx.charts.series.renderData
mx.charts.styles
mx.collections
mx.collections.errors
mx.containers
mx.containers.accordionClasses
mx.containers.dividedBoxClasses
mx.containers.errors
mx.containers.utilityClasses
mx.controls
mx.controls.advancedDataGridClasses
mx.controls.dataGridClasses
mx.controls.listClasses
mx.controls.menuClasses
mx.controls.olapDataGridClasses
mx.controls.scrollClasses
mx.controls.sliderClasses
mx.controls.textClasses
mx.controls.treeClasses
mx.controls.videoClasses
mx.core
mx.core.windowClasses
mx.data
mx.data.crypto
mx.data.errors
mx.data.events
mx.data.messages
mx.data.mxml
mx.data.offline.errors
mx.data.utils
mx.effects
mx.effects.easing
mx.effects.effectClasses
mx.events
mx.filters
mx.flash
mx.formatters
mx.geom
mx.graphics
mx.graphics.codec
mx.graphics.shaderClasses
mx.logging
mx.logging.errors
mx.logging.targets
mx.managers
mx.messaging
mx.messaging.channels
mx.messaging.config
mx.messaging.errors
mx.messaging.events
mx.messaging.management
mx.messaging.messages
mx.modules
mx.netmon
mx.olap
mx.olap.aggregators
mx.preloaders
mx.printing
mx.resources
mx.rpc
mx.rpc.events
mx.rpc.http
mx.rpc.http.mxml
mx.rpc.livecycle
mx.rpc.mxml
mx.rpc.remoting
mx.rpc.remoting.mxml
mx.rpc.soap
mx.rpc.soap.mxml
mx.rpc.wsdl
mx.rpc.xml
mx.skins
mx.skins.halo
mx.skins.spark
mx.skins.wireframe
mx.skins.wireframe.windowChrome
mx.states
mx.styles
mx.utils
mx.validators
org.osmf.containers
org.osmf.display
org.osmf.elements
org.osmf.events
org.osmf.layout
org.osmf.logging
org.osmf.media
org.osmf.metadata
org.osmf.net
org.osmf.net.dvr
org.osmf.net.httpstreaming
org.osmf.net.metrics
org.osmf.net.qos
org.osmf.net.rtmpstreaming
org.osmf.net.rules
org.osmf.traits
org.osmf.utils
spark.accessibility
spark.automation.delegates
spark.automation.delegates.components
spark.automation.delegates.components.gridClasses
spark.automation.delegates.components.mediaClasses
spark.automation.delegates.components.supportClasses
spark.automation.delegates.skins.spark
spark.automation.events
spark.collections
spark.components
spark.components.calendarClasses
spark.components.gridClasses
spark.components.mediaClasses
spark.components.supportClasses
spark.components.windowClasses
spark.core
spark.effects
spark.effects.animation
spark.effects.easing
spark.effects.interpolation
spark.effects.supportClasses
spark.events
spark.filters
spark.formatters
spark.formatters.supportClasses
spark.globalization
spark.globalization.supportClasses
spark.layouts
spark.layouts.supportClasses
spark.managers
spark.modules
spark.preloaders
spark.primitives
spark.primitives.supportClasses
spark.skins
spark.skins.mobile
spark.skins.mobile.supportClasses
spark.skins.spark
spark.skins.spark.mediaClasses.fullScreen
spark.skins.spark.mediaClasses.normal
spark.skins.spark.windowChrome
spark.skins.wireframe
spark.skins.wireframe.mediaClasses
spark.skins.wireframe.mediaClasses.fullScreen
spark.transitions
spark.utils
spark.validators
spark.validators.supportClasses

Language Elements

Global Constants
Global Functions
Operators
Statements, Keywords & Directives
Special Types

Appendixes

What's New
Compiler Errors
Compiler Warnings
Run-Time Errors
Migrating to ActionScript 3
Supported Character Sets
MXML Only Tags
Motion XML Elements
Timed Text Tags
List of deprecated elements
Accessibility Implementation Constants
How to Use ActionScript Examples
Legal notices
(Preview)
Packagemx.core
Classpublic class UIComponent
InheritanceUIComponent Inheritance FlexSprite Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IAutomationObject, IChildList, IConstraintClient, IDeferredInstantiationUIComponent, IFlexDisplayObject, IFlexModule, IInvalidating, ILayoutManagerClient, IPropertyChangeNotifier, IRepeaterClient, IStateClient, IAdvancedStyleClient, IToolTipManagerClient, IUIComponent, IValidatorListener, IVisualElement
Subclasses AdvancedDataGridDragProxy, AdvancedDataGridGroupItemRenderer, AdvancedDataGridHeaderRenderer, AdvancedDataGridSortItemRenderer, BoxDivider, BusyIndicator, Button, CalloutArrow, ChartBase, ChartItemDragProxy, ChartLabel, ComboBase, Container, DataGridDragProxy, DataGridHeaderBase, DataTip, DateChooser, DefaultItemRenderer, DefaultItemRenderer, DualStyleObject, FormHeading, GroupBase, HighlightBitmapCaptureSkin, HRule, HSliderDataTip, Label, LabelItemRenderer, Legend, LegendItem, ListBaseContentHolder, ListItemDragProxy, ListItemRenderer, MenuBar, MenuBarItem, MenuItemRenderer, MobileSkin, NumericStepper, OLAPDataGridGroupRenderer, PopUpAnchor, PopUpButtonSkin, ProgressBar, RectangularDropShadow, Repeater, RichEditableText, ScrollBar, ScrollControlBase, SkinnableComponent, Slider, Spacer, StatusBar, StyleableStageText, SwatchSkin, SWFLoader, TextBase, TextInput, TileListItemRenderer, TitleBar, ToolTip, TreeItemRenderer, VideoDisplay, VideoDisplay, VRule, WindowCloseButtonSkin, WindowMaximizeButtonSkin, WindowMinimizeButtonSkin, WindowRestoreButtonSkin

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The UIComponent class is the base class for all visual components, both interactive and noninteractive.

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 SyntaxexpandedHide MXML Syntax

All user interface components in Flex extend the UIComponent class. Flex components inherit the following properties from the UIComponent class:

  <mx:tagname
   Properties 
    accessibilityDescription="null"
    accessibilityName="null"
    accessibilityShortcut="null"
    accessibilitySilent="true|false"
    automationName="null"
    cachePolicy="auto|on|off"
    currentState="null"
    doubleClickEnabled="false|true"
    enabled="true|false"
    explicitHeight="NaN"
    explicitMaxHeight="NaN"
    explicitMaxWidth="NaN"
    explicitMinHeight="NaN"
    explicitMinWidth="NaN"
    explicitWidth="NaN"
    focusEnabled="true|false"
    hasFocusableChildren="false|true"
    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"
    layoutDirection="ltr"
    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"
    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"
  >
  

More examples

Related API Elements



Public Properties
 PropertyDefined By
  accessibilityDescription : String
A convenience accessor for the description property in this UIComponent's accessibilityProperties object.
UIComponent
  accessibilityEnabled : Boolean
A convenience accessor for the silent property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.
InteractiveObject
  accessibilityName : String
A convenience accessor for the name property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
  accessibilityShortcut : String
A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object.
UIComponent
  activeEffects : Array
[read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
 Inheritedalpha : Number
Indicates the alpha transparency value of the object specified.
DisplayObject
  automationDelegate : Object
The delegate object that handles the automation-related functionality.
UIComponent
  automationEnabled : Boolean
[read-only] True if this component is enabled for automation, false otherwise.
UIComponent
  automationName : String
Name that can be used as an identifier for this object.
UIComponent
  automationOwner : DisplayObjectContainer
[read-only] The owner of this component for automation purposes.
UIComponent
  automationParent : DisplayObjectContainer
[read-only] The parent of this component for automation purposes.
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
  automationVisible : Boolean
[read-only] True if this component is visible for automation, false otherwise.
UIComponent
  baseline : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
  baselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
UIComponent
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
DisplayObject
 InheritedblendShader : Shader
[write-only] Sets a shader that is used for blending the foreground and background.
DisplayObject
  bottom : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
 InheritedcacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the display object.
DisplayObject
 Inherited    cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true.
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
 Inheritedconstructor : 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
 InheritedcontextMenu : NativeMenu
Specifies the context menu associated with this object.
InteractiveObject
  currentState : String
The current view state of the component.
UIComponent
  cursorManager : ICursorManager
[read-only] Gets the CursorManager that controls the cursor for this component and its peers.
UIComponent
  depth : Number
Determines the order in which items inside of containers are rendered.
UIComponent
  descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
  designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual element.
UIComponent
  document : Object
A reference to the document object associated with this UIComponent.
UIComponent
  doubleClickEnabled : Boolean
[override] Specifies whether the UIComponent object receives doubleClick events.
UIComponent
 InheriteddropTarget : DisplayObject
[read-only] 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 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
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
  explicitMaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
  explicitMinHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
  explicitMinWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
  explicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIComponent
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
DisplayObject
  flexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
UIComponent
  focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
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
 InheritedfocusRect : Object
Specifies whether this object displays a focus rectangle.
InteractiveObject
 Inheritedgraphics : Graphics
[read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.
Sprite
  hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus.
UIComponent
  hasLayoutMatrix3D : Boolean
[read-only] Contains true if the element has 3D Matrix.
UIComponent
  height : Number
[override] Number that specifies the height of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
  horizontalCenter : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
  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
  is3D : Boolean
[read-only] Contains true when the element is in 3D.
UIComponent
  isDocument : Boolean
[read-only] Contains true if this UIComponent instance is a document object.
UIComponent
  isPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
  layoutMatrix3D : Matrix3D
[write-only] The transform matrix that is used to calculate a component's layout relative to its siblings.
UIComponent
  left : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
  maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the middle of its bounding box.
UIComponent
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
DisplayObject
  maxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
  maxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
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
 InheritedmetaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
DisplayObject
  minHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
  minWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
  moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component.
UIComponent
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages.
InteractiveObject
  mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.
DisplayObject
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
 InheritedneedsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.
InteractiveObject
  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
 InheritednumChildren : int
[read-only] Returns the number of children of this object.
DisplayObjectContainer
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
  owner : DisplayObjectContainer
The owner of this IVisualElement object.
UIComponent
  parent : DisplayObjectContainer
[override] [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
Specifies the height of a component as a percentage of its parent's size.
UIComponent
  percentWidth : Number
Specifies the width of a component as a percentage of its parent's size.
UIComponent
  postLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout.
UIComponent
  processedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
  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
  right : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 Inheritedroot : DisplayObject
[read-only] 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
[override] Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
UIComponent
  rotationX : Number
[override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
  rotationY : Number
[override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
  rotationZ : Number
[override] Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
  scaleX : Number
[override] Number that specifies the horizontal scaling factor.
UIComponent
  scaleY : Number
[override] Number that specifies the vertical scaling factor.
UIComponent
  scaleZ : Number
[override] Number that specifies the scaling factor along the z axis.
UIComponent
  screen : Rectangle
[read-only] Returns an object that contains the size and position of the base drawing surface for this object.
UIComponent
 InheritedscrollRect : 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
 Inherited    softKeyboard : String
Controls the appearance of the soft keyboard.
InteractiveObject
 InheritedsoftKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
InteractiveObject
 InheritedsoundTransform : flash.media:SoundTransform
Controls sound within this sprite.
Sprite
 Inheritedstage : Stage
[read-only] 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
  styleManager : IStyleManager2
[read-only] Returns the StyleManager instance used by this component.
UIComponent
  styleName : Object
The class style used by this component.
UIComponent
  styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors.
UIComponent
  systemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 InheritedtabChildren : Boolean
Determines whether the children of the object are tab enabled.
DisplayObjectContainer
 InheritedtabEnabled : Boolean
Specifies whether this object is in the tab order.
InteractiveObject
  tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus via the TAB key This is similar to the tabEnabled property used by the Flash Player. This is usually true for components that handle keyboard input, but some components in controlbars have them set to false because they should not steal focus from another component like an editor.
UIComponent
 InheritedtabIndex : int
Specifies the tab ordering of objects in a SWF file.
InteractiveObject
 InheritedtextSnapshot : flash.text:TextSnapshot
[read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.
DisplayObjectContainer
  toolTip : String
Text to display in the ToolTip.
UIComponent
  top : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
  transform : flash.geom:Transform
[override] An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
UIComponent
  transformX : Number
Sets the x coordinate for the transform center of the component.
UIComponent
  transformY : Number
Sets the y coordinate for the transform center of the component.
UIComponent
  transformZ : Number
Sets the z coordinate for the transform center of the component.
UIComponent
  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
 InheriteduseHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer 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
  verticalCenter : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
  visible : Boolean
[override] Whether or not the display object is visible.
UIComponent
  width : Number
[override] Number that specifies the width of the component, in pixels, in the parent's coordinates.
UIComponent
  x : Number
[override] Number that specifies the component's horizontal position, in pixels, within its parent container.
UIComponent
  y : Number
[override] Number that specifies the component's vertical position, in pixels, within its parent container.
UIComponent
  z : Number
[override] Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.
UIComponent
Protected Properties
 PropertyDefined By
  currentCSSState : String
[read-only] The state to be used when matching CSS pseudo-selectors.
UIComponent
  hasComplexLayoutMatrix : Boolean
[read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties.
UIComponent
  resourceManager : IResourceManager
[read-only] A reference to the object which manages all of the application's localized resources.
UIComponent
  unscaledHeight : Number
[read-only] A convenience method for determining the unscaled height of the component.
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
Public Methods
 MethodDefined By
  
Constructor.
UIComponent
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
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
  
Adds a non-visual style client to this component instance.
UIComponent
 Inherited
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
  
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
  
Deletes a style property from this component instance.
UIComponent
 Inherited
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
  
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
  
[override] Dispatches an event into the event flow.
UIComponent
  
Shows or hides the focus indicator around this component.
UIComponent
  
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically 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
  
executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination.
UIComponent
  
Called after printing is complete.
UIComponent
  
Provides the automation object at the specified index.
UIComponent
  
Provides the automation object list .
UIComponent
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.
DisplayObject
  
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size.
UIComponent
  
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
Returns the child display object instance that exists at the specified index.
DisplayObjectContainer
 Inherited
Returns the child display object that exists with the specified name.
DisplayObjectContainer
 Inherited
Returns the index position of a child DisplayObject instance.
DisplayObjectContainer
  
Finds the type selectors for this UIComponent instance.
UIComponent
  
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as getting the constraint style for this component.
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
  
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height.
UIComponent
  
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width.
UIComponent
  
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen.
UIComponent
  
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen.
UIComponent
  
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
UIComponent
  
Returns the layout transform Matrix3D for this element.
UIComponent
  
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height.
UIComponent
  
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width.
UIComponent
  
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height.
UIComponent
  
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width.
UIComponent
 Inherited
Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.
DisplayObjectContainer
  
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height.
UIComponent
  
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width.
UIComponent
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
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
  
getRepeaterItem(whichRepeater:int = -1):Object
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
  
getStyle(styleProp:String):*
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
 Inherited
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
DisplayObject
 Inherited
Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.
DisplayObject
  
Returns true if currentCSSState is not null.
UIComponent
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
  
Determines whether the specified state has been defined on this UIComponent.
UIComponent
 Inherited
Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.
DisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
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
  
Called by a component's items to indicate that their depth property has changed.
UIComponent
  
An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.
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
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
DisplayObject
  
Converts a Point object from local to content coordinates.
UIComponent
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
  
Returns true if cssState matches currentCSSState.
UIComponent
  
Determines whether this instance is the same as, or is a subclass of, the given type.
UIComponent
  
Measures the specified HTML text, which can 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 (or UIFTETextField) using a UITextFormat determined by the styles of this UIComponent.
UIComponent
  
Moves the component to a specified position within its parent.
UIComponent
  
Propagates 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
 Inherited
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, registers the EffectManager as one of the event listeners.
UIComponent
 Inherited
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.
DisplayObjectContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
  
Removes a non-visual style client from this component instance.
UIComponent
  
Replays the specified event.
UIComponent
 Inherited
Raises a virtual keyboard.
InteractiveObject
  
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
 Inherited
Changes the position of an existing child in the display object container.
DisplayObjectContainer
  
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
  
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
  
Sets the focus to this component.
UIComponent
  
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen.
UIComponent
  
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element.
UIComponent
  
setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
  
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
  
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
UIComponent
  
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
UIComponent
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite.
Sprite
 Inherited
startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite on a touch-enabled device.
Sprite
 Inherited
Recursively stops the timeline execution of all MovieClips rooted at this object.
DisplayObjectContainer
 Inherited
Ends the startDrag() method.
Sprite
 Inherited
stopTouchDrag(touchPointID:int):void
Ends the startTouchDrag() method, for use with touch-enabled devices.
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
 Inherited
Swaps the z-order (front-to-back order) of the two specified child objects.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.
DisplayObjectContainer
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
  
transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space.
UIComponent
  
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates.
UIComponent
  
Validates the position and size of children and draws other visuals.
UIComponent
  
Validate and update the properties and layout of this object and redraw it, if necessary.
UIComponent
  
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
UIComponent
  
validateSize(recursive:Boolean = false):void
Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements.
UIComponent
  
Handles both the valid and invalid events from a validator assigned to this component.
UIComponent
 Inherited
Returns the primitive value of the specified object.
Object
  
Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.
UIComponent
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
  
Adjust the focus rectangle.
UIComponent
  
Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform.
UIComponent
  
This is an internal method used by the Flex framework to support the Dissolve effect.
UIComponent
  
Determines if the call to the measure() method can be skipped.
UIComponent
  
Performs any final processing after child objects are created.
UIComponent
  
Processes the properties set on the component.
UIComponent
  
Create child objects of the component.
UIComponent
  
Creates a new object using a context based on the embedded font being used.
UIComponent
  
Creates the object using a given moduleFactory.
UIComponent
  
dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent when a property is updated.
UIComponent
  
The event handler called when a UIComponent object gets focus.
UIComponent
  
The event handler called when a UIComponent object loses focus.
UIComponent
  
Initializes the implementation and storage of some of the less frequently used advanced layout features of a component.
UIComponent
  
Finalizes the initialization of this component.
UIComponent
  
Initializes this component's accessibility code.
UIComponent
  
Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).
UIComponent
  
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
  
The event handler called for a keyDown event.
UIComponent
  
The event handler called for a keyUp event.
UIComponent
  
Calculates the default size, and optionally the default minimum size, of the component.
UIComponent
  
This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.
UIComponent
  
setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction.
UIComponent
  
stateChanged(oldState:String, newState:String, recursive:Boolean):void
This method is called when a state changes to check whether state-specific styles apply to this component.
UIComponent
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Draws the object and/or sizes and positions its children.
UIComponent
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
  Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.UIComponent
 InheritedDispatched when a display object is added to the display list.DisplayObject
 InheritedDispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 InheritedDispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 InheritedDispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.InteractiveObject
 Inherited
    contextMenu
Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.InteractiveObject
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.InteractiveObject
  Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
  Dispatched after the view state has changed.UIComponent
  Dispatched after the currentState property changes, but before the view state changes.UIComponent
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.InteractiveObject
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 InheritedDispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.InteractiveObject
  Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop.UIComponent
  Dispatched by the drop target when the user releases the mouse over it.UIComponent
  Dispatched by a component when the user moves the mouse over the component during a drag operation.UIComponent
  Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIComponent
  Dispatched by a component when the user moves the mouse while over the component during a drag operation.UIComponent
  Dispatched by the drag initiator when starting a drag operation.UIComponent
  Dispatched after an effect ends.UIComponent
  Dispatched just before an effect starts.UIComponent
  Dispatched after an effect is stopped, which happens only by a call to stop() on the effect.UIComponent
 Inherited[broadcast event] Dispatched when the playhead is entering a new frame.DisplayObject
  Dispatched after the component has entered a view state.UIComponent
 Inherited[broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
  Dispatched just before the component exits a view state.UIComponent
 InheritedDispatched after a display object gains focus.InteractiveObject
 InheritedDispatched after a display object loses focus.InteractiveObject
 Inherited[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 InheritedDispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) Some devices might also interpret this contact as a combination of several touch events, as well.InteractiveObject
 InheritedDispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
  Dispatched when an object's state changes from visible to invisible.UIComponent
 InheritedThis event is dispatched to any client app that supports inline input with an IMEInteractiveObject
  Dispatched when the component has finished its construction and has all initialization properties set.UIComponent
  Dispatched when a component is monitored by a Validator and the validation failed.UIComponent
 InheritedDispatched when the user presses a key.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 InheritedDispatched when the user releases a key.InteractiveObject
 InheritedDispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
  Dispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 InheritedDispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 InheritedDispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
  Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
  Dispatched when the object has moved.UIComponent
 InheritedDispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 InheritedDispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject continually while a drag gesture remains within its boundary.InteractiveObject
 InheritedDispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.InteractiveObject
  Dispatched at the beginning of the component initialization sequence.UIComponent
 InheritedDispatched when the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject
 Inherited
    proximityEnd
Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold.InteractiveObject
 Inherited
    proximityOut
Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen).InteractiveObject
 InheritedDispatched when a user releases the button on the pointing device after the user first pressed the button over an InteractiveObject instance and then moved the pointing device off of the InteractiveObject instance.InteractiveObject
  Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.UIComponent
 InheritedDispatched when a display object is about to be removed from the display list.DisplayObject
 InheritedDispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited[broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
  Dispatched when the component is resized.UIComponent
 InheritedDispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.InteractiveObject
  Dispatched when an object's state changes from invisible to visible.UIComponent
 InheritedDispatched immediately after the soft keyboard is raised.InteractiveObject
 InheritedDispatched immediately before the soft keyboard is raised.InteractiveObject
 InheritedDispatched immediately after the soft keyboard is lowered.InteractiveObject
  Dispatched after the component has entered a new state and any state transition animation to that state has finished playing.UIComponent
  Dispatched when a component interrupts a transition to its current state in order to switch to a new state.UIComponent
 InheritedDispatched when the value of the object's tabChildren flag changes.InteractiveObject
 InheritedDispatched when the object's tabEnabled flag changes.InteractiveObject
 InheritedDispatched when the value of the object's tabIndex property changes.InteractiveObject
 InheritedDispatched when a user enters one or more characters of text.InteractiveObject
  Dispatched by the component when it is time to create a ToolTip.UIComponent
  Dispatched by the component when its ToolTip has been hidden and is to be discarded soon.UIComponent
  Dispatched by the component when its ToolTip is about to be hidden.UIComponent
  Dispatched by the component when its ToolTip is about to be shown.UIComponent
  Dispatched by the component when its ToolTip has been shown.UIComponent
  Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIComponent
 InheritedDispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
  A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture.UIComponent
  A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture.UIComponent
  A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture.UIComponent
 InheritedDispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.InteractiveObject
 InheritedDispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
  Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).UIComponent
  Dispatched when a component is monitored by a Validator and the validation succeeded.UIComponent
  Dispatched when values are changed programmatically or by user interaction.UIComponent
Styles

Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.

Common Styles
 Style Description Defined By
  
baseline
Type: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The vertical distance in pixels from the top edge of the content area to the control's baseline position. If this style is set, the baseline of the component is anchored to the top edge of its content area; when its container is resized, the two edges maintain their separation.

This style only has an effect when used on a component in a Canvas container, or when used on a component in a Panel or Application container that has the layout property set to absolute.

The default value is undefined, which means it is not set.

UIComponent
  
bottom
Type: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. If this style is set, the lower edge of the component is anchored to the bottom edge of its content area; when its container is resized, the two edges maintain their separation.

This style only has an effect when used on a component in a Canvas container, or when used on a component in a Panel or Application container that has the layout property set to absolute.

The default value is undefined, which means it is not set.

UIComponent
  
errorColor
Type: uint Format: Color CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

Color of the component highlight when validation fails. Flex also sets the borderColor style of the component to this errorColor on a validation failure. The default value for the Halo theme is 0xFF0000. The default value for the Spark theme is 0xFE0000.
UIComponent
  
focusBlendMode
Type: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

Blend mode used by the focus rectangle. For more information, see the blendMode property of the flash.display.DisplayObject class. The default value is "normal".
UIComponent
  
focusSkin
Type: Class CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

Skin used to draw the focus rectangle. The default value for Halo components is mx.skins.halo.HaloFocusRect. The default value for Spark components is spark.skins.spark.FocusSkin.
UIComponent
  
focusThickness
Type: Number Format: Length CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

Thickness, in pixels, of the focus rectangle outline. The default value is 2.
UIComponent
  
horizontalCenter
Type: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The horizontal distance in pixels from the center of the component's content area to the center of the component. If this style is set, the center of the component is anchored to the center of its content area; when its container is resized, the two centers maintain their horizontal separation.

This style only has an effect when used on a component in a Canvas container, or when used on a component in a Panel or Application container that has the layout property set to absolute.

The default value is undefined, which means it is not set.

UIComponent
  
interactionMode
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10, AIR 2.5

The primary interaction mode for this component. The acceptable values are: mouse and touch. The default value for the Halo theme is mouse. The default value for the Spark theme is mouse. The default value for the Mobile theme is touch.

Related API Elements

UIComponent
  
layoutDirection
Type: String CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.1  Runtime Versions: Flash10, AIR 1.5

Specifies the desired layout direction of a component. The allowed values are "ltr" for left-to-right layout, used for components using Latin-style scripts, and "rtl" for right-to-left layout, used for components using scripts such as Arabic and Hebrew.

In ActionScript you can set the layoutDirection using the values mx.core.LayoutDirection.LTR, mx.core.LayoutDirection.RTL or undefined, to inherit the layoutDirection from the parent.

The layoutDirection should typically be set on the Application rather than on individual components. If the layoutDirection is "rtl", most visual elements, except text and images, will be mirrored. The directionality of text is determined by the direction style.

Components which handle Keyboard.LEFT and Keyboard.RIGHT events typically swap the key’s meaning when layoutDirection is “rtl”. In other words, left always means move left and right always means move right, regardless of the layoutDirection

Note: This style applies to all Spark components and MX components that specify UIFTETextField as their textFieldClass.

The default value is "ltr".

Related API Elements

UIComponent
  
left
Type: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. If this style is set, the left edge of the component is anchored to the left edge of its content area; when its container is resized, the two edges maintain their separation.

This style only has an effect when used on a component in a Canvas container, or when used on a component in a Panel or Application container that has the layout property set to absolute.

The default value is undefined, which means it is not set.

UIComponent
  
right
Type: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. If this style is set, the right edge of the component is anchored to the right edge of its content area; when its container is resized, the two edges maintain their separation.

This style only has an effect when used on a component in a Canvas container, or when used on a component in a Panel or Application container that has the layout property set to absolute.

The default value is undefined, which means it is not set.

UIComponent
  
showErrorSkin
Type: Boolean CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10, AIR 1.5

Show the error border or skin when this component is invalid The default value is true.
UIComponent
  
showErrorTip
Type: Boolean CSS Inheritance: Yes
Language Version: ActionScript 3.0  Product Version: Flex 4.5  Runtime Versions: Flash10, AIR 1.5

Show the error tip when this component is invalid and the user rolls over it The default value is true.
UIComponent
  
top
Type: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. If this style is set, the top edge of the component is anchored to the top edge of its content area; when its container is resized, the two edges maintain their separation.

This style only has an effect when used on a component in a Canvas container, or when used on a component in a Panel or Application container that has the layout property set to absolute.

The default value is undefined, which means it is not set.

UIComponent
  
verticalCenter
Type: String CSS Inheritance: No
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

The vertical distance in pixels from the center of the component's content area to the center of the component. If this style is set, the center of the component is anchored to the center of its content area; when its container is resized, the two centers maintain their vertical separation.

This style only has an effect when used on a component in a Canvas container, or when used on a component in a Panel or Application container that has the layout property set to absolute.

The default value is undefined, which means it is not set.

UIComponent
Spark Theme Styles
 Style Description Defined By
  
chromeColor
Type: uint Format: Color CSS Inheritance: Yes Theme: spark
Language Version: ActionScript 3.0  Product Version: Flex 4  Runtime Versions: Flash10, AIR 1.5

The main color for a component.
UIComponent
Halo Theme Styles
 Style Description Defined By
  
themeColor
Type: uint Format: Color CSS Inheritance: Yes Theme: halo
Language Version: ActionScript 3.0  Product Version: Flex 3  Runtime Versions: Flash9, AIR 1.1

Theme color of a component. This property controls the appearance of highlights, appearance when a component is selected, and other similar visual cues, but it does not have any effect on the regular borders or background colors of the component. The preferred values are haloGreen, haloBlue, haloOrange, and haloSilver, although any valid color value can be used.

The default values of the rollOverColor and selectionColor styles are based on the themeColor value.

The default value is "haloBlue".
UIComponent
Effects
 Effect Description Defined By
  
addedEffect
Triggering Event: added
Played when the component is added as a child to a Container.
UIComponent
  
creationCompleteEffect
Triggering Event: creationComplete
Played when the component is created.
UIComponent
  
focusInEffect
Triggering Event: focusIn
Played when the component gains keyboard focus.
UIComponent
  
focusOutEffect
Triggering Event: focusOut
Played when the component loses keyboard focus.
UIComponent
  
hideEffect
Triggering Event: hide
Played when the component becomes invisible.
UIComponent
  
mouseDownEffect
Triggering Event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
  
mouseUpEffect
Triggering Event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
  
moveEffect
Triggering Event: move
Played when the component is moved.
UIComponent
  
removedEffect
Triggering Event: removed
Played when the component is removed from a Container.
UIComponent
  
resizeEffect
Triggering Event: resize
Played when the component is resized.
UIComponent
  
rollOutEffect
Triggering Event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
  
rollOverEffect
Triggering Event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
  
showEffect
Triggering Event: show
Played when the component becomes visible.
UIComponent
Public Constants
 ConstantDefined By
  DEFAULT_MAX_HEIGHT : Number = 10000
[static] The default value for the maxHeight property.
UIComponent
  DEFAULT_MAX_WIDTH : Number = 10000
[static] The default value for the maxWidth property.
UIComponent
  DEFAULT_MEASURED_HEIGHT : Number = 22
[static] The default value for the measuredHeight property.
UIComponent
  DEFAULT_MEASURED_MIN_HEIGHT : Number = 22
[static] The default value for the measuredMinHeight property.
UIComponent
  DEFAULT_MEASURED_MIN_WIDTH : Number = 40
[static] The default value for the measuredMinWidth property.
UIComponent
  DEFAULT_MEASURED_WIDTH : Number = 160
[static] The default value for the measuredWidth property.
UIComponent
Property Detail
Constructor Detail
Method Detail
Event Detail
Constant Detail