Packagemx.core
Classpublic class UIComponent
InheritanceUIComponent Inheritance FlexSprite Inheritance flash.display.Sprite
Implements IAutomationObject, IChildList, IConstraintClient, IDeferredInstantiationUIComponent, IFlexDisplayObject, IFlexModule, IInvalidating, ILayoutManagerClient, IPropertyChangeNotifier, IRepeaterClient, IStateClient, IAdvancedStyleClient, IToolTipManagerClient, IUIComponent, IValidatorListener, IVisualElement
Subclasses DefaultItemRenderer, GroupBase, LabelItemRenderer, MobileSkin, PopUpAnchor, RectangularDropShadow, RichEditableText, SkinnableComponent, TextBase, ToolTip

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

See also

mx.core.UIComponent


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
  accessibilityName : String
A convenience accessor for the name property in this UIComponent's accessibilityProperties object.
UIComponent
  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
  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
  bottom : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
  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
  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
  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
  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
  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
  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
  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
  maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the middle of its bounding box.
UIComponent
  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
  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
  mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
  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
  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 : 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
  rotation : Number
[override]
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]
UIComponent
  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
  showInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIComponent
  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
  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
  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 : 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
  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]
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
  
Adds a non-visual style client to this component instance.
UIComponent
  
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
  
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
UIComponent
  
contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates.
UIComponent
  
contentToLocal(point:Point):Point
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 as automation IDs 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
  
dispatchEvent(event:Event):Boolean
[override] Dispatches an event into the event flow.
UIComponent
  
drawFocus(isFocused:Boolean):void
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
  
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
UIComponent
  
Provides the automation object at the specified index.
UIComponent
  
Provides the automation object list .
UIComponent
  
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
  
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
  
getFocus():InteractiveObject
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
  
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height.
UIComponent
  
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width.
UIComponent
  
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
  
globalToContent(point:Point):Point
Converts a Point object from global to content coordinates.
UIComponent
  
hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this UIComponent.
UIComponent
  
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.
UIComponent
  
initialize():void
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
  
localToContent(point:Point):Point
Converts a Point object from local to content coordinates.
UIComponent
  
matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState.
UIComponent
  
matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of, the given type.
UIComponent
  
measureHTMLText(htmlText:String):TextLineMetrics
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
  
measureText(text:String):TextLineMetrics
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
  
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
UIComponent
  
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
UIComponent
  
owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
  
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
  
Prepares an IFlexDisplayObject for printing.
UIComponent
  
regenerateStyleCache(recursive:Boolean):void
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
  
registerEffects(effects:Array):void
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
  
Removes a non-visual style client from this component instance.
UIComponent
  
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
UIComponent
  
resolveAutomationIDPart(criteria:Object):Array
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
  
setActualSize(w:Number, h:Number):void
Sizes the object.
UIComponent
  
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
  
setFocus():void
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
  
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
  
styleChanged(styleProp:String):void
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
toString():String
[override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexSprite
  
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
  
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.
UIComponent
Protected Methods
 MethodDefined By
  
adjustFocusRect(obj:DisplayObject = null):void
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
  
createInFontContext(classObj:Class):Object
Creates a new object using a context based on the embedded font being used.
UIComponent
  
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
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
  
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus.
UIComponent
  
focusOutHandler(event:FocusEvent):void
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
  
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
  
keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event.
UIComponent
  
keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event.
UIComponent
  
measure():void
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
  Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.UIComponent
  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
  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
  Dispatched after the component has entered a view state.UIComponent
  Dispatched just before the component exits a view state.UIComponent
  Dispatched when an object's state changes from visible to invisible.UIComponent
  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
  Dispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
  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
  Dispatched at the beginning of the component initialization sequence.UIComponent
  Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.UIComponent
  Dispatched when the component is resized.UIComponent
  Dispatched when an object's state changes from invisible to visible.UIComponent
  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
  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
  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
  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
 Style Description Defined By
  
baseline
Type: String CSS Inheritance: no
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
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
  
chromeColor
Type: uint Format: Color CSS Inheritance: yes Theme: spark
The main color for a component.
UIComponent
  
errorColor
Type: uint Format: Color CSS Inheritance: yes
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
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
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
Thickness, in pixels, of the focus rectangle outline. The default value is 2.
UIComponent
  
horizontalCenter
Type: String CSS Inheritance: no
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
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.

See also

UIComponent
  
layoutDirection
Type: String CSS Inheritance: yes
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".

See also

UIComponent
  
left
Type: String CSS Inheritance: no
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
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
Show the error border or skin when this component is invalid The default value is true.
UIComponent
  
showErrorTip
Type: Boolean CSS Inheritance: yes
Show the error tip when this component is invalid and the user rolls over it The default value is true.
UIComponent
  
themeColor
Type: uint Format: Color CSS Inheritance: yes Theme: halo
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
  
top
Type: String CSS Inheritance: no
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
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
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
accessibilityDescriptionproperty
accessibilityDescription:String

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

A convenience accessor for the description property in this UIComponent's accessibilityProperties object.

The getter simply returns accessibilityProperties.description, or "" if accessibilityProperties is null. The setter first checks whether accessibilityProperties is null, and if it is, sets it to a new AccessibilityProperties instance. Then it sets accessibilityProperties.description.


Implementation
    public function get accessibilityDescription():String
    public function set accessibilityDescription(value:String):void
accessibilityEnabledproperty 
accessibilityEnabled:Boolean

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

A convenience accessor for the silent property in this UIComponent's accessibilityProperties object.

Note that accessibilityEnabled has the opposite sense from silent; accessibilityEnabled is true when silent is false.

The getter simply returns accessibilityProperties.silent, or true if accessibilityProperties is null. The setter first checks whether accessibilityProperties is null, and if it is, sets it to a new AccessibilityProperties instance. Then it sets accessibilityProperties.silent.


Implementation
    public function get accessibilityEnabled():Boolean
    public function set accessibilityEnabled(value:Boolean):void
accessibilityNameproperty 
accessibilityName:String

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

A convenience accessor for the name property in this UIComponent's accessibilityProperties object.

The getter simply returns accessibilityProperties.name, or "" if accessibilityProperties is null. The setter first checks whether accessibilityProperties is null, and if it is, sets it to a new AccessibilityProperties instance. Then it sets accessibilityProperties.name.


Implementation
    public function get accessibilityName():String
    public function set accessibilityName(value:String):void
accessibilityShortcutproperty 
accessibilityShortcut:String

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

A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object.

The getter simply returns accessibilityProperties.shortcut, or "" if accessibilityProperties is null. The setter first checks whether accessibilityProperties is null, and if it is, sets it to a new AccessibilityProperties instance. Then it sets accessibilityProperties.shortcut.


Implementation
    public function get accessibilityShortcut():String
    public function set accessibilityShortcut(value:String):void
activeEffectsproperty 
activeEffects:Array  [read-only]

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

The list of effects that are currently playing on the component, as an Array of EffectInstance instances.


Implementation
    public function get activeEffects():Array
automationDelegateproperty 
automationDelegate:Object

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

The delegate object that handles the automation-related functionality.


Implementation
    public function get automationDelegate():Object
    public function set automationDelegate(value:Object):void
automationEnabledproperty 
automationEnabled:Boolean  [read-only]

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

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


Implementation
    public function get automationEnabled():Boolean
automationNameproperty 
automationName:String

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

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


Implementation
    public function get automationName():String
    public function set automationName(value:String):void
automationOwnerproperty 
automationOwner:DisplayObjectContainer  [read-only]

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

The owner of this component for automation purposes.


Implementation
    public function get automationOwner():DisplayObjectContainer
automationParentproperty 
automationParent:DisplayObjectContainer  [read-only]

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

The parent of this component for automation purposes.


Implementation
    public function get automationParent():DisplayObjectContainer
automationTabularDataproperty 
automationTabularData:Object  [read-only]

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

An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.


Implementation
    public function get automationTabularData():Object
automationValueproperty 
automationValue:Array  [read-only]

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

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


Implementation
    public function get automationValue():Array
automationVisibleproperty 
automationVisible:Boolean  [read-only]

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

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


Implementation
    public function get automationVisible():Boolean
baselineproperty 
baseline:Object

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

For components, this layout constraint property is a facade on top of the similarly-named style. To set the property to its default value of undefined, use the @Clear() directive in MXML or the undefined value in ActionScript code. For example, in MXML code, baseline.s2="@Clear()" unsets the baseline constraint in state s2. Or in ActionScript code, button.baseline = undefined unsets the baseline constraint on button.

The vertical distance in pixels from the anchor target to the control's baseline position.

By default the anchor target is the top edge of the container's content area. In layouts with advanced constraints, the target can be a constraint row.

Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target.

To specify an anchor target, set the property value to a string in the format: "anchorTargetName:value". For example, "row1:10".


Implementation
    public function get baseline():Object
    public function set baseline(value:Object):void
baselinePositionproperty 
baselinePosition:Number  [read-only]

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

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

This property is used to implement the baseline constraint style. It is also used to align the label of a FormItem with the controls in the FormItem.


Implementation
    public function get baselinePosition():Number
bottomproperty 
bottom:Object

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

For components, this layout constraint property is a facade on top of the similarly-named style. To set the property to its default value of undefined, use the @Clear() directive in MXML or the undefined value in ActionScript code. For example, in MXML code, bottom.s2="@Clear()" unsets the bottom constraint in state s2. Or in ActionScript code, button.bottom = undefined unsets the bottom constraint on button.

The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge.

By default the anchor target is the container's content area. In layouts with advanced constraints, the target can be a constraint row.

Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target.

To specify an anchor target, set the property value to a string in the format: "anchorTargetName:value". For example, "row1:10".


Implementation
    public function get bottom():Object
    public function set bottom(value:Object):void
cacheHeuristicproperty 
cacheHeuristic:Boolean  [write-only]

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

Used by Flex to suggest bitmap caching for the object. If cachePolicy is UIComponentCachePolicy.AUTO, then cacheHeuristic is used to control the object's cacheAsBitmap property.


Implementation
    public function set cacheHeuristic(value:Boolean):void
cachePolicyproperty 
cachePolicy:String

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

Specifies the bitmap caching policy for this object. Possible values in MXML are "on", "off" and "auto" (default).

Possible values in ActionScript are UIComponentCachePolicy.ON, UIComponentCachePolicy.OFF and UIComponentCachePolicy.AUTO (default).

The default value is UIComponentCachePolicy.AUTO.


Implementation
    public function get cachePolicy():String
    public function set cachePolicy(value:String):void
classNameproperty 
className:String  [read-only]

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

The name of this instance's class, such as "Button".

This string does not include the package name. If you need the package name as well, call the getQualifiedClassName() method in the flash.utils package. It returns a string such as "mx.controls::Button".


Implementation
    public function get className():String
contentMouseXproperty 
contentMouseX:Number  [read-only]

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

Returns the x position of the mouse, in the content coordinate system. Content coordinates specify a pixel position relative to the upper left corner of the component's content, and include all of the component's content area, including any regions that are currently clipped and must be accessed by scrolling the component.


Implementation
    public function get contentMouseX():Number
contentMouseYproperty 
contentMouseY:Number  [read-only]

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

Returns the y position of the mouse, in the content coordinate system. Content coordinates specify a pixel position relative to the upper left corner of the component's content, and include all of the component's content area, including any regions that are currently clipped and must be accessed by scrolling the component.


Implementation
    public function get contentMouseY():Number
currentCSSStateproperty 
currentCSSState:String  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

The state to be used when matching CSS pseudo-selectors. By default this is the currentState.


Implementation
    protected function get currentCSSState():String
currentStateproperty 
currentState:String

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

The current view state of the component. Set to "" or null to reset the component back to its base state.

When you use this property to set a component's state, Flex applies any transition you have defined. You can also use the setCurrentState() method to set the current state; this method can optionally change states without applying a transition.

This property can be used as the source for data binding.


Implementation
    public function get currentState():String
    public function set currentState(value:String):void

See also

cursorManagerproperty 
cursorManager:ICursorManager  [read-only]

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

Gets the CursorManager that controls the cursor for this component and its peers. Each top-level window has its own instance of a CursorManager; To make sure you're talking to the right one, use this method.


Implementation
    public function get cursorManager():ICursorManager
depthproperty 
depth:Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Determines the order in which items inside of containers are rendered. Spark containers order their items based on their depth property, with the lowest depth in the back, and the higher in the front. Items with the same depth value appear in the order they are added to the container.


Implementation
    public function get depth():Number
    public function set depth(value:Number):void
descriptorproperty 
descriptor:UIComponentDescriptor

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

Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance. If this UIComponent instance was not created from a descriptor, this property is null.


Implementation
    public function get descriptor():UIComponentDescriptor
    public function set descriptor(value:UIComponentDescriptor):void

See also

designLayerproperty 
designLayer:DesignLayer

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Specifies the optional DesignLayer instance associated with this visual element.

When a DesignLayer is assigned, a visual element must consider the visibility and alpha of its parent layer when ultimately committing its own effective visibility or alpha to its backing DisplayObject (if applicable).

A visual element must listen for layerPropertyChange notifications from the associated layer parent. When the effectiveAlpha or effectiveVisibility of the layer changes, the element must then compute its own effective visibility (or alpha) and apply it accordingly.

This property should not be set within MXML directly.

The designLayer property is not used for z-order control, please see depth.


Implementation
    public function get designLayer():DesignLayer
    public function set designLayer(value:DesignLayer):void
documentproperty 
document:Object

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

A reference to the document object associated with this UIComponent. A document object is an Object at the top of the hierarchy of a Flex application, MXML component, or AS component.


Implementation
    public function get document():Object
    public function set document(value:Object):void
doubleClickEnabledproperty 
doubleClickEnabled:Boolean[override]

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

Specifies whether the UIComponent object receives doubleClick events. The default value is false, which means that the UIComponent object does not receive doubleClick events.

The mouseEnabled property must also be set to true, its default value, for the object to receive doubleClick events.

The default value is false.


Implementation
    public function get doubleClickEnabled():Boolean
    public function set doubleClickEnabled(value:Boolean):void
enabledproperty 
enabled:Boolean

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

Whether the component can accept user interaction. After setting the enabled property to false, some components still respond to mouse interactions such as mouseOver. As a result, to fully disable UIComponents, you should also set the value of the mouseEnabled property to false. If you set the enabled property to false for a container, Flex dims the color of the container and of all of its children, and blocks user input to the container and to all of its children.

This property can be used as the source for data binding.


Implementation
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
errorStringproperty 
errorString:String

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

The text that displayed by a component's error tip when a component is monitored by a Validator and validation fails.

You can use the errorString property to show a validation error for a component, without actually using a validator class. When you write a String value to the errorString property, Flex draws a red border around the component to indicate the validation error, and the String appears in a tooltip as the validation error message when you move the mouse over the component, just as if a validator detected a validation error.

To clear the validation error, write an empty String, "", to the errorString property.

Note that writing a value to the errorString property does not trigger the valid or invalid events; it only changes the border color and displays the validation error message.

This property can be used as the source for data binding.


Implementation
    public function get errorString():String
    public function set errorString(value:String):void
explicitHeightproperty 
explicitHeight:Number

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

Number that specifies the explicit height of the component, in pixels, in the component's coordinates.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true explicitHeight with respect to its parent is affected by the scaleY property.

Setting the height property also sets this property to the specified height value.

This property can be used as the source for data binding.


Implementation
    public function get explicitHeight():Number
    public function set explicitHeight(value:Number):void
explicitMaxHeightproperty 
explicitMaxHeight:Number

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

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

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

At layout time, if maxHeight was explicitly set by the application developer, then the value of explicitMaxHeight is used. Otherwise, the default value for maxHeight is used.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true maxHeight with respect to its parent is affected by the scaleY property. Some components have no theoretical limit to their height. In those cases their maxHeight is set to UIComponent.DEFAULT_MAX_HEIGHT.

The default value is NaN.

This property can be used as the source for data binding.


Implementation
    public function get explicitMaxHeight():Number
    public function set explicitMaxHeight(value:Number):void
explicitMaxWidthproperty 
explicitMaxWidth:Number

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

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

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

At layout time, if maxWidth was explicitly set by the application developer, then the value of explicitMaxWidth is used. Otherwise, the default value for maxWidth is used.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true maxWidth with respect to its parent is affected by the scaleX property. Some components have no theoretical limit to their width. In those cases their maxWidth is set to UIComponent.DEFAULT_MAX_WIDTH.

The default value is NaN.

This property can be used as the source for data binding.


Implementation
    public function get explicitMaxWidth():Number
    public function set explicitMaxWidth(value:Number):void
explicitMinHeightproperty 
explicitMinHeight:Number

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

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

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

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

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true minHeight with respect to its parent is affected by the scaleY property.

The default value is NaN.

This property can be used as the source for data binding.


Implementation
    public function get explicitMinHeight():Number
    public function set explicitMinHeight(value:Number):void
explicitMinWidthproperty 
explicitMinWidth:Number

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

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

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

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

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true minWidth with respect to its parent is affected by the scaleX property.

The default value is NaN.

This property can be used as the source for data binding.


Implementation
    public function get explicitMinWidth():Number
    public function set explicitMinWidth(value:Number):void
explicitWidthproperty 
explicitWidth:Number

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

Number that specifies the explicit width of the component, in pixels, in the component's coordinates.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true explicitWidth with respect to its parent is affected by the scaleX property.

Setting the width property also sets this property to the specified width value.

This property can be used as the source for data binding.


Implementation
    public function get explicitWidth():Number
    public function set explicitWidth(value:Number):void
flexContextMenuproperty 
flexContextMenu:IFlexContextMenu

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

The context menu for this UIComponent.

The default value is null.


Implementation
    public function get flexContextMenu():IFlexContextMenu
    public function set flexContextMenu(value:IFlexContextMenu):void
focusEnabledproperty 
focusEnabled:Boolean

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

Indicates whether the component can receive focus when tabbed to. You can set focusEnabled to false when a UIComponent is used as a subcomponent of another component so that the outer component becomes the focusable entity. If this property is false, focus is transferred to the first parent that has focusEnable set to true.

The default value is true, except for the spark.components.Scroller component. For that component, the default value is false.


Implementation
    public function get focusEnabled():Boolean
    public function set focusEnabled(value:Boolean):void

See also

focusManagerproperty 
focusManager:IFocusManager

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

Gets the FocusManager that controls focus for this component and its peers. Each popup has its own focus loop and therefore its own instance of a FocusManager. To make sure you're talking to the right one, use this method.


Implementation
    public function get focusManager():IFocusManager
    public function set focusManager(value:IFocusManager):void
focusPaneproperty 
focusPane:Sprite

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

The focus pane associated with this object. An object has a focus pane when one of its children has focus.


Implementation
    public function get focusPane():Sprite
    public function set focusPane(value:Sprite):void
hasComplexLayoutMatrixproperty 
hasComplexLayoutMatrix:Boolean  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns true if the UIComponent has any non-translation (x,y) transform properties.


Implementation
    protected function get hasComplexLayoutMatrix():Boolean
hasFocusableChildrenproperty 
hasFocusableChildren:Boolean

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

A flag that indicates whether child objects can receive focus.

Note: This property is similar to the tabChildren property used by Flash Player. Use the hasFocusableChildren property with Flex applications. Do not use the tabChildren property.

This property is usually false because most components either receive focus themselves or delegate focus to a single internal sub-component and appear as if the component has received focus. For example, a TextInput control contains a focusable child RichEditableText control, but while the RichEditableText sub-component actually receives focus, it appears as if the TextInput has focus. TextInput sets hasFocusableChildren to false because TextInput is considered the component that has focus. Its internal structure is an abstraction.

Usually only navigator components, such as TabNavigator and Accordion, have this flag set to true because they receive focus on Tab but focus goes to components in the child containers on further Tabs.

The default value is false, except for the spark.components.Scroller component. For that component, the default value is true.

This property can be used as the source for data binding.


Implementation
    public function get hasFocusableChildren():Boolean
    public function set hasFocusableChildren(value:Boolean):void

See also

hasLayoutMatrix3Dproperty 
hasLayoutMatrix3D:Boolean  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Contains true if the element has 3D Matrix.

Use hasLayoutMatrix3D instead of calling and examining the return value of getLayoutMatrix3D() because that method returns a valid matrix even when the element is in 2D.


Implementation
    public function get hasLayoutMatrix3D():Boolean
heightproperty 
height:Number[override]

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

Number that specifies the height of the component, in pixels, in the parent's coordinates. The default value is 0, but this property contains the actual component height after Flex completes sizing the components in your application.

Note: You can specify a percentage value in the MXML height attribute, such as height="100%", but you cannot use a percentage value for the height property in ActionScript; use the percentHeight property instead.

Setting this property causes a resize event to be dispatched. See the resize event for details on when this event is dispatched.

This property can be used as the source for data binding.


Implementation
    public function get height():Number
    public function set height(value:Number):void

See also

horizontalCenterproperty 
horizontalCenter:Object

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

For components, this layout constraint property is a facade on top of the similarly-named style. To set the property to its default value of undefined, use the @Clear() directive in MXML or the undefined value in ActionScript code. For example, in MXML code, horizontalCenter.s2="@Clear()" unsets the horizontalCenter constraint in state s2. Or in ActionScript code, button.horizontalCenter = undefined unsets the horizontalCenter constraint on button.

The horizontal distance in pixels from the center of the component to the center of the anchor target's content area.

The default anchor target is the container itself.

In layouts with advanced constraints, the anchor target can be a constraint column. Then the content area is the space between the preceding column (or container side) and the target column.

Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target.

To specify an anchor target, set the property value to a string in the format "constraintColumnId:value". For example, "col1:10".


Implementation
    public function get horizontalCenter():Object
    public function set horizontalCenter(value:Object):void
idproperty 
id:String

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

ID of the component. This value becomes the instance name of the object and should not contain any white space or special characters. Each component throughout an application should have a unique id.

If your application is going to be tested by third party tools, give each component a meaningful id. Testing tools use ids to represent the control in their scripts and having a meaningful name can make scripts more readable. For example, set the value of a button to submit_button rather than b1 or button1.


Implementation
    public function get id():String
    public function set id(value:String):void
includeInLayoutproperty 
includeInLayout:Boolean

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

Specifies whether this component is included in the layout of the parent container. If true, the object is included in its parent container's layout and is sized and positioned by its parent container as per its layout rules. If false, the object size and position are not affected by its parent container's layout.

The default value is true.

This property can be used as the source for data binding.


Implementation
    public function get includeInLayout():Boolean
    public function set includeInLayout(value:Boolean):void
inheritingStylesproperty 
inheritingStyles:Object

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

The beginning of this component's chain of inheriting styles. The getStyle() method simply accesses inheritingStyles[styleName] to search the entire prototype-linked chain. This object is set up by initProtoChain(). Developers typically never need to access this property directly.


Implementation
    public function get inheritingStyles():Object
    public function set inheritingStyles(value:Object):void
initializedproperty 
initialized:Boolean

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

A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).


Implementation
    public function get initialized():Boolean
    public function set initialized(value:Boolean):void
instanceIndexproperty 
instanceIndex:int  [read-only]

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

The index of a repeated component. If the component is not within a Repeater, the value is -1.


Implementation
    public function get instanceIndex():int
instanceIndicesproperty 
instanceIndices:Array

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

An Array containing the indices required to reference this UIComponent object from its parent document. The Array is empty unless this UIComponent object is within one or more Repeaters. The first element corresponds to the outermost Repeater. For example, if the id is "b" and instanceIndices is [2,4], you would reference it on the parent document as b[2][4].


Implementation
    public function get instanceIndices():Array
    public function set instanceIndices(value:Array):void
is3Dproperty 
is3D:Boolean  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Contains true when the element is in 3D. The element can be in 3D either because it has 3D transform properties or it has 3D post layout transform offsets or both.


Implementation
    public function get is3D():Boolean
isDocumentproperty 
isDocument:Boolean  [read-only]

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

Contains true if this UIComponent instance is a document object. That means it is at the top of the hierarchy of a Flex application, MXML component, or ActionScript component.


Implementation
    public function get isDocument():Boolean
isPopUpproperty 
isPopUp:Boolean

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

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


Implementation
    public function get isPopUp():Boolean
    public function set isPopUp(value:Boolean):void
layoutMatrix3Dproperty 
layoutMatrix3D:Matrix3D  [write-only]

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The transform matrix that is used to calculate a component's layout relative to its siblings. This matrix is defined by the component's 3D properties (which include the 2D properties such as x, y, rotation, scaleX, scaleY, transformX, and transformY, as well as rotationX, rotationY, scaleZ, z, and transformZ.

Most components do not have any 3D transform properties set on them.

This layout matrix is combined with the values of the postLayoutTransformOffsets property to determine the component's final, computed matrix.


Implementation
    public function set layoutMatrix3D(value:Matrix3D):void

See also

leftproperty 
left:Object

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

For components, this layout constraint property is a facade on top of the similarly-named style. To set a state-specific value of the property in MXML to its default value of undefined, use the @Clear() directive. For example, in MXML code, left.s2="@Clear()" unsets the left constraint in state s2. Or in ActionScript code, button.left = undefined unsets the left constraint on button.

The horizontal distance in pixels from the left edge of the component to the anchor target's left edge.

By default the anchor target is the container's content area. In layouts with advanced constraints, the target can be a constraint column.

Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target.

To specify an anchor target, set the property value to a string in the format "anchorTargetName:value". For example, "col1:10".


Implementation
    public function get left():Object
    public function set left(value:Object):void
maintainProjectionCenterproperty 
maintainProjectionCenter:Boolean

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

When true, the component keeps its projection matrix centered on the middle of its bounding box. If no projection matrix is defined on the component, one is added automatically.


Implementation
    public function get maintainProjectionCenter():Boolean
    public function set maintainProjectionCenter(value:Boolean):void
maxHeightproperty 
maxHeight:Number

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

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

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

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

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true maxHeight with respect to its parent is affected by the scaleY property. Some components have no theoretical limit to their height. In those cases their maxHeight is set to UIComponent.DEFAULT_MAX_HEIGHT.

The default value is 10000.

This property can be used as the source for data binding.


Implementation
    public function get maxHeight():Number
    public function set maxHeight(value:Number):void
maxWidthproperty 
maxWidth:Number

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

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

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

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

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true maxWidth with respect to its parent is affected by the scaleX property. Some components have no theoretical limit to their width. In those cases their maxWidth is set to UIComponent.DEFAULT_MAX_WIDTH.

The default value is 10000.

This property can be used as the source for data binding.


Implementation
    public function get maxWidth():Number
    public function set maxWidth(value:Number):void
measuredHeightproperty 
measuredHeight:Number

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

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


Implementation
    public function get measuredHeight():Number
    public function set measuredHeight(value:Number):void
measuredMinHeightproperty 
measuredMinHeight:Number

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

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


Implementation
    public function get measuredMinHeight():Number
    public function set measuredMinHeight(value:Number):void
measuredMinWidthproperty 
measuredMinWidth:Number

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

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


Implementation
    public function get measuredMinWidth():Number
    public function set measuredMinWidth(value:Number):void
measuredWidthproperty 
measuredWidth:Number

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

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


Implementation
    public function get measuredWidth():Number
    public function set measuredWidth(value:Number):void
minHeightproperty 
minHeight:Number

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

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

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

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true minHeight with respect to its parent is affected by the scaleY property.

This property can be used as the source for data binding.


Implementation
    public function get minHeight():Number
    public function set minHeight(value:Number):void
minWidthproperty 
minWidth:Number

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

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

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

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true minWidth with respect to its parent is affected by the scaleX property.

This property can be used as the source for data binding.


Implementation
    public function get minWidth():Number
    public function set minWidth(value:Number):void
moduleFactoryproperty 
moduleFactory:IFlexModuleFactory

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

A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component.


Implementation
    public function get moduleFactory():IFlexModuleFactory
    public function set moduleFactory(value:IFlexModuleFactory):void
mouseFocusEnabledproperty 
mouseFocusEnabled:Boolean

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

Whether you can receive focus when clicked on. If false, focus is transferred to the first parent that is mouseFocusEnable set to true. For example, you can set this property to false on a Button control so that you can use the Tab key to move focus to the control, but not have the control get focus when you click on it.

The default value is true for most subclasses, except the Spark TabBar. In that case, the default is false.

The default value is true.


Implementation
    public function get mouseFocusEnabled():Boolean
    public function set mouseFocusEnabled(value:Boolean):void
nestLevelproperty 
nestLevel:int

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

Depth of this object in the containment hierarchy. This number is used by the measurement and layout code. The value is 0 if this component is not on the DisplayList.


Implementation
    public function get nestLevel():int
    public function set nestLevel(value:int):void
nonInheritingStylesproperty 
nonInheritingStyles:Object

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

The beginning of this component's chain of non-inheriting styles. The getStyle() method simply accesses nonInheritingStyles[styleName] to search the entire prototype-linked chain. This object is set up by initProtoChain(). Developers typically never need to access this property directly.


Implementation
    public function get nonInheritingStyles():Object
    public function set nonInheritingStyles(value:Object):void
numAutomationChildrenproperty 
numAutomationChildren:int  [read-only]

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

The number of automation children this container has. This sum should not include any composite children, though it does include those children not significant within the automation hierarchy.


Implementation
    public function get numAutomationChildren():int
ownerproperty 
owner:DisplayObjectContainer

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

The owner of this IVisualElement object. By default, it is the parent of this IVisualElement object. However, if this IVisualElement object is a child component that is popped up by its parent, such as the drop-down list of a ComboBox control, the owner is the component that popped up this IVisualElement object.

This property is not managed by Flex, but by each component. Therefore, if you use the PopUpManger.createPopUp() or PopUpManger.addPopUp() method to pop up a child component, you should set the owner property of the child component to the component that popped it up.

The default value is the value of the parent property.


Implementation
    public function get owner():DisplayObjectContainer
    public function set owner(value:DisplayObjectContainer):void
parentproperty 
parent:DisplayObjectContainer  [read-only] [override]

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

The parent container or component for this component. Only visual elements should have a parent property. Non-visual items should use another property to reference the object to which they belong. By convention, non-visual objects use an owner property to reference the object to which they belong.


Implementation
    public function get parent():DisplayObjectContainer
parentApplicationproperty 
parentApplication:Object  [read-only]

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

A reference to the Application object that contains this UIComponent instance. This Application object might exist in a SWFLoader control in another Application, and so on, creating a chain of Application objects that can be walked using parentApplication.

The parentApplication property of an Application is never itself; it is either the Application into which it was loaded or null (for the top-level Application).

Walking the application chain using the parentApplication property is similar to walking the document chain using the parentDocument property. You can access the top-level application using the application property of the Application class.

This property can be used as the source for data binding.


Implementation
    public function get parentApplication():Object
parentDocumentproperty 
parentDocument:Object  [read-only]

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

A reference to the parent document object for this UIComponent. A document object is a UIComponent at the top of the hierarchy of a Flex application, MXML component, or AS component.

For the Application object, the parentDocument property is null. This property is useful in MXML scripts to go up a level in the chain of document objects. It can be used to walk this chain using parentDocument.parentDocument, and so on.

It is typed as Object so that authors can access properties and methods on ancestor document objects without casting.

This property can be used as the source for data binding.


Implementation
    public function get parentDocument():Object
percentHeightproperty 
percentHeight:Number

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

Specifies the height of a component as a percentage of its parent's size. Allowed values are 0-100. The default value is NaN. Setting the height or explicitHeight properties resets this property to NaN.

This property returns a numeric value only if the property was previously set; it does not reflect the exact size of the component in percent.

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

When used with Spark layouts, this property is used to calculate the height of the component's bounds after scaling and rotation. For example if the component is rotated at 90 degrees, then specifying percentHeight will affect the component's width.

This property can be used as the source for data binding.


Implementation
    public function get percentHeight():Number
    public function set percentHeight(value:Number):void
percentWidthproperty 
percentWidth:Number

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

Specifies the width of a component as a percentage of its parent's size. Allowed values are 0-100. The default value is NaN. Setting the width or explicitWidth properties resets this property to NaN.

This property returns a numeric value only if the property was previously set; it does not reflect the exact size of the component in percent.

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

When used with Spark layouts, this property is used to calculate the width of the component's bounds after scaling and rotation. For example if the component is rotated at 90 degrees, then specifying percentWidth will affect the component's height.

This property can be used as the source for data binding.


Implementation
    public function get percentWidth():Number
    public function set percentWidth(value:Number):void
postLayoutTransformOffsetsproperty 
postLayoutTransformOffsets:TransformOffsets

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

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.

For example, if you want a layout to adjust for an object that is rotated 90 degrees, set the object's rotation property. If you want the layout to not adjust for the object being rotated, set its postLayoutTransformOffsets.rotationZ property.


Implementation
    public function get postLayoutTransformOffsets():TransformOffsets
    public function set postLayoutTransformOffsets(value:TransformOffsets):void
processedDescriptorsproperty 
processedDescriptors:Boolean

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

Set to true after immediate or deferred child creation, depending on which one happens. For a Container object, it is set to true at the end of the createComponentsFromDescriptors() method, meaning after the Container object creates its children from its child descriptors.

For example, if an Accordion container uses deferred instantiation, the processedDescriptors property for the second pane of the Accordion container does not become true until after the user navigates to that pane and the pane creates its children. But, if the Accordion had set the creationPolicy property to "all", the processedDescriptors property for its second pane is set to true during application startup.

For classes that are not containers, which do not have descriptors, it is set to true after the createChildren() method creates any internal component children.


Implementation
    public function get processedDescriptors():Boolean
    public function set processedDescriptors(value:Boolean):void
repeaterproperty 
repeater:IRepeater  [read-only]

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

A reference to the Repeater object in the parent document that produced this UIComponent. Use this property, rather than the repeaters property, when the UIComponent is created by a single Repeater object. Use the repeaters property when this UIComponent is created by nested Repeater objects.

The property is set to null when this UIComponent is not created by a Repeater.


Implementation
    public function get repeater():IRepeater
repeaterIndexproperty 
repeaterIndex:int  [read-only]

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

The index of the item in the data provider of the Repeater that produced this UIComponent. Use this property, rather than the repeaterIndices property, when the UIComponent is created by a single Repeater object. Use the repeaterIndices property when this UIComponent is created by nested Repeater objects.

This property is set to -1 when this UIComponent is not created by a Repeater.


Implementation
    public function get repeaterIndex():int
repeaterIndicesproperty 
repeaterIndices:Array

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

An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent. The Array is empty unless this UIComponent is within one or more Repeaters.

The first element in the Array corresponds to the outermost Repeater. For example, if repeaterIndices is [2,4] it means that the outer repeater used item dataProvider[2] and the inner repeater used item dataProvider[4].

Note that this property differs from the instanceIndices property if the startingIndex property of any of the Repeaters is not 0. For example, even if a Repeater starts at dataProvider[4], the document reference of the first repeated object is b[0], not b[4].


Implementation
    public function get repeaterIndices():Array
    public function set repeaterIndices(value:Array):void
repeatersproperty 
repeaters:Array

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

An Array containing references to the Repeater objects in the parent document that produced this UIComponent. The Array is empty unless this UIComponent is within one or more Repeaters. The first element corresponds to the outermost Repeater object.


Implementation
    public function get repeaters():Array
    public function set repeaters(value:Array):void
resourceManagerproperty 
resourceManager:IResourceManager  [read-only]

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

A reference to the object which manages all of the application's localized resources. This is a singleton instance which implements the IResourceManager interface.

This property can be used as the source for data binding.


Implementation
    protected function get resourceManager():IResourceManager
rightproperty 
right:Object

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

For components, this layout constraint property is a facade on top of the similarly-named style. To set the property to its default value of undefined, use the @Clear() directive in MXML or the undefined value in ActionScript code. For example, in MXML code, right.s2="@Clear()" unsets the right constraint in state s2. Or in ActionScript code, button.right = undefined unsets the right constraint on button.

The horizontal distance in pixels from the right edge of the component to the anchor target's right edge.

By default the anchor target is the container's content area. In layouts with advanced constraints, the target can be a constraint column.

Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target.

To specify an anchor target, set the property value to a string in the format "anchorTargetName:value". For example, "col1:10".


Implementation
    public function get right():Object
    public function set right(value:Object):void
rotationproperty 
rotation:Number[override]

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


Implementation
    public function get rotation():Number
    public function set rotation(value:Number):void
rotationXproperty 
rotationX:Number[override]

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 10, AIR 1.5

Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. This property is ignored during calculation by any of Flex's 2D layouts.


Implementation
    public function get rotationX():Number
    public function set rotationX(value:Number):void
rotationYproperty 
rotationY:Number[override]

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

Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. This property is ignored during calculation by any of Flex's 2D layouts.


Implementation
    public function get rotationY():Number
    public function set rotationY(value:Number):void
rotationZproperty 
rotationZ:Number[override]

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


Implementation
    public function get rotationZ():Number
    public function set rotationZ(value:Number):void
scaleXproperty 
scaleX:Number[override]

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

Number that specifies the horizontal scaling factor.

The default value is 1.0, which means that the object is not scaled. A scaleX of 2.0 means the object has been magnified by a factor of 2, and a scaleX of 0.5 means the object has been reduced by a factor of 2.

A value of 0.0 is an invalid value. Rather than setting it to 0.0, set it to a small value, or set the visible property to false to hide the component.

The default value is 1.0.

This property can be used as the source for data binding.


Implementation
    public function get scaleX():Number
    public function set scaleX(value:Number):void
scaleYproperty 
scaleY:Number[override]

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

Number that specifies the vertical scaling factor.

The default value is 1.0, which means that the object is not scaled. A scaleY of 2.0 means the object has been magnified by a factor of 2, and a scaleY of 0.5 means the object has been reduced by a factor of 2.

A value of 0.0 is an invalid value. Rather than setting it to 0.0, set it to a small value, or set the visible property to false to hide the component.

The default value is 1.0.

This property can be used as the source for data binding.


Implementation
    public function get scaleY():Number
    public function set scaleY(value:Number):void
scaleZproperty 
scaleZ:Number[override]

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

Number that specifies the scaling factor along the z axis.

A scaling along the z axis does not affect a typical component, which lies flat in the z=0 plane. components with children that have 3D transforms applied, or components with a non-zero transformZ, is affected.

The default value is 1.0, which means that the object is not scaled.

This property is ignored during calculation by any of Flex's 2D layouts.

The default value is 1.0.

This property can be used as the source for data binding.


Implementation
    public function get scaleZ():Number
    public function set scaleZ(value:Number):void
screenproperty 
screen:Rectangle  [read-only]

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

Returns an object that contains the size and position of the base drawing surface for this object.


Implementation
    public function get screen():Rectangle
showInAutomationHierarchyproperty 
showInAutomationHierarchy:Boolean

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

A flag that determines if an automation object shows in the automation hierarchy. Children of containers that are not visible in the hierarchy appear as children of the next highest visible parent. Typically containers used for layout, such as boxes and Canvas, do not appear in the hierarchy.

Some controls force their children to appear in the hierarchy when appropriate. For example a List will always force item renderers, including boxes, to appear in the hierarchy. Implementers must support setting this property to true.


Implementation
    public function get showInAutomationHierarchy():Boolean
    public function set showInAutomationHierarchy(value:Boolean):void
statesproperty 
states:Array

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

The view states that are defined for this component. You can specify the states property only on the root of the application or on the root tag of an MXML component. The compiler generates an error if you specify it on any other control.


Implementation
    public function get states():Array
    public function set states(value:Array):void
styleDeclarationproperty 
styleDeclaration:CSSStyleDeclaration

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

Storage for the inline inheriting styles on this object. This CSSStyleDeclaration is created the first time that the setStyle() method is called on this component to set an inheriting style. Developers typically never need to access this property directly.


Implementation
    public function get styleDeclaration():CSSStyleDeclaration
    public function set styleDeclaration(value:CSSStyleDeclaration):void
styleManagerproperty 
styleManager:IStyleManager2  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the StyleManager instance used by this component.


Implementation
    public function get styleManager():IStyleManager2
styleNameproperty 
styleName:Object

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

The class style used by this component. This can be a String, CSSStyleDeclaration or an IStyleClient.

If this is a String, it is the name of one or more whitespace delimited class declarations in an <fx:Style> tag or CSS file. You do not include the period in the styleName. For example, if you have a class style named ".bigText", set the styleName property to "bigText" (no period).

If this is an IStyleClient (typically a UIComponent), all styles in the styleName object are used by this component.

The default value is null.


Implementation
    public function get styleName():Object
    public function set styleName(value:Object):void
styleParentproperty 
styleParent:IAdvancedStyleClient

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

A component's parent is used to evaluate descendant selectors. A parent must also be an IAdvancedStyleClient to participate in advanced style declarations.


Implementation
    public function get styleParent():IAdvancedStyleClient
    public function set styleParent(value:IAdvancedStyleClient):void
systemManagerproperty 
systemManager:ISystemManager

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

Returns the SystemManager object used by this component.


Implementation
    public function get systemManager():ISystemManager
    public function set systemManager(value:ISystemManager):void
tabFocusEnabledproperty 
tabFocusEnabled:Boolean

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

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.

The default value is true.

This property can be used as the source for data binding.


Implementation
    public function get tabFocusEnabled():Boolean
    public function set tabFocusEnabled(value:Boolean):void
toolTipproperty 
toolTip:String

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

Text to display in the ToolTip.

The default value is null.

This property can be used as the source for data binding.


Implementation
    public function get toolTip():String
    public function set toolTip(value:String):void
topproperty 
top:Object

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

For components, this layout constraint property is a facade on top of the similarly-named style. To set the property to its default value of undefined, use the @Clear() directive in MXML or the undefined value in ActionScript code. For example, in MXML code, top.s2="@Clear()" unsets the top constraint in state s2. Or in ActionScript code, button.top = undefined unsets the top constraint on button.

The vertical distance in pixels from the top edge of the component to the anchor target's top edge.

By default the anchor target is the container's content area. In layouts with advanced constraints, the target can be a constraint row.

Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target.

To specify an anchor target, set the property value to a string in the format "anchorTargetName:value". For example, "row1:10".


Implementation
    public function get top():Object
    public function set top(value:Object):void
transformproperty 
transform:Transform[override]

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

An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. The specific properties — matrix, colorTransform, and three read-only properties (concatenatedMatrix, concatenatedColorTransform, and pixelBounds) — are described in the entry for the Transform class.

Each of the transform object's properties is itself an object. This concept is important because the only way to set new values for the matrix or colorTransform objects is to create a new object and copy that object into the transform.matrix or transform.colorTransform property.

For example, to increase the tx value of a display object's matrix, you must make a copy of the entire matrix object, then copy the new object into the matrix property of the transform object:

      var myMatrix:Matrix = myUIComponentObject.transform.matrix;  
      myMatrix.tx += 10; 
      myUIComponent.transform.matrix = myMatrix;
      
You cannot directly set the tx property. The following code has no effect on myUIComponent:
      myUIComponent.transform.matrix.tx += 10;
      

Note that for UIComponent, unlike DisplayObject, the transform keeps the matrix and matrix3D values in sync and matrix3D is not null even when the component itself has no 3D properties set. Developers should use the is3D property to check if the component has 3D propertis set. If the component has 3D properties, the transform's matrix3D should be used instead of transform's matrix.


Implementation
    public function get transform():Transform
    public function set transform(value:Transform):void

See also

transformXproperty 
transformX:Number

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

Sets the x coordinate for the transform center of the component.

When this component is the target of a Spark transform effect, you can override this property by setting the AnimateTransform.autoCenterTransform property. If autoCenterTransform is false, the transform center is determined by the transformX, transformY, and transformZ properties of the effect target. If autoCenterTransform is true, the effect occurs around the center of the target, (width/2, height/2).

Setting this property on the Spark effect class overrides the setting on the target component.


Implementation
    public function get transformX():Number
    public function set transformX(value:Number):void

See also

spark.effects.AnimateTransform.autoCenterTransform
spark.effects.AnimateTransform.transformX
transformYproperty 
transformY:Number

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

Sets the y coordinate for the transform center of the component.

When this component is the target of a Spark transform effect, you can override this property by setting the AnimateTransform.autoCenterTransform property. If autoCenterTransform is false, the transform center is determined by the transformX, transformY, and transformZ properties of the effect target. If autoCenterTransform is true, the effect occurs around the center of the target, (width/2, height/2).

Seeting this property on the Spark effect class overrides the setting on the target component.


Implementation
    public function get transformY():Number
    public function set transformY(value:Number):void

See also

spark.effects.AnimateTransform.autoCenterTransform
spark.effects.AnimateTransform.transformY
transformZproperty 
transformZ:Number

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

Sets the z coordinate for the transform center of the component.

When this component is the target of a Spark transform effect, you can override this property by setting the AnimateTransform.autoCenterTransform property. If autoCenterTransform is false, the transform center is determined by the transformX, transformY, and transformZ properties of the effect target. If autoCenterTransform is true, the effect occurs around the center of the target, (width/2, height/2).

Seeting this property on the Spark effect class overrides the setting on the target component.


Implementation
    public function get transformZ():Number
    public function set transformZ(value:Number):void

See also

spark.effects.AnimateTransform.autoCenterTransform
spark.effects.AnimateTransform.transformZ
transitionsproperty 
transitions:Array

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

An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.


Implementation
    public function get transitions():Array
    public function set transitions(value:Array):void

See also

tweeningPropertiesproperty 
tweeningProperties:Array

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

Array of properties that are currently being tweened on this object.

Used to alert the EffectManager that certain properties of this object are being tweened, so that the EffectManger doesn't attempt to animate the same properties.


Implementation
    public function get tweeningProperties():Array
    public function set tweeningProperties(value:Array):void
uidproperty 
uid:String

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

A unique identifier for the object. Flex data-driven controls, including all controls that are subclasses of List class, use a UID to track data provider items.

Flex can automatically create and manage UIDs. However, there are circumstances when you must supply your own uid property by implementing the IUID interface, or when supplying your own uid property improves processing efficiency. UIDs do not need to be universally unique for most uses in Flex. One exception is for messages sent by data services.


Implementation
    public function get uid():String
    public function set uid(value:String):void

See also

unscaledHeightproperty 
unscaledHeight:Number  [read-only]

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

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


Implementation
    protected function get unscaledHeight():Number
unscaledWidthproperty 
unscaledWidth:Number  [read-only]

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

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


Implementation
    protected function get unscaledWidth():Number
updateCompletePendingFlagproperty 
updateCompletePendingFlag:Boolean

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

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


Implementation
    public function get updateCompletePendingFlag():Boolean
    public function set updateCompletePendingFlag(value:Boolean):void
validationSubFieldproperty 
validationSubField:String

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

Used by a validator to associate a subfield with this component.


Implementation
    public function get validationSubField():String
    public function set validationSubField(value:String):void
verticalCenterproperty 
verticalCenter:Object

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

For components, this layout constraint property is a facade on top of the similarly-named style. To set the property to its default value of undefined, use the @Clear() directive in MXML or the undefined value in ActionScript code. For example, in MXML code, verticalCenter.s2="@Clear()" unsets the verticalCenter constraint in state s2. Or in ActionScript code, button.verticalCenter = undefined unsets the verticalCenter constraint on button.

The vertical distance in pixels from the center of the component to the center of the anchor target's content area.

The default anchor target is the container itself.

In layouts with advanced constraints, the anchor target can be a constraint row. Then the content area is the space between the preceding row (or container side) and the target row.

Setting the property to a number or to a numerical string like "10" specifies use of the default anchor target.

To specify an anchor target, set the property value to a string in the format "constraintColumnId:value". For example, "row1:10".


Implementation
    public function get verticalCenter():Object
    public function set verticalCenter(value:Object):void
visibleproperty 
visible:Boolean[override]

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

Whether or not the display object is visible. Display objects that are not visible are disabled. For example, if visible=false for an InteractiveObject instance, it cannot be clicked.

When setting to true, the object dispatches a show event. When setting to false, the object dispatches a hide event. In either case the children of the object does not emit a show or hide event unless the object has specifically written an implementation to do so.

This property can be used as the source for data binding.


Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
widthproperty 
width:Number[override]

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

Number that specifies the width of the component, in pixels, in the parent's coordinates. The default value is 0, but this property contains the actual component width after Flex completes sizing the components in your application.

Note: You can specify a percentage value in the MXML width attribute, such as width="100%", but you cannot use a percentage value in the width property in ActionScript. Use the percentWidth property instead.

Setting this property causes a resize event to be dispatched. See the resize event for details on when this event is dispatched.

This property can be used as the source for data binding.


Implementation
    public function get width():Number
    public function set width(value:Number):void

See also

xproperty 
x:Number[override]

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

Number that specifies the component's horizontal position, in pixels, within its parent container.

Setting this property directly or calling move() has no effect -- or only a temporary effect -- if the component is parented by a layout container such as HBox, Grid, or Form, because the layout calculations of those containers set the x position to the results of the calculation. However, the x property must almost always be set when the parent is a Canvas or other absolute-positioning container because the default value is 0.

The default value is 0.

This property can be used as the source for data binding.


Implementation
    public function get x():Number
    public function set x(value:Number):void
yproperty 
y:Number[override]

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

Number that specifies the component's vertical position, in pixels, within its parent container.

Setting this property directly or calling move() has no effect -- or only a temporary effect -- if the component is parented by a layout container such as HBox, Grid, or Form, because the layout calculations of those containers set the x position to the results of the calculation. However, the x property must almost always be set when the parent is a Canvas or other absolute-positioning container because the default value is 0.

The default value is 0.

This property can be used as the source for data binding.


Implementation
    public function get y():Number
    public function set y(value:Number):void
zproperty 
z:Number[override]

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : Flash Player 10, AIR 1.5

This property can be used as the source for data binding.


Implementation
    public function get z():Number
    public function set z(value:Number):void
Constructor Detail
UIComponent()Constructor
public function UIComponent()

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

Constructor.

Method Detail
addStyleClient()method
public function addStyleClient(styleClient:IAdvancedStyleClient):void

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

Adds a non-visual style client to this component instance. Once this method has been called, the style client will inherit style changes from this component instance. Style clients that are DisplayObjects must use the addChild or addChildAt methods to be added to a UIComponent. As a side effect, this method will set the styleParent property of the styleClient parameter to reference this instance of the UIComponent. If the styleClient parameter already has a styleParent, this method will call removeStyleClient from this previous styleParent.

Parameters

styleClient:IAdvancedStyleClient — The IAdvancedStyleClient to add to this component's list of non-visual style clients.


Throws
ArgumentError — if the styleClient parameter is a DisplayObject.

See also

adjustFocusRect()method 
protected function adjustFocusRect(obj:DisplayObject = null):void

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

Adjust the focus rectangle.

Parameters

obj:DisplayObject (default = null) — component whose focus rectangle to modify. If omitted, the default value is this UIComponent object.

applyComputedMatrix()method 
protected function applyComputedMatrix():void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform.

attachOverlay()method 
protected function attachOverlay():void

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

This is an internal method used by the Flex framework to support the Dissolve effect. You do not have to call it or override it.

callLater()method 
public function callLater(method:Function, args:Array = null):void

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

Queues a function to be called later.

Before each update of the screen, Flash Player or AIR calls the set of functions that are scheduled for the update. Sometimes, a function should be called in the next update to allow the rest of the code scheduled for the current update to be executed. Some features, like effects, can cause queued functions to be delayed until the feature completes.

Parameters

method:Function — Reference to a method to be executed later.
 
args:Array (default = null) — Array of Objects that represent the arguments to pass to the method.

canSkipMeasurement()method 
protected function canSkipMeasurement():Boolean

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

Determines if the call to the measure() method can be skipped.

Returns
Boolean — Returns true when the measureSizes() method can skip the call to the measure() method. For example this is usually true when both explicitWidth and explicitHeight are set. For paths, this is true when the bounds of the path have not changed.
childrenCreated()method 
protected function childrenCreated():void

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

Performs any final processing after child objects are created. This is an advanced method that you might override when creating a subclass of UIComponent.

clearStyle()method 
public function clearStyle(styleProp:String):void

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

Deletes a style property from this component instance.

This does not necessarily cause the getStyle() method to return undefined.

Parameters

styleProp:String — The name of the style property.

commitProperties()method 
protected function commitProperties():void

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

Processes the properties set on the component. This is an advanced method that you might override when creating a subclass of UIComponent.

You do not call this method directly. Flex calls the commitProperties() method when you use the addChild() method to add a component to a container, or when you call the invalidateProperties() method of the component. Calls to the commitProperties() method occur before calls to the measure() method. This lets you set property values that might be used by the measure() method.

Some components have properties that affect the number or kinds of child objects that they need to create, or have properties that interact with each other, such as the horizontalScrollPolicy and horizontalScrollPosition properties. It is often best at startup time to process all of these properties at one time to avoid duplicating work.

contentToGlobal()method 
public function contentToGlobal(point:Point):Point

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

Converts a Point object from content coordinates to global coordinates. Content coordinates specify a pixel position relative to the upper left corner of the component's content, and include all of the component's content area, including any regions that are currently clipped and must be accessed by scrolling the component. You use the content coordinate system to set and get the positions of children of a container that uses absolute positioning. Global coordinates specify a pixel position relative to the upper-left corner of the stage, that is, the outermost edge of the application.

Parameters

point:Point — A Point object that specifies the x and y coordinates in the content coordinate system as properties.

Returns
Point — A Point object with coordinates relative to the Stage.

See also

contentToLocal()method 
public function contentToLocal(point:Point):Point

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

Converts a Point object from content to local coordinates. Content coordinates specify a pixel position relative to the upper left corner of the component's content, and include all of the component's content area, including any regions that are currently clipped and must be accessed by scrolling the component. You use the content coordinate system to set and get the positions of children of a container that uses absolute positioning. Local coordinates specify a pixel position relative to the upper left corner of the component.

Parameters

point:Point — A Point object that specifies the x and y coordinates in the content coordinate system as properties.

Returns
Point — Point A Point object with coordinates relative to the local coordinate system.

See also

createAutomationIDPart()method 
public function createAutomationIDPart(child:IAutomationObject):Object

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

Returns a set of properties that identify the child within this container. These values should not change during the lifespan of the application.

Parameters

child:IAutomationObject — Child for which to provide the id.

Returns
Object — Sets of properties describing the child which can later be used to resolve the component.
createAutomationIDPartWithRequiredProperties()method 
public function createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns a set of properties as automation IDs that identify the child within this container. These values should not change during the lifespan of the application

Parameters

child:IAutomationObject — Child for which to provide the id.
 
properties:Array — which needs to be considered for forming the Id.

Returns
Object — Sets of properties describing the child which can later be used to resolve the component.
createChildren()method 
protected function createChildren():void

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

Create child objects of the component. This is an advanced method that you might override when creating a subclass of UIComponent.

A component that creates other components or objects within it is called a composite component. For example, the Flex ComboBox control is actually made up of a TextInput control to define the text area of the ComboBox, and a Button control to define the ComboBox arrow. Components implement the createChildren() method to create child objects (such as other components) within the component.

From within an override of the createChildren() method, you call the addChild() method to add each child object.

You do not call this method directly. Flex calls the createChildren() method in response to the call to the addChild() method to add the component to its parent.

createInFontContext()method 
protected function createInFontContext(classObj:Class):Object

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

Creates a new object using a context based on the embedded font being used.

This method is used to solve a problem with access to fonts embedded in an application SWF when the framework is loaded as an RSL (the RSL has its own SWF context). Embedded fonts can only be accessed from the SWF file context in which they were created. By using the context of the application SWF, the RSL can create objects in the application SWF context that has access to the application's embedded fonts.

Call this method only after the font styles for this object are set.

Parameters

classObj:Class — The class to create.

Returns
Object — The instance of the class created in the context of the SWF owning the embedded font. If this object is not using an embedded font, the class is created in the context of this object.
createInModuleContext()method 
protected function createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object

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

Creates the object using a given moduleFactory. If the moduleFactory is null or the object cannot be created using the module factory, then fall back to creating the object using a systemManager.

Parameters

moduleFactory:IFlexModuleFactory — The moduleFactory to create the class in; can be null.
 
className:String — The name of the class to create.

Returns
Object — The object created in the context of the moduleFactory.
createReferenceOnParentDocument()method 
public function createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void

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

Creates an id reference to this IUIComponent object on its parent document object. This function can create multidimensional references such as b[2][4] for objects inside one or more repeaters. If the indices are null, it creates a simple non-Array reference.

Parameters

parentDocument:IFlexDisplayObject — The parent of this IUIComponent object.

deleteReferenceOnParentDocument()method 
public function deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void

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

Deletes the id reference to this IUIComponent object on its parent document object. This function can delete from multidimensional references such as b[2][4] for objects inside one or more Repeaters. If the indices are null, it deletes the simple non-Array reference.

Parameters

parentDocument:IFlexDisplayObject — The parent of this IUIComponent object.

determineTextFormatFromStyles()method 
public function determineTextFormatFromStyles():UITextFormat

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

Returns a UITextFormat object corresponding to the text styles for this UIComponent.

Returns
UITextFormat — UITextFormat object corresponding to the text styles for this UIComponent.
dispatchEvent()method 
override public function dispatchEvent(event:Event):Boolean

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

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which the dispatchEvent() method is called.

Parameters

event:Event — The Event object that is dispatched into the event flow. If the event is being redispatched, a clone of the event is created automatically. After an event is dispatched, its target property cannot be changed, so you must create a new copy of the event for redispatching to work.

Returns
Boolean — A value of true if the event was successfully dispatched. A value of false indicates failure or that the preventDefault() method was called on the event.
dispatchPropertyChangeEvent()method 
protected function dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void

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

Helper method for dispatching a PropertyChangeEvent when a property is updated.

Parameters

prop:String — Name of the property that changed.
 
oldValue:* — Old value of the property.
 
value:* — New value of the property.

drawFocus()method 
public function drawFocus(isFocused:Boolean):void

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

Shows or hides the focus indicator around this component.

UIComponent implements this by creating an instance of the class specified by the focusSkin style and positioning it appropriately.

Parameters

isFocused:Boolean — Determines if the focus indicator should be displayed. Set to true to display the focus indicator. Set to false to hide it.

drawRoundRect()method 
public function 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

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

Programmatically draws a rectangle into this skin's Graphics object.

The rectangle can have rounded corners. Its edges are stroked with the current line style of the Graphics object. It can have a solid color fill, a gradient fill, or no fill. A solid fill can have an alpha transparency. A gradient fill can be linear or radial. You can specify up to 15 colors and alpha values at specified points along the gradient, and you can specify a rotation angle or transformation matrix for the gradient. Finally, the rectangle can have a rounded rectangular hole carved out of it.

This versatile rectangle-drawing routine is used by many skins. It calls the drawRect() or drawRoundRect() methods (in the flash.display.Graphics class) to draw into this skin's Graphics object.

Parameters

x:Number — Horizontal position of upper-left corner of rectangle within this skin.
 
y:Number — Vertical position of upper-left corner of rectangle within this skin.
 
w:Number — Width of rectangle, in pixels.
 
h:Number — Height of rectangle, in pixels.
 
r:Object (default = null) — Corner radius/radii of rectangle. Can be null, a Number, or an Object. If it is null, it specifies that the corners should be square rather than rounded. If it is a Number, it specifies the same radius, in pixels, for all four corners. If it is an Object, it should have properties named tl, tr, bl, and br, whose values are Numbers specifying the radius, in pixels, for the top left, top right, bottom left, and bottom right corners. For example, you can pass a plain Object such as { tl: 5, tr: 5, bl: 0, br: 0 }. The default value is null (square corners).
 
c:Object (default = null) — The RGB color(s) for the fill. Can be null, a uint, or an Array. If it is null, the rectangle not filled. If it is a uint, it specifies an RGB fill color. For example, pass 0xFF0000 to fill with red. If it is an Array, it should contain uints specifying the gradient colors. For example, pass [ 0xFF0000, 0xFFFF00, 0x0000FF ] to fill with a red-to-yellow-to-blue gradient. You can specify up to 15 colors in the gradient. The default value is null (no fill).
 
alpha:Object (default = null) — Alpha value(s) for the fill. Can be null, a Number, or an Array. This argument is ignored if color is null. If color is a uint specifying an RGB fill color, then alpha should be a Number specifying the transparency of the fill, where 0.0 is completely transparent and 1.0 is completely opaque. You can also pass null instead of 1.0 in this case to specify complete opaqueness. If color is an Array specifying gradient colors, then alpha should be an Array of Numbers, of the same length, that specifies the corresponding alpha values for the gradient. In this case, the default value is null (completely opaque).
 
rot:Object (default = null) — Matrix object used for the gradient fill. The utility methods horizontalGradientMatrix(), verticalGradientMatrix(), and rotatedGradientMatrix() can be used to create the value for this parameter.
 
gradient:String (default = null) — Type of gradient fill. The possible values are GradientType.LINEAR or GradientType.RADIAL. (The GradientType class is in the package flash.display.)
 
ratios:Array (default = null) — Specifies the distribution of colors. The number of entries must match the number of colors defined in the color parameter. Each value defines the percentage of the width where the color is sampled at 100%. The value 0 represents the left-hand position in the gradient box, and 255 represents the right-hand position in the gradient box.
 
hole:Object (default = null) — A rounded rectangular hole that should be carved out of the middle of the otherwise solid rounded rectangle { x: #, y: #, w: #, h: #, r: # or { br: #, bl: #, tl: #, tr: # } }

See also

flash.display.Graphics.beginGradientFill()
effectFinished()method 
public function effectFinished(effectInst:IEffectInstance):void

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

Called by the effect instance when it stops playing on the component. You can use this method to restore a modification to the component made by the effectStarted() method when the effect started, or perform some other action when the effect ends.

Parameters

effectInst:IEffectInstance — The effect instance object playing on the component.

effectStarted()method 
public function effectStarted(effectInst:IEffectInstance):void

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

Called by the effect instance when it starts playing on the component. You can use this method to perform a modification to the component as part of an effect. You can use the effectFinished() method to restore the modification when the effect ends.

Parameters

effectInst:IEffectInstance — The effect instance object playing on the component.

endEffectsStarted()method 
public function endEffectsStarted():void

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

Ends all currently playing effects on the component.

executeBindings()method 
public function executeBindings(recurse:Boolean = false):void

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

Executes all the bindings for which the UIComponent object is the destination.

Parameters

recurse:Boolean (default = false) — Recursively execute bindings for children of this component.

finishPrint()method 
public function finishPrint(obj:Object, target:IFlexDisplayObject):void

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

Called after printing is complete. For the UIComponent class, the method performs no action. Flex containers override the method to restore the container after printing.

This method is normally not used by application developers.

Parameters

obj:Object — Contains the properties of the component that restore it to its state before printing.
 
target:IFlexDisplayObject — The component that just finished printing. It can be the current component or one of its children.

See also

mx.printing.FlexPrintJob
focusInHandler()method 
protected function focusInHandler(event:FocusEvent):void

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

The event handler called when a UIComponent object gets focus. If you override this method, make sure to call the base class version.

Parameters

event:FocusEvent — The event object.

focusOutHandler()method 
protected function focusOutHandler(event:FocusEvent):void

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

The event handler called when a UIComponent object loses focus. If you override this method, make sure to call the base class version.

Parameters

event:FocusEvent — The event object.

getAutomationChildAt()method 
public function getAutomationChildAt(index:int):IAutomationObject

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

Provides the automation object at the specified index. This list should not include any children that are composites.

Parameters

index:int — The index of the child to return

Returns
IAutomationObject — The child at the specified index.
getAutomationChildren()method 
public function getAutomationChildren():Array

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Provides the automation object list . This list does not include any children that are composites.

Returns
Array — the automation children.
getBoundsXAtSize()method 
public function getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the x coordinate of the element's bounds at the specified element size.

This method is typically used by layouts during a call to the measure() method to predict what the element position will be, if the element is resized to particular dimensions.

Parameters

width:Number — The element's bounds width, or NaN to use the preferred width.
 
height:Number — The element's bounds height, or NaN to use the preferred height.
 
postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the method returns x coordinate of the element's bounding box top-left corner. The bounding box is in element's parent coordinate space and is calculated from the specified bounds size, layout position and layout transform matrix.

Returns
Number — The x coordinate of the element's bounds at the specified element size.
getBoundsYAtSize()method 
public function getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the y coordinate of the element's bounds at the specified element size. This method is typically used by layouts during a call to the measure() to predict what the element position will be, if the element is resized to particular dimensions.

Parameters

width:Number — The element's bounds width, or NaN to use the preferred width.
 
height:Number — The element's bounds height, or NaN to use the preferred height.
 
postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the method returns the y coordinate of the element's bounding box top-left corner. The bounding box is in element's parent coordinate space and is calculated from the specified bounds size, layout position and layout transform matrix.

Returns
Number — The y coordinate of the element's bounds at the specified element size.
getClassStyleDeclarations()method 
public function getClassStyleDeclarations():Array

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

Finds the type selectors for this UIComponent instance. The algorithm walks up the superclass chain. For example, suppose that class MyButton extends Button. A MyButton instance first looks for a MyButton type selector then, it looks for a Button type selector. then, it looks for a UIComponent type selector. (The superclass chain is considered to stop at UIComponent, not Object.)

Returns
Array — An Array of type selectors for this UIComponent instance.
getConstraintValue()method 
public function getConstraintValue(constraintName:String):*

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

Returns a layout constraint value, which is the same as getting the constraint style for this component.

Parameters

constraintName:String — The name of the constraint style, which can be any of the following: left, right, top, bottom, verticalCenter, horizontalCenter, baseline

Returns
* — Returns the layout constraint value, which can be specified in either of two forms. It can be specified as a numeric string, for example, "10" or it can be specified as identifier:numeric string. For identifier:numeric string, identifier is the id of a ConstraintRow or ConstraintColumn. For example, a value of "cc1:10" specifies a value of 10 for the ConstraintColumn that has the id "cc1."
getExplicitOrMeasuredHeight()method 
public function getExplicitOrMeasuredHeight():Number

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

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

Returns
Number — A Number which is explicitHeight if defined or measuredHeight if not.
getExplicitOrMeasuredWidth()method 
public function getExplicitOrMeasuredWidth():Number

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

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

Returns
Number — A Number which is explicitWidth if defined or measuredWidth if not.
getFocus()method 
public function getFocus():InteractiveObject

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

Gets the object that currently has focus. It might not be this object. Note that this method does not necessarily return the component that has focus. It can return the internal subcomponent of the component that has focus. To get the component that has focus, use the focusManager.focus property.

Returns
InteractiveObject — Object that has focus.
getLayoutBoundsHeight()method 
public function getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the element's layout height. This is the size that the element uses to draw on screen.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the method returns the element's bounding box width. The bounding box is in the element's parent coordinate space and is calculated from the element's layout size and layout transform matrix.

Returns
Number — The element's layout height.
getLayoutBoundsWidth()method 
public function getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the element's layout width. This is the size that the element uses to draw on screen.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the method returns the element's bounding box width. The bounding box is in element's parent coordinate space and is calculated from the element's layout size and layout transform matrix.

Returns
Number — The element's layout width.
getLayoutBoundsX()method 
public function getLayoutBoundsX(postLayoutTransform:Boolean = true):Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the x coordinate that the element uses to draw on screen.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the method returns x coordinate of the element's bounding box top-left corner. The bounding box is in the element's parent coordinate space and is calculated from the element's layout size, layout position and layout transform matrix.

Returns
Number — The x coordinate that the element uses to draw on screen.
getLayoutBoundsY()method 
public function getLayoutBoundsY(postLayoutTransform:Boolean = true):Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the y coordinate that the element uses to draw on screen.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the method returns y coordinate of the element's bounding box top-left corner. The bounding box is in the element's parent coordinate space and is calculated from the element's layout size, layout position, and layout transform matrix.

Returns
Number — The y coordinate that the element uses to draw on screen.
getLayoutMatrix()method 
public function getLayoutMatrix():Matrix

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the transform matrix that is used to calculate the component's layout relative to its siblings.

This matrix is typically defined by the component's 2D properties such as x, y, rotation, scaleX, scaleY, transformX, and transformY. Some components may have additional transform properties that are applied on top of the layout matrix to determine the final, computed matrix. For example UIComponent defines the offsets property.

Returns
Matrix — The layout transform Matrix for this element. Do not directly modify the return value; call the setLayoutMatrix() method instead.
getLayoutMatrix3D()method 
public function getLayoutMatrix3D():Matrix3D

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the layout transform Matrix3D for this element.

This matrix is typically defined by the component's transform properties such as x, y, z, rotationX, rotationY, rotationZ, scaleX, scaleY, scaleZ, transformX, and transformY. Some components may have additional transform properties that are applied on top of the layout matrix to determine the final, computed matrix. For example UIComponent defines the offsets property.

Returns
Matrix3D — The layout transform Matrix3D for this element. Do not directly modify the return value but call the setLayoutMatrix() method instead.
getMaxBoundsHeight()method 
public function getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the element's maximum height.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the method returns the element's bounding box height. The bounding box is in the element's parent coordinate space and is calculated from the element's maximum size and layout transform matrix.

Returns
Number — The element's maximum height.
getMaxBoundsWidth()method 
public function getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the element's maximum width.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the method returns the element's bounding box width. The bounding box is in the element's parent coordinate space and is calculated from the element's maximum size and layout transform matrix.

Returns
Number — The element's maximum width.
getMinBoundsHeight()method 
public function getMinBoundsHeight(postLayoutTransform:Boolean = true):Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the element's minimum height.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the method returns the element's bounding box height. The bounding box is in the element's parent coordinate space and is calculated from the element's minimum size and layout transform matrix.

Returns
Number — The element's maximum height.
getMinBoundsWidth()method 
public function getMinBoundsWidth(postLayoutTransform:Boolean = true):Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the element's minimum width.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the method returns the element's bounding box width. The bounding box is in the element's parent coordinate space and is calculated from the element's minimum size and layout transform matrix.

Returns
Number — The element's maximum width.
getPreferredBoundsHeight()method 
public function getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the element's preferred height.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the method returns the element's bounding box height. The bounding box is in the element's parent coordinate space and is calculated from the element's preferred size and layout transform matrix.

Returns
Number — Returns the element's preferred height. Preferred height is usually based on the default element size and any explicit overrides. For UIComponent this is the same value as returned by the getExplicitOrMeasuredHeight() method.
getPreferredBoundsWidth()method 
public function getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the element's preferred width.

Parameters

postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the method returns the element's bounding box width. The bounding box is in the element's parent coordinate space and is calculated from the element's preferred size and layout transform matrix.

Returns
Number — Returns the element's preferred width. Preferred width is usually based on the default element size and any explicit overrides. For UIComponent this is the same value as returned by the getExplicitOrMeasuredWidth() method.
getRepeaterItem()method 
public function getRepeaterItem(whichRepeater:int = -1):Object

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

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. The argument whichRepeater is 0 for the outermost Repeater, 1 for the next inner Repeater, and so on. If whichRepeater is not specified, the innermost Repeater is used.

Parameters

whichRepeater:int (default = -1) — Number of the Repeater, counting from the outermost one, starting at 0.

Returns
Object — The requested repeater item.
getStyle()method 
public function getStyle(styleProp:String):*

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

Gets a style property that has been set anywhere in this component's style lookup chain.

This same method is used to get any kind of style property, so the value returned can be a Boolean, String, Number, int, uint (for an RGB color), Class (for a skin), or any kind of object. Therefore the return type is simply specified as *.

If you are getting a particular style property, you know its type and often want to store the result in a variable of that type. No casting from * to that type is necessary.

var backgroundColor:uint = getStyle("backgroundColor");

If the style property has not been set anywhere in the style lookup chain, the value returned by getStyle() is undefined. Note that undefined is a special value that is not the same as false, "", NaN, 0, or null. No valid style value is ever undefined. You can use the method IStyleManager2.isValidStyleValue() to test whether the value was set.

Parameters

styleProp:String — Name of the style property.

Returns
* — Style value.
globalToContent()method 
public function globalToContent(point:Point):Point

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

Converts a Point object from global to content coordinates. Global coordinates specify a pixel position relative to the upper-left corner of the stage, that is, the outermost edge of the application. Content coordinates specify a pixel position relative to the upper left corner of the component's content, and include all of the component's content area, including any regions that are currently clipped and must be accessed by scrolling the component. You use the content coordinate system to set and get the positions of children of a container that uses absolute positioning.

Parameters

point:Point — A Point object that specifies the x and y coordinates in the global (Stage) coordinate system as properties.

Returns
Point — Point A Point object with coordinates relative to the component.

See also

hasState()method 
public function hasState(stateName:String):Boolean

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

Determines whether the specified state has been defined on this UIComponent.

Parameters

stateName:String — The name of the state being checked.

Returns
Boolean — Whether or not the specified state has been defined
horizontalGradientMatrix()method 
public function horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix

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

Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.

For performance reasons, the Matrix is stored in a static variable which is reused by all calls to horizontalGradientMatrix() and verticalGradientMatrix(). Therefore, pass the resulting Matrix to drawRoundRect() before calling horizontalGradientMatrix() or verticalGradientMatrix() again.

Parameters

x:Number — The left coordinate of the gradient, in pixels.
 
y:Number — The top coordinate of the gradient, in pixels.
 
width:Number — The width of the gradient, in pixels.
 
height:Number — The height of the gradient, in pixels.

Returns
Matrix — The Matrix for the horizontal gradient.
initAdvancedLayoutFeatures()method 
protected function initAdvancedLayoutFeatures():void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Initializes the implementation and storage of some of the less frequently used advanced layout features of a component. Call this function before attempting to use any of the features implemented by the AdvancedLayoutFeatures object.

initializationComplete()method 
protected function initializationComplete():void

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

Finalizes the initialization of this component.

This method is the last code that executes when you add a component to a parent for the first time using addChild() or addChildAt(). It handles some housekeeping related to dispatching the initialize event. If you are writing a component, you do not need to override this method.

initialize()method 
public function initialize():void

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

Initializes the internal structure of this component.

Initializing a UIComponent is the fourth step in the creation of a visual component instance, and happens automatically the first time that the instance is added to a parent. Therefore, you do not generally need to call initialize(); the Flex framework calls it for you from UIComponent's override of the addChild() and addChildAt() methods.

The first step in the creation of a visual component instance is construction, with the new operator:

      var okButton:Button = new Button();

After construction, the new Button instance is a solitary DisplayObject; it does not yet have a UITextField as a child to display its label, and it doesn't have a parent.

The second step is configuring the newly-constructed instance with the appropriate properties, styles, and event handlers:

      okButton.label = "OK";
      okButton.setStyle("cornerRadius", 0);
      okButton.addEventListener(MouseEvent.CLICK, clickHandler);

The third step is adding the instance to a parent:

      someContainer.addChild(okButton);

A side effect of calling addChild() or addChildAt(), when adding a component to a parent for the first time, is that initialize gets automatically called.

This method first dispatches a preinitialize event, giving developers using this component a chance to affect it before its internal structure has been created. Next it calls the createChildren() method to create the component's internal structure; for a Button, this method creates and adds the UITextField for the label. Then it dispatches an initialize event, giving developers a chance to affect the component after its internal structure has been created.

Note that it is the act of attaching a component to a parent for the first time that triggers the creation of its internal structure. If its internal structure includes other UIComponents, then this is a recursive process in which the tree of DisplayObjects grows by one leaf node at a time.

If you are writing a component, you do not need to override this method.

initializeAccessibility()method 
protected function initializeAccessibility():void

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

Initializes this component's accessibility code.

This method is called by the initialize() method to hook in the component's accessibility code, which resides in a separate class in the mx.accessibility package. Each subclass that supports accessibility must override this method because the hook-in process uses a different static variable in each subclass.

initializeRepeaterArrays()method 
public function initializeRepeaterArrays(parent:IRepeaterClient):void

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

Initializes various properties which keep track of repeated instances of this component.

An MXML <mx:Repeater/> tag can cause repeated instances of a component to be created, one instance for each item in the Repeater's data provider. The instanceIndices, repeaters, and repeaterIndices properties of UIComponent keep track of which instance came from which data item and which Repeater.

This method is an internal method which is automatically called by the Flex framework. You do not have to call it or override it.

Parameters

parent:IRepeaterClient — The parent object containing the Repeater that created this component.

invalidateDisplayList()method 
public function invalidateDisplayList():void

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

Marks a component so that its updateDisplayList() method gets called during a later screen update.

Invalidation is a useful mechanism for eliminating duplicate work by delaying processing of changes to a component until a later screen update. For example, if you want to change the width and height, it would be wasteful to update the component immediately after you change the width and then update again with the new height. It is more efficient to change both properties and then render the component with its new size once.

Invalidation methods rarely get called. In general, setting a property on a component automatically calls the appropriate invalidation method.

invalidateLayering()method 
public function invalidateLayering():void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.4

Called by a component's items to indicate that their depth property has changed. Note that while this function is defined on UIComponent, it is up to subclasses to implement support for complex layering. By default, only Group and DataGroup support arbitrary layering of their children.

See also

invalidateLayoutDirection()method 
public function invalidateLayoutDirection():void

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

An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes. If they differ, this method is responsible for mirroring the element’s contents and for updating the element’s post-layout transform so that descendants inherit a mirrored coordinate system. IVisualElements typically implement mirroring by using postLayoutTransformOffsets to scale the X axis by -1 and to translate the x coordinate of the origin by the element's width. The net effect of this "mirror" transform is to reverse the direction in which the X axis increases without changing the element's location relative to its parent's origin.

invalidateParentSizeAndDisplayList()method 
protected function invalidateParentSizeAndDisplayList():void

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

Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).

invalidateProperties()method 
public function invalidateProperties():void

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

Marks a component so that its commitProperties() method gets called during a later screen update.

Invalidation is a useful mechanism for eliminating duplicate work by delaying processing of changes to a component until a later screen update. For example, if you want to change the text color and size, it would be wasteful to update the color immediately after you change it and then update the size when it gets set. It is more efficient to change both properties and then render the text with its new size and color once.

Invalidation methods rarely get called. In general, setting a property on a component automatically calls the appropriate invalidation method.

invalidateSize()method 
public function invalidateSize():void

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

Marks a component so that its measure() method gets called during a later screen update.

Invalidation is a useful mechanism for eliminating duplicate work by delaying processing of changes to a component until a later screen update. For example, if you want to change the text and font size, it would be wasteful to update the text immediately after you change it and then update the size when it gets set. It is more efficient to change both properties and then render the text with its new size once.

Invalidation methods rarely get called. In general, setting a property on a component automatically calls the appropriate invalidation method.

isOurFocus()method 
protected function isOurFocus(target:DisplayObject):Boolean

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

Typically overridden by components containing UITextField objects, where the UITextField object gets focus.

Parameters

target:DisplayObject — A UIComponent object containing a UITextField object that can receive focus.

Returns
Boolean — Returns true if the UITextField object has focus.
keyDownHandler()method 
protected function keyDownHandler(event:KeyboardEvent):void

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

The event handler called for a keyDown event. If you override this method, make sure to call the base class version.

Parameters

event:KeyboardEvent — The event object.

keyUpHandler()method 
protected function keyUpHandler(event:KeyboardEvent):void

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

The event handler called for a keyUp event. If you override this method, make sure to call the base class version.

Parameters

event:KeyboardEvent — The event object.

localToContent()method 
public function localToContent(point:Point):Point

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

Converts a Point object from local to content coordinates. Local coordinates specify a pixel position relative to the upper left corner of the component. Content coordinates specify a pixel position relative to the upper left corner of the component's content, and include all of the component's content area, including any regions that are currently clipped and must be accessed by scrolling the component. You use the content coordinate system to set and get the positions of children of a container that uses absolute positioning.

Parameters

point:Point — A Point object that specifies the x and y coordinates in the local coordinate system as properties.

Returns
Point — Point A Point object with coordinates relative to the content coordinate system.

See also

matchesCSSState()method 
public function matchesCSSState(cssState:String):Boolean

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

Returns true if cssState matches currentCSSState. Typically, you do not call this method directly. It is called by the mx.styles.CSSCondition.matchesStyleClient() method.

Note Spark components use their skin state as the pseudo state. Halo components use the currentState property.

Parameters

cssState:String — A possible value of CSSCondition.value. It represents the current state of this component used to match CSS pseudo-selectors.

Returns
Booleantrue if cssState matches currentCSSState. By default, currentCSSState is the same as currentState. If no state exists, return null.
matchesCSSType()method 
public function matchesCSSType(cssType:String):Boolean

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

Determines whether this instance is the same as, or is a subclass of, the given type. Typically, you do not call this method directly. It is called by the mx.styles.CSSCondition.matchesStyleClient() method.

Parameters

cssType:String — A CSSSelector object.

Returns
Booleantrue if cssType is in the hierarchy of qualified type selectors.
measure()method 
protected function measure():void

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

Calculates the default size, and optionally the default minimum size, of the component. This is an advanced method that you might override when creating a subclass of UIComponent.

You do not call this method directly. Flex calls the measure() method when the component is added to a container using the addChild() method, and when the component's invalidateSize() method is called.

When you set a specific height and width of a component, Flex does not call the measure() method, even if you explicitly call the invalidateSize() method. That is, Flex only calls the measure() method if the explicitWidth property or the explicitHeight property of the component is NaN.

In your override of this method, you must set the measuredWidth and measuredHeight properties to define the default size. You can optionally set the measuredMinWidth and measuredMinHeight properties to define the default minimum size.

Most components calculate these values based on the content they are displaying, and from the properties that affect content display. A few components simply have hard-coded default values.

The conceptual point of measure() is for the component to provide its own natural or intrinsic size as a default. Therefore, the measuredWidth and measuredHeight properties should be determined by factors such as:

In some cases, there is no intrinsic way to determine default values. For example, a simple GreenCircle component might simply set measuredWidth = 100 and measuredHeight = 100 in its measure() method to provide a reasonable default size. In other cases, such as a TextArea, an appropriate computation (such as finding the right width and height that would just display all the text and have the aspect ratio of a Golden Rectangle) might be too time-consuming to be worthwhile.

The default implementation of measure() sets measuredWidth, measuredHeight, measuredMinWidth, and measuredMinHeight to 0.

measureHTMLText()method 
public function measureHTMLText(htmlText:String):TextLineMetrics

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

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.

Parameters

htmlText:String — A String specifying the HTML text to measure.

Returns
TextLineMetrics — A TextLineMetrics object containing the text measurements.
measureText()method 
public function measureText(text:String):TextLineMetrics

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

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. Does not work for Spark components since they don't use UITextField (or UIFTETextField). To measure text in Spark components, get the measurements of a spark.components.Label or spark.components.RichText

Parameters

text:String — A String specifying the text to measure.

Returns
TextLineMetrics — A TextLineMetrics object containing the text measurements.
move()method 
public function move(x:Number, y:Number):void

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

Moves the component to a specified position within its parent. Calling this method is exactly the same as setting the component's x and y properties.

If you are overriding the updateDisplayList() method in a custom component, call the move() method rather than setting the x and y properties. The difference is that the move() method changes the location of the component and then dispatches a move event when you call the method, while setting the x and y properties changes the location of the component and dispatches the event on the next screen refresh.

Parameters

x:Number — Left position of the component within its parent.
 
y:Number — Top position of the component within its parent.

notifyStyleChangeInChildren()method 
public function notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void

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

Propagates style changes to the children. You typically never need to call this method.

Parameters

styleProp:String — String specifying the name of the style property.
 
recursive:Boolean — Recursivly notify all children of this component.

owns()method 
public function owns(child:DisplayObject):Boolean

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

Returns true if the chain of owner properties points from child to this UIComponent.

Parameters

child:DisplayObject — A UIComponent.

Returns
Booleantrue if the child is parented or owned by this UIComponent.
parentChanged()method 
public function parentChanged(p:DisplayObjectContainer):void

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

Called by Flex when a UIComponent object is added to or removed from a parent. Developers typically never need to call this method.

Parameters

p:DisplayObjectContainer — The parent of this UIComponent object.

prepareToPrint()method 
public function prepareToPrint(target:IFlexDisplayObject):Object

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

Prepares an IFlexDisplayObject for printing. For the UIComponent class, the method performs no action. Flex containers override the method to prepare for printing; for example, by removing scroll bars from the printed output.

This method is normally not used by application developers.

Parameters

target:IFlexDisplayObject — The component to be printed. It can be the current component or one of its children.

Returns
Object — Object containing the properties of the current component required by the finishPrint() method to restore it to its previous state.

See also

mx.printing.FlexPrintJob
regenerateStyleCache()method 
public function regenerateStyleCache(recursive:Boolean):void

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

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.

The Flex framework calls this method in the following situations:

Building the style cache is a computation-intensive operation, so avoid changing styleName or setting selector styles unnecessarily.

This method is not called when you set an instance style by calling the setStyle() method of UIComponent. Setting an instance style is a relatively fast operation compared with setting a selector style.

You do not need to call or override this method.

Parameters

recursive:Boolean — Recursively regenerates the style cache for all children of this component.

registerEffects()method 
public function registerEffects(effects:Array):void

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

For each effect event, registers the EffectManager as one of the event listeners. You typically never need to call this method.

Parameters

effects:Array — The names of the effect events.

removeStyleClient()method 
public function removeStyleClient(styleClient:IAdvancedStyleClient):void

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

Removes a non-visual style client from this component instance. Once this method has been called, the non-visual style client will no longer inherit style changes from this component instance. As a side effect, this method will set the styleParent property of the styleClient parameter to null. If the styleClient has not been added to this component instance, no action will be taken.

Parameters

styleClient:IAdvancedStyleClient — The IAdvancedStyleClient to remove from this component's list of non-visual style clients.

See also

replayAutomatableEvent()method 
public function replayAutomatableEvent(event:Event):Boolean

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

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

Parameters

event:Event — The event to replay.

Returns
Booleantrue if a replay was successful.
resolveAutomationIDPart()method 
public function resolveAutomationIDPart(criteria:Object):Array

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

Resolves a child by using the id provided. The id is a set of properties as provided by the createAutomationIDPart() method.

Parameters

criteria:Object — Set of properties describing the child. The criteria can contain regular expression values resulting in multiple children being matched.

Returns
Array — Array of children that matched the criteria or null if no children could not be resolved.
resourcesChanged()method 
protected function resourcesChanged():void

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

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.

This event is dispatched when you set the ResourceManager's localeChain property, when a resource module has finished loading, and when you call the ResourceManager's update() method.

Subclasses should override this method and, after calling super.resourcesChanged(), do whatever is appropriate in response to having new resource values.

resumeBackgroundProcessing()method 
public static function resumeBackgroundProcessing():void

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

Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().

Refer to the description of suspendBackgroundProcessing() for more information.

setActualSize()method 
public function setActualSize(w:Number, h:Number):void

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

Sizes the object. Unlike directly setting the width and height properties, calling the setActualSize() method does not set the explictWidth and explicitHeight properties, so a future layout calculation can result in the object returning to its previous size. This method is used primarily by component developers implementing the updateDisplayList() method, by Effects, and by the LayoutManager.

Parameters

w:Number — Width of the object.
 
h:Number — Height of the object.

setConstraintValue()method 
public function setConstraintValue(constraintName:String, value:*):void

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

Sets a layout constraint value, which is the same as setting the constraint style for this component.

Parameters

constraintName:String — The name of the constraint style, which can be any of the following: left, right, top, bottom, verticalCenter, horizontalCenter, baseline
 
value:* — The value of the constraint can be specified in either of two forms. It can be specified as a numeric string, for example, "10" or it can be specified as identifier:numeric string. For identifier:numeric string, identifier is the id of a ConstraintRow or ConstraintColumn. For example, a value of "cc1:10" specifies a value of 10 for the ConstraintColumn that has the id "cc1."

setCurrentState()method 
public function setCurrentState(stateName:String, playTransition:Boolean = true):void

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

Set the current state.

Parameters

stateName:String — The name of the new view state.
 
playTransition:Boolean (default = true) — If true, play the appropriate transition when the view state changes.

See also

setFocus()method 
public function setFocus():void

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

Sets the focus to this component. The component can in turn pass focus to a subcomponent.

Note: Only the TextInput and TextArea controls show a highlight when this method sets the focus. All controls show a highlight when the user tabs to the control.

setLayoutBoundsPosition()method 
public function setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Sets the coordinates that the element uses to draw on screen.

Note that calls to the setLayoutBoundSize() method can affect the layout position, so call setLayoutBoundPosition() after calling setLayoutBoundSize().

Parameters

x:Number — The x-coordinate of the top-left corner of the bounding box.
 
y:Number — The y-coordinate of the top-left corner of the bounding box.
 
postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the element is positioned in such a way that the top-left corner of its bounding box is (x, y). The bounding box is in the element's parent coordinate space and is calculated from the element's layout size, layout position and layout transform matrix.

setLayoutBoundsSize()method 
public function setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Sets the layout size of the element. This is the size that the element uses to draw on screen.

If the width and/or height parameters are left unspecified (NaN), Flex sets the element's layout size to its preferred width and/or preferred height.

Note that calls to the setLayoutBoundSize() method can affect the layout position, so call setLayoutBoundPosition() after calling setLayoutBoundSize().

Parameters

width:Number — The element's layout width.
 
height:Number — The element's layout height.
 
postLayoutTransform:Boolean (default = true) — When postLayoutTransform is true, the specified sizes are those of the element's bounding box. The bounding box is in the element's parent coordinate space and is calculated from the element's layout size, layout position, and layout transform matrix.

setLayoutMatrix()method 
public function setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.

The matrix is typically defined by the component's 2D properties such as x, y, rotation, scaleX, scaleY, transformX, and transformY. Some components may have additional transform properties that are applied on top of the layout matrix to determine the final, computed matrix. For example UIComponent defines the offsets.

Note that layout Matrix is factored in the getPreferredSize(), getMinSize(), getMaxSize(), getLayoutSize() methods when computed in parent coordinates as well as in getLayoutPosition() in both parent and child coordinates. Layouts that calculate the transform matrix explicitly typically call this method and work with sizes in child coordinates. Layouts calling this method pass false to the invalidateLayout() method so that a subsequent layout pass is not triggered.

Parameters

value:Matrix — The matrix.
 
invalidateLayout:Booleantrue to cause the parent container to re-layout its children. You typically pass true to the invalidateLayout() method.

setLayoutMatrix3D()method 
public function setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.

This matrix is typically defined by the component's transform properties such as x, y, z, rotationX, rotationY, rotationZ, scaleX, scaleY, scaleZ, transformX, and transformY. Some components may have additional transform properties that are applied on top of the layout matrix to determine the final, computed matrix. For example UIComponent defines the offsets property.

Note that layout Matrix3D is factored in the getPreferredSize(), getMinSize(), getMaxSize(), getLayoutSize() when computed in parent coordinates as well as in getLayoutPosition() in both parent and child coordinates. Layouts that calculate the transform matrix explicitly typically call this method and work with sizes in child coordinates. Layouts calling this method pass false to the invalidateLayout() method so that a subsequent layout pass is not triggered.

Parameters

value:Matrix3D — The matrix.
 
invalidateLayout:Booleantrue to cause the parent container to re-layout its children. You typically pass true to the invalidateLayout() method.

setStretchXY()method 
protected function setStretchXY(stretchX:Number, stretchY:Number):void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Specifies a transform stretch factor in the horizontal and vertical direction. The stretch factor is applied to the computed matrix before any other transformation.

Parameters

stretchX:Number — The horizontal component of the stretch factor.
 
stretchY:Number — The vertical component of the stretch factor.

setStyle()method 
public function setStyle(styleProp:String, newValue:*):void

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

Sets a style property on this component instance.

This can override a style that was set globally.

Calling the setStyle() method can result in decreased performance. Use it only when necessary.

Parameters

styleProp:String — Name of the style property.
 
newValue:* — New value for the style.

setVisible()method 
public function setVisible(value:Boolean, noEvent:Boolean = false):void

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

Called when the visible property changes. Set the visible property to show or hide a component instead of calling this method directly.

Parameters

value:Boolean — The new value of the visible property. Specify true to show the component, and false to hide it.
 
noEvent:Boolean (default = false) — If true, do not dispatch an event. If false, dispatch a show event when the component becomes visible, and a hide event when the component becomes invisible.

stateChanged()method 
protected function stateChanged(oldState:String, newState:String, recursive:Boolean):void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

This method is called when a state changes to check whether state-specific styles apply to this component. If there is a chance of a matching CSS pseudo-selector for the current state, the style cache needs to be regenerated for this instance and, potentially all children, if the recursive param is set to true.

Parameters

oldState:String — The name of th eold state.
 
newState:String — The name of the new state.
 
recursive:Boolean — Set to true to perform a recursive check.

styleChanged()method 
public function styleChanged(styleProp:String):void

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

Detects changes to style properties. When any style property is set, Flex calls the styleChanged() method, passing to it the name of the style being set.

This is an advanced method that you might override when creating a subclass of UIComponent. When you create a custom component, you can override the styleChanged() method to check the style name passed to it, and handle the change accordingly. This lets you override the default behavior of an existing style, or add your own custom style properties.

If you handle the style property, your override of the styleChanged() method should call the invalidateDisplayList() method to cause Flex to execute the component's updateDisplayList() method at the next screen update.

Parameters

styleProp:String — The name of the style property, or null if all styles for this component have changed.

stylesInitialized()method 
public function stylesInitialized():void

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

Flex calls the stylesInitialized() method when the styles for a component are first initialized.

This is an advanced method that you might override when creating a subclass of UIComponent. Flex guarantees that your component's styles are fully initialized before the first time your component's measure and updateDisplayList methods are called. For most components, that is sufficient. But if you need early access to your style values, you can override the stylesInitialized() function to access style properties as soon as they are initialized the first time.

suspendBackgroundProcessing()method 
public static function suspendBackgroundProcessing():void

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

Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.

These methods can be useful when you have time-critical code which needs to execute without interruption. For example, when you set the suspendBackgroundProcessing property of an Effect to true, suspendBackgroundProcessing() is automatically called when it starts playing, and resumeBackgroundProcessing is called when it stops, in order to ensure that the animation is smooth.

Since the LayoutManager uses callLater(), this means that commitProperties(), measure(), and updateDisplayList() is not called in between calls to suspendBackgroundProcessing() and resumeBackgroundProcessing().

It is safe for both an outer method and an inner method (i.e., one that the outer methods calls) to call suspendBackgroundProcessing() and resumeBackgroundProcessing(), because these methods actually increment and decrement a counter which determines whether background processing occurs.

transformAround()method 
public function 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

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

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. This function will assign the rotation, scale, and translation values provided, then update the x/y/z properties as necessary to keep the transform center fixed.

Parameters

transformCenter:Vector3D — The point, in the component's own coordinates, to keep fixed relative to its parent.
 
scale:Vector3D (default = null) — The new values for the scale of the transform.
 
rotation:Vector3D (default = null) — the new values for the rotation of the transform
 
translation:Vector3D (default = null) — The new values for the translation of the transform.
 
postLayoutScale:Vector3D (default = null) — The new values for the post-layout scale of the transform.
 
postLayoutRotation:Vector3D (default = null) — The new values for the post-layout rotation of the transform.
 
postLayoutTranslation:Vector3D (default = null) — The new values for the post-layout translation of the transform.
 
invalidateLayout:Boolean (default = true) — If true, the parent container size and display are invalidated. Layouts calling this method pass false so that a subsequent layout pass is not triggered.

transformPointToParent()method 
public function transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

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. The pre-layout and post-layout result is set on the position and postLayoutPosition parameters, if they are non-null.

Parameters

localPosition:Vector3D — The point to be transformed, specified in the local coordinates of the object.
 
position:Vector3D — A Vector3D point that holds the pre-layout result. If null, the parameter is ignored.
 
postLayoutPosition:Vector3D — A Vector3D point that holds the post-layout result. If null, the parameter is ignored.

updateDisplayList()method 
protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

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

Draws the object and/or sizes and positions its children. This is an advanced method that you might override when creating a subclass of UIComponent.

You do not call this method directly. Flex calls the updateDisplayList() method when the component is added to a container using the addChild() method, and when the component's invalidateDisplayList() method is called.

If the component has no children, this method is where you would do programmatic drawing using methods on the component's Graphics object such as graphics.drawRect().

If the component has children, this method is where you would call the move() and setActualSize() methods on its children.

Components can do programmatic drawing even if they have children. In doing either, use the component's unscaledWidth and unscaledHeight as its bounds.

It is important to use unscaledWidth and unscaledHeight instead of the width and height properties.

Parameters

unscaledWidth:Number — Specifies the width of the component, in pixels, in the component's coordinates, regardless of the value of the scaleX property of the component.
 
unscaledHeight:Number — Specifies the height of the component, in pixels, in the component's coordinates, regardless of the value of the scaleY property of the component.

validateDisplayList()method 
public function validateDisplayList():void

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

Validates the position and size of children and draws other visuals. If the LayoutManager.invalidateDisplayList() method is called with this ILayoutManagerClient, then the validateDisplayList() method is called when it's time to update the display list.

validateNow()method 
public function validateNow():void

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

Validate and update the properties and layout of this object and redraw it, if necessary. Processing properties that require substantial computation are normally not processed until the script finishes executing. For example setting the width property is delayed, because it can require recalculating the widths of the objects children or its parent. Delaying the processing prevents it from being repeated multiple times if the script sets the width property more than once. This method lets you manually override this behavior.

validateProperties()method 
public function validateProperties():void

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

Used by layout logic to validate the properties of a component by calling the commitProperties() method. In general, subclassers should override the commitProperties() method and not this method.

validateSize()method 
public function validateSize(recursive:Boolean = false):void

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

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.

Parameters

recursive:Boolean (default = false) — If true, call this method on the objects children.

validationResultHandler()method 
public function validationResultHandler(event:ValidationResultEvent):void

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

Handles both the valid and invalid events from a validator assigned to this component.

You typically handle the valid and invalid events dispatched by a validator by assigning event listeners to the validators. If you want to handle validation events directly in the component that is being validated, you can override this method to handle the valid and invalid events. You typically call super.validationResultHandler(event) in your override.

Parameters

event:ValidationResultEvent — The event object for the validation.

See also

verticalGradientMatrix()method 
public function verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix

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

Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.

For performance reasons, the Matrix is stored in a static variable which is reused by all calls to horizontalGradientMatrix() and verticalGradientMatrix(). Therefore, pass the resulting Matrix to drawRoundRect() before calling horizontalGradientMatrix() or verticalGradientMatrix() again.

Parameters

x:Number — The left coordinate of the gradient, in pixels.
 
y:Number — The top coordinate of the gradient, in pixels.
 
width:Number — The width of the gradient, in pixels.
 
height:Number — The height of the gradient, in pixels.

Returns
Matrix — The Matrix for the vertical gradient.
Event Detail
add Event
Event Object Type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.ADD

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

Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. If the component is added to the container as a noncontent child by using the rawChildren.addChild() or rawChildren.addChildAt() method, the event is not dispatched.

This event is only dispatched when there are one or more relevant listeners attached to the dispatching object.

The FlexEvent.ADD constant defines the value of the type property of the event object for an add event.

This event will only be dispatched when there are one or more relevant listeners attached to the dispatching object.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
creationComplete Event  
Event Object Type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.CREATION_COMPLETE

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

Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing.

At this point, depending on its visible property, the component is not visible even though it has been drawn.

The FlexEvent.CREATION_COMPLETE constant defines the value of the type property of the event object for a creationComplete event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
currentStateChange Event  
Event Object Type: mx.events.StateChangeEvent
StateChangeEvent.type property = mx.events.StateChangeEvent.CURRENT_STATE_CHANGE

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

Dispatched after the view state has changed.

This event is only dispatched when there are one or more relevant listeners attached to the dispatching object.

The StateChangeEvent.CURRENT_STATE_CHANGE constant defines the value of the type property of the event that is dispatched when the view state has changed. The value of this constant is "currentStateChange".

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
newStateThe name of the view state that was entered.
oldStateThe name of the view state that was exited.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeStateChangeEvent.CURRENT_STATE_CHANGE
currentStateChanging Event  
Event Object Type: mx.events.StateChangeEvent
StateChangeEvent.type property = mx.events.StateChangeEvent.CURRENT_STATE_CHANGING

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

Dispatched after the currentState property changes, but before the view state changes.

This event is only dispatched when there are one or more relevant listeners attached to the dispatching object.

The StateChangeEvent.CURRENT_STATE_CHANGING constant defines the value of the type property of the event that is dispatched when the view state is about to change. The value of this constant is "currentStateChanging".

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
newStateThe name of the view state that is being entered.
oldStateThe name of the view state that is being exited.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
typeStateChangeEvent.CURRENT_STATE_CHANGING
dragComplete Event  
Event Object Type: mx.events.DragEvent
DragEvent.type property = mx.events.DragEvent.DRAG_COMPLETE

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

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.

You can use this event to perform any final cleanup of the drag-and-drop operation. For example, if you drag a List control item from one list to another, you can delete the List control item from the source if you no longer need it.

If you call Event.preventDefault() in the event handler for the dragComplete event for a Tree control when dragging data from one Tree control to another, it prevents the drop.

The DragEvent.DRAG_COMPLETE constant defines the value of the type property of the event object for a dragComplete event.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
dragDrop Event  
Event Object Type: mx.events.DragEvent
DragEvent.type property = mx.events.DragEvent.DRAG_DROP

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

Dispatched by the drop target when the user releases the mouse over it.

You use this event handler to add the drag data to the drop target.

If you call Event.preventDefault() in the event handler for the dragDrop event for a Tree control when dragging data from one Tree control to another, it prevents the drop.

The DragEvent.DRAG_DROP constant defines the value of the type property of the event object for a dragDrop event.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
dragEnter Event  
Event Object Type: mx.events.DragEvent
DragEvent.type property = mx.events.DragEvent.DRAG_ENTER

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

Dispatched by a component when the user moves the mouse over the component during a drag operation. In an application running in Flash Player, the event is dispatched many times when you move the mouse over any component. In an application running in AIR, the event is dispatched only once.

In order to be a valid drop target, you must define a handler for this event. In the handler, you can change the appearance of the drop target to provide visual feedback to the user that the component can accept the drag. For example, you could draw a border around the drop target, or give focus to the drop target.

If you want to accept the drag, you must call the DragManager.acceptDragDrop() method. If you don't call acceptDragDrop(), you do not get any of the other drag events.

In Flash Player, the value of the action property is always DragManager.MOVE, even if you are doing a copy. This is because the dragEnter event occurs before the control recognizes that the Control key is pressed to signal a copy. The action property of the event object for the dragOver event does contain a value that signifies the type of drag operation. You can change the type of drag action by calling the DragManager.showFeedback() method.

In AIR, the default value of the action property is DragManager.COPY.

Because of the way data to a Tree control is structured, the Tree control handles drag and drop differently from the other list-based controls. For the Tree control, the event handler for the dragDrop event only performs an action when you move or copy data in the same Tree control, or copy data to another Tree control. If you drag data from one Tree control and drop it onto another Tree control to move the data, the event handler for the dragComplete event actually performs the work to add the data to the destination Tree control, rather than the event handler for the dragDrop event, and also removes the data from the source Tree control. This is necessary because to reparent the data being moved, Flex must remove it first from the source Tree control.

The DragEvent.DRAG_ENTER constant defines the value of the type property of the event object for a dragEnter event.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event, which is always DragManager.MOVE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

dragExit Event  
Event Object Type: mx.events.DragEvent
DragEvent.type property = mx.events.DragEvent.DRAG_EXIT

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

Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.

You use this event to restore the drop target to its normal appearance if you modified its appearance as part of handling the dragEnter or dragOver event.

The DragEvent.DRAG_EXIT constant defines the value of the type property of the event object for a dragExit event.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
dragOver Event  
Event Object Type: mx.events.DragEvent
DragEvent.type property = mx.events.DragEvent.DRAG_OVER

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

Dispatched by a component when the user moves the mouse while over the component during a drag operation. In Flash Player, the event is dispatched when you drag an item over a valid drop target. In AIR, the event is dispatched when you drag an item over any component, even if the component is not a valid drop target.

In the handler, you can change the appearance of the drop target to provide visual feedback to the user that the component can accept the drag. For example, you could draw a border around the drop target, or give focus to the drop target.

Handle this event to perform additional logic before allowing the drop, such as dropping data to various locations in the drop target, reading keyboard input to determine if the drag-and-drop action is a move or copy of the drag data, or providing different types of visual feedback based on the type of drag-and-drop action.

You can also change the type of drag action by changing the DragManager.showFeedback() method. The default value of the action property is DragManager.MOVE.

The DragEvent.DRAG_OVER constant defines the value of the type property of the event object for a dragOver event.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

See also

dragStart Event  
Event Object Type: mx.events.DragEvent
DragEvent.type property = mx.events.DragEvent.DRAG_START

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

Dispatched by the drag initiator when starting a drag operation. This event is used internally by the list-based controls; you do not handle it when implementing drag and drop. If you want to control the start of a drag-and-drop operation, use the mouseDown or mouseMove event.

The DragEvent.DRAG_START constant defines the value of the type property of the event object for a dragStart event.

The properties of the event object have the following values:

PropertyValue
actionThe action that caused the event: DragManager.COPY, DragManager.LINK, DragManager.MOVE, or DragManager.NONE.
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
dragInitiatorThe component that initiated the drag.
dragSourceThe DragSource object containing the data being dragged.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
effectEnd Event  
Event Object Type: mx.events.EffectEvent
EffectEvent.type property = mx.events.EffectEvent.EFFECT_END

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

Dispatched after an effect ends.

The effect makes the last set of visual changes before this event is fired, but those changes are not rendered on the screen. Thus, you might have to use the callLater() method to delay any other changes that you want to make until after the changes have been rendered onscreen.

The EffectEvent.EFFECT_END constant defines the value of the type property of the event object for an effectEnd event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
effectInstanceThe effect instance object for the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
effectStart Event  
Event Object Type: mx.events.EffectEvent
EffectEvent.type property = mx.events.EffectEvent.EFFECT_START

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

Dispatched just before an effect starts.

The effect does not start changing any visuals until after this event is fired.

The EffectEvent.EFFECT_START constant defines the value of the type property of the event object for an effectStart event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
effectInstanceThe effect instance object for the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
effectStop Event  
Event Object Type: mx.events.EffectEvent
EffectEvent.type property = mx.events.EffectEvent.EFFECT_STOP

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

Dispatched after an effect is stopped, which happens only by a call to stop() on the effect.

The effect then dispatches the EFFECT_END event as the effect finishes. The purpose of the EFFECT_STOP event is to let listeners know that the effect came to a premature end, rather than ending naturally or as a result of a call to end().

The EffectEvent.EFFECT_STOP constant defines the value of the type property of the event object for an effectStop event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
effectInstanceThe effect instance object for the event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
enterState Event  
Event Object Type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.ENTER_STATE

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

Dispatched after the component has entered a view state.

This event is only dispatched when there are one or more relevant listeners attached to the dispatching object.

The FlexEvent.ENTER_STATE constant defines the value of the type property of the event object for a enterState event.

This event will only be dispatched when there are one or more relevant listeners attached to the dispatching object.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
exitState Event  
Event Object Type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.EXIT_STATE

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

Dispatched just before the component exits a view state.

This event is only dispatched when there are one or more relevant listeners attached to the dispatching object.

The FlexEvent.EXIT_STATE constant defines the value of the type property of the event object for a exitState event.

This event will only be dispatched when there are one or more relevant listeners attached to the dispatching object.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
hide Event  
Event Object Type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.HIDE

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

Dispatched when an object's state changes from visible to invisible.

This event is only dispatched when there are one or more relevant listeners attached to the dispatching object.

The FlexEvent.HIDE constant defines the value of the type property of the event object for a hide event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
initialize Event  
Event Object Type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.INITIALIZE

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

Dispatched when the component has finished its construction and has all initialization properties set.

After the initialization phase, properties are processed, the component is measured, laid out, and drawn, after which the creationComplete event is dispatched.

The FlexEvent.INITIALIZE constant defines the value of the type property of the event object for a initialize event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
invalid Event  
Event Object Type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.INVALID

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

Dispatched when a component is monitored by a Validator and the validation failed.

The FlexEvent.INVALID constant defines the value of the type property of the event object for a invalid event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
mouseDownOutside Event  
Event Object Type: mx.events.FlexMouseEvent
FlexMouseEvent.type property = mx.events.FlexMouseEvent.MOUSE_DOWN_OUTSIDE

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

Dispatched from a component opened using the PopUpManager when the user clicks outside it.

The FlexMouseEvent.MOUSE_DOWN_OUTSIDE constant defines the value of the type property of the event object for a mouseDownOutside event.

The properties of the event object have the following values:

PropertyValue
altKeyIndicates whether the Alt key is down (true) or not (false).
bubblesfalse
buttonDownIndicates whether the main mouse button is down (true) or not (false).
cancelablefalse
ctrlKeyIndicates whether the Control key is down (true) or not (false).
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget. For PopUpManager events, the object is the pop-up window.
deltaIndicates how many lines should be scrolled for each notch the user scrolls the mouse wheel. For PopUpManager events this value is 0.
localXThe horizontal position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control.
localYThe vertical position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control.
relatedObjectA reference to a display list object that is related to the event. For PopUpManager events, the object is the container over which the mouse pointer is located.
shiftKeyIndicates whether the Shift key is down (true) or not (false).
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event. For PopUpManager events, the object is the pop-up window.
mouseWheelOutside Event  
Event Object Type: mx.events.FlexMouseEvent
FlexMouseEvent.type property = mx.events.FlexMouseEvent.MOUSE_WHEEL_OUTSIDE

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

Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.

The FlexMouseEvent.MOUSE_WHEEL_OUTSIDE constant defines the value of the type property of the event object for a mouseWheelOutside event.

The properties of the event object have the following values:

PropertyValue
altKeyIndicates whether the Alt key is down (true) or not (false).
bubblesfalse
buttonDownIndicates whether the main mouse button is down (true) or not (false).
cancelablefalse
ctrlKeyIndicates whether the Control key is down (true) or not (false).
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget. For PopUpManager events, the object is the pop-up window.
deltaIndicates how many lines should be scrolled for each notch the user scrolls the mouse wheel. For PopUpManager events this value is 0.
localXThe horizontal position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control.
localYThe vertical position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control.
relatedObjectA reference to a display list object that is related to the event. For PopUpManager events, the object is the container over which the mouse pointer is located.
shiftKeyIndicates whether the Shift key is down (true) or not (false).
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event. For PopUpManager events, the object is the pop-up window.
move Event  
Event Object Type: mx.events.MoveEvent
MoveEvent.type property = mx.events.MoveEvent.MOVE

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

Dispatched when the object has moved.

You can move the component by setting the x or y properties, by calling the move() method, by setting one of the following properties either on the component or on other components such that the LayoutManager needs to change the x or y properties of the component:

When you call the move() method, the move event is dispatched before the method returns. In all other situations, the move event is not dispatched until after the property changes.

This event only dispatched when there are one or more relevant listeners attached to the dispatching object.

The MoveEvent.MOVE constant defines the value of the type property of the event object for a move event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
oldXThe previous x coordinate of the object, in pixels.
oldYThe previous y coordinate of the object, in pixels.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
preinitialize Event  
Event Object Type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.PREINITIALIZE

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

Dispatched at the beginning of the component initialization sequence. The component is in a very raw state when this event is dispatched. Many components, such as the Button control, create internal child components to implement functionality; for example, the Button control creates an internal UITextField component to represent its label text. When Flex dispatches the preinitialize event, the children, including the internal children, of a component have not yet been created.

The FlexEvent.PREINITIALIZE constant defines the value of the type property of the event object for a preinitialize event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
remove Event  
Event Object Type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.REMOVE

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

Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. If the component is removed from the container as a noncontent child by using the rawChildren.removeChild() or rawChildren.removeChildAt() method, the event is not dispatched.

This event only dispatched when there are one or more relevant listeners attached to the dispatching object.

The FlexEvent.REMOVE constant defines the value of the type property of the event object for an remove event.

This event will only be dispatched when there are one or more relevant listeners attached to the dispatching object.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
resize Event  
Event Object Type: mx.events.ResizeEvent
ResizeEvent.type property = mx.events.ResizeEvent.RESIZE

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

Dispatched when the component is resized.

You can resize the component by setting the width or height property, by calling the setActualSize() method, or by setting one of the following properties either on the component or on other components such that the LayoutManager needs to change the width or height properties of the component:

The resize event is not dispatched until after the property changes.

This event only dispatched when there are one or more relevant listeners attached to the dispatching object.

The ResizeEvent.RESIZE constant defines the value of the type property of the event object for a resize event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
oldHeightThe previous height of the object, in pixels.
oldWidthThe previous width of the object, in pixels.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
show Event  
Event Object Type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.SHOW

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

Dispatched when an object's state changes from invisible to visible.

This event is only dispatched when there are one or more relevant listeners attached to the dispatching object.

The FlexEvent.SHOW constant defines the value of the type property of the event object for a show event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
stateChangeComplete Event  
Event Object Type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.STATE_CHANGE_COMPLETE

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. The event is dispatched immediately if there's no transition playing between the states. If the component switches to a different state while the transition is underway, this event will be dispatched after the component completes the transition to that new state.

This event is only dispatched when there are one or more relevant listeners attached to the dispatching object.

The FlexEvent.STATE_CHANGE_COMPLETE constant defines the value of the type property of the event object for a stateChangeComplete event.

This event will only be dispatched when there are one or more relevant listeners attached to the dispatching object.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
stateChangeInterrupted Event  
Event Object Type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.STATE_CHANGE_INTERRUPTED

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

Dispatched when a component interrupts a transition to its current state in order to switch to a new state.

This event is only dispatched when there are one or more relevant listeners attached to the dispatching object.

The FlexEvent.STATE_CHANGE_INTERRUPTED constant defines the value of the type property of the event object for a stateChangeInterrupted event.

This event will only be dispatched when there are one or more relevant listeners attached to the dispatching object.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
toolTipCreate Event  
Event Object Type: mx.events.ToolTipEvent
ToolTipEvent.type property = mx.events.ToolTipEvent.TOOL_TIP_CREATE

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

Dispatched by the component when it is time to create a ToolTip.

If you create your own IToolTip object and place a reference to it in the toolTip property of the event object that is passed to your toolTipCreate handler, the ToolTipManager displays your custom ToolTip. Otherwise, the ToolTipManager creates an instance of ToolTipManager.toolTipClass to display.

The sequence of ToolTip events is toolTipStart, toolTipCreate, toolTipShow, toolTipShown, toolTipHide, and toolTipEnd.

The ToolTipEvent.TOOL_TIP_CREATE constant defines the value of the type property of the event object for a toolTipCreate event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
tooltipThe ToolTip object to which this event applies.
toolTipEnd Event  
Event Object Type: mx.events.ToolTipEvent
ToolTipEvent.type property = mx.events.ToolTipEvent.TOOL_TIP_END

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

Dispatched by the component when its ToolTip has been hidden and is to be discarded soon.

If you specify an effect using the ToolTipManager.hideEffect property, this event is dispatched after the effect stops playing.

The sequence of ToolTip events is toolTipStart, toolTipCreate, toolTipShow, toolTipShown, toolTipHide, and toolTipEnd.

The ToolTipEvent.TOOL_TIP_END constant defines the value of the type property of the event object for a toolTipEnd event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
tooltipThe ToolTip object to which this event applies.
toolTipHide Event  
Event Object Type: mx.events.ToolTipEvent
ToolTipEvent.type property = mx.events.ToolTipEvent.TOOL_TIP_HIDE

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

Dispatched by the component when its ToolTip is about to be hidden.

If you specify an effect using the ToolTipManager.hideEffect property, this event is dispatched before the effect starts playing.

The sequence of ToolTip events is toolTipStart, toolTipCreate, toolTipShow, toolTipShown, toolTipHide, and toolTipEnd.

The ToolTipEvent.TOOL_TIP_HIDE constant defines the value of the type property of the event object for a toolTipHide event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
tooltipThe ToolTip object to which this event applies.
toolTipShow Event  
Event Object Type: mx.events.ToolTipEvent
ToolTipEvent.type property = mx.events.ToolTipEvent.TOOL_TIP_SHOW

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

Dispatched by the component when its ToolTip is about to be shown.

If you specify an effect using the ToolTipManager.showEffect property, this event is dispatched before the effect starts playing. You can use this event to modify the ToolTip before it appears.

The sequence of ToolTip events is toolTipStart, toolTipCreate, toolTipShow, toolTipShown, toolTipHide, and toolTipEnd.

The ToolTipEvent.TOOL_TIP_SHOW constant defines the value of the type property of the event object for a toolTipShow event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
tooltipThe ToolTip object to which this event applies.
toolTipShown Event  
Event Object Type: mx.events.ToolTipEvent
ToolTipEvent.type property = mx.events.ToolTipEvent.TOOL_TIP_SHOWN

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

Dispatched by the component when its ToolTip has been shown.

If you specify an effect using the ToolTipManager.showEffect property, this event is dispatched after the effect stops playing.

The sequence of ToolTip events is toolTipStart, toolTipCreate, toolTipShow, toolTipShown, toolTipHide, and toolTipEnd.

The ToolTipEvent.TOOL_TIP_SHOWN constant defines the value of the type property of the event object for a toolTipShown event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
tooltipThe ToolTip object to which this event applies.
toolTipStart Event  
Event Object Type: mx.events.ToolTipEvent
ToolTipEvent.type property = mx.events.ToolTipEvent.TOOL_TIP_START

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

Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.

The sequence of ToolTip events is toolTipStart, toolTipCreate, toolTipShow, toolTipShown, toolTipHide, and toolTipEnd.

The ToolTipEvent.TOOL_TIP_START constant defines the value of the type property of the event object for a toolTipStart event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
tooltipThe ToolTip object to which this event applies.
touchInteractionEnd Event  
Event Object Type: mx.events.TouchInteractionEvent
TouchInteractionEvent.type property = mx.events.TouchInteractionEvent.TOUCH_INTERACTION_END

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture.

The event is a bubbling event dispatched on the DisplayObject that the touch interaction started (where the mouseDown/touchBegin occurred).

Components responding to touch interactions should listen for touch interaction events to coordinate with other components around what type of touch interaction the user intended to make and which component is responding to that touch interaction.

A Scroller component will dispatch a touchInteractionEnd event to alert other components that it is done responding to the user's touch interaction.

The TouchInteractionEvent.TOUCH_INTERACTION_END constant defines the value of the type property of the event object for a touchInteractionEnd event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
reasonThe reason for the touch interaction event. See mx.events.TouchInteractionReason.
relatedObjectThe object associated with this touch interaction event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
touchInteractionStart Event  
Event Object Type: mx.events.TouchInteractionEvent
TouchInteractionEvent.type property = mx.events.TouchInteractionEvent.TOUCH_INTERACTION_START

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture.

The event is a bubbling event dispatched on the DisplayObject that the touch interaction started (where the mouseDown/touchBegin occurred).

Components responding to touch interactions should listen for touch interaction events to coordinate with other components around what type of touch interaction the user intended to make and which component is responding to that touch interaction.

A Scroller component will dispatch a touchInteractionStart event to alert other components that may be responding to the same user's touch interaction that it is taking control of this touch interaction. When they see this event, other components should stop responding to the touch interaction, remove any visual indications that it is responding to the touch interaction, and perform other clean up.

The TouchInteractionEvent.TOUCH_INTERACTION_START constant defines the value of the type property of the event object for a touchInteractionStart event.

The properties of the event object have the following values:

PropertyValue
bubblestrue
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
reasonThe reason for the touch interaction event. See mx.events.TouchInteractionReason.
relatedObjectThe object associated with this touch interaction event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
touchInteractionStarting Event  
Event Object Type: mx.events.TouchInteractionEvent
TouchInteractionEvent.type property = mx.events.TouchInteractionEvent.TOUCH_INTERACTION_STARTING

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture.

The event is a bubbling event dispatched on the DisplayObject that the touch interaction started (where the mouseDown/touchBegin occurred).

Components responding to touch interactions should listen for touch interaction events to coordinate with other components around what type of touch interaction the user intended to make and which component is responding to that touch interaction.

A Scroller component will dispatch a touchInteractionStarting event to alert other components that may be responding to the same user's touch interaction that it would like to take control of this touch interaction. This is an opportunity for other components to cancel the Scroller's action and to maintain control over this touch interaction.

The TouchInteractionEvent.TOUCH_INTERACTION_STARTING constant defines the value of the type property of the event object for a touchInteractionStarting event.

The properties of the event object have the following values:

PropertyValue
bubblestrue
cancelabletrue
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
reasonThe reason for the touch interaction event. See mx.events.TouchInteractionReason.
relatedObjectThe object associated with this touch interaction event.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
updateComplete Event  
Event Object Type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.UPDATE_COMPLETE

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

Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).

This is the last opportunity to alter the component before it is displayed. All properties have been committed and the component has been measured and layed out.

This event is only dispatched when there are one or more relevant listeners attached to the dispatching object.

The FlexEvent.UPDATE_COMPLETE constant defines the value of the type property of the event object for a updateComplete event.

This event will only be dispatched when there are one or more relevant listeners attached to the dispatching object.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
valid Event  
Event Object Type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.VALID

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

Dispatched when a component is monitored by a Validator and the validation succeeded.

The FlexEvent.VALID constant defines the value of the type property of the event object for a valid event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
valueCommit Event  
Event Object Type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.VALUE_COMMIT

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

Dispatched when values are changed programmatically or by user interaction.

Because a programmatic change triggers this event, make sure that any valueCommit event handler does not change a value that causes another valueCommit event. For example, do not change a control's dataProvider property in a valueCommit event handler.

The FlexEvent.VALUE_COMMIT constant defines the value of the type property of the event object for a valueCommit event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
Constant Detail
DEFAULT_MAX_HEIGHTConstant
public static const DEFAULT_MAX_HEIGHT:Number = 10000

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

The default value for the maxHeight property.

The default value is 10000.

DEFAULT_MAX_WIDTHConstant 
public static const DEFAULT_MAX_WIDTH:Number = 10000

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

The default value for the maxWidth property.

The default value is 10000.

DEFAULT_MEASURED_HEIGHTConstant 
public static const DEFAULT_MEASURED_HEIGHT:Number = 22

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

The default value for the measuredHeight property. Most components calculate a measuredHeight but some are flow-based and have to pick a number that looks reasonable.

The default value is 22.

DEFAULT_MEASURED_MIN_HEIGHTConstant 
public static const DEFAULT_MEASURED_MIN_HEIGHT:Number = 22

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

The default value for the measuredMinHeight property. Most components calculate a measuredMinHeight but some are flow-based and have to pick a number that looks reasonable.

The default value is 22.

DEFAULT_MEASURED_MIN_WIDTHConstant 
public static const DEFAULT_MEASURED_MIN_WIDTH:Number = 40

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

The default value for the measuredMinWidth property. Most components calculate a measuredMinWidth but some are flow-based and have to pick a number that looks reasonable.

The default value is 40.

DEFAULT_MEASURED_WIDTHConstant 
public static const DEFAULT_MEASURED_WIDTH:Number = 160

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

The default value for the measuredWidth property. Most components calculate a measuredWidth but some are flow-based and have to pick a number that looks reasonable.

The default value is 160.