| Package | mx.core |
| Interface | public interface IUIComponent extends IFlexDisplayObject , IBitmapDrawable , IEventDispatcher |
| Implementors | PostScaleAdapter, UIComponent |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | IFlexDisplayObject | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | IFlexDisplayObject | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | IUIComponent | ||
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | IFlexDisplayObject | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | IFlexDisplayObject | |
| document : Object
A reference to the document object associated with this component. | IUIComponent | ||
| enabled : Boolean
Whether the component can accept user interaction. | IUIComponent | ||
| explicitHeight : Number
The explicitly specified height for the component,
in pixels, as the component's coordinates. | IUIComponent | ||
| explicitMaxHeight : Number [read-only]
Number that specifies the maximum height of the component,
in pixels, as the component's coordinates. | IUIComponent | ||
| explicitMaxWidth : Number [read-only]
Number that specifies the maximum width of the component,
in pixels, as the component's coordinates. | IUIComponent | ||
| explicitMinHeight : Number [read-only]
Number that specifies the minimum height of the component,
in pixels, as the component's coordinates. | IUIComponent | ||
| explicitMinWidth : Number [read-only]
Number that specifies the minimum width of the component,
in pixels, as the component's coordinates. | IUIComponent | ||
| explicitWidth : Number
The explicitly specified width for the component,
in pixels, as the component's coordinates. | IUIComponent | ||
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | IFlexDisplayObject | |
| focusPane : Sprite
A single Sprite object that is shared among components
and used as an overlay for drawing the focus indicator. | IUIComponent | ||
| height : Number
Indicates the height of the display object, in pixels. | IFlexDisplayObject | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | IUIComponent | ||
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | IUIComponent | ||
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | IFlexDisplayObject | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | IFlexDisplayObject | |
| maxHeight : Number [read-only]
Number that specifies the maximum height of the component,
in pixels, as the component's coordinates. | IUIComponent | ||
| maxWidth : Number [read-only]
Number that specifies the maximum width of the component,
in pixels, as the component's coordinates. | IUIComponent | ||
| measuredHeight : Number [read-only]
The measured height of this object. | IFlexDisplayObject | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | IUIComponent | ||
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | IUIComponent | ||
| measuredWidth : Number [read-only]
The measured width of this object. | IFlexDisplayObject | |
| minHeight : Number [read-only]
Number that specifies the minimum height of the component,
in pixels, as the component's coordinates. | IUIComponent | ||
| minWidth : Number [read-only]
Number that specifies the minimum width of the component,
in pixels, as the component's coordinates. | IUIComponent | ||
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | IFlexDisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | IFlexDisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | IFlexDisplayObject | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | IFlexDisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | IUIComponent | ||
| parent : DisplayObjectContainer [read-only]
Indicates the DisplayObjectContainer object that contains this display object. | IFlexDisplayObject | |
| percentHeight : Number
Number that specifies the height of a component as a
percentage of its parent's size. | IUIComponent | ||
| percentWidth : Number
Number that specifies the width of a component as a
percentage of its parent's size. | IUIComponent | ||
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | IFlexDisplayObject | |
| rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | IFlexDisplayObject | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | IFlexDisplayObject | |
| scaleX : Number
Indicates the horizontal scale (percentage) of the object as applied from the registration point. | IFlexDisplayObject | |
| scaleY : Number
Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. | IFlexDisplayObject | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | IFlexDisplayObject | |
| stage : Stage [read-only]
The Stage of the display object. | IFlexDisplayObject | |
| systemManager : ISystemManager
A reference to the SystemManager object for this component. | IUIComponent | ||
| transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | IFlexDisplayObject | |
| tweeningProperties : Array
Used by EffectManager. | IUIComponent | ||
| visible : Boolean
Whether or not the display object is visible. | IFlexDisplayObject | |
| width : Number
Indicates the width of the display object, in pixels. | IFlexDisplayObject | |
| x : Number
Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | IFlexDisplayObject | |
| y : Number
Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer. | IFlexDisplayObject | |
| Method | Defined By | ||
|---|---|---|---|
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | IEventDispatcher | |
|
Dispatches an event into the event flow. | IEventDispatcher | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | IFlexDisplayObject | |
A convenience method for determining whether to use the
explicit or measured height
| IUIComponent | ||
A convenience method for determining whether to use the
explicit or measured width
| IUIComponent | ||
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | IFlexDisplayObject | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | IFlexDisplayObject | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | IFlexDisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | IFlexDisplayObject | |
Initialize the object. | IUIComponent | ||
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | IFlexDisplayObject | |
|
Moves this object to the specified x and y coordinates. | IFlexDisplayObject | |
Returns true if the chain of owner properties
points from child to this UIComponent. | IUIComponent | ||
Called by Flex when a UIComponent object is added to or removed from a parent. | IUIComponent | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
|
Sets the actual size of this object. | IFlexDisplayObject | |
Called when the visible property changes. | IUIComponent | ||
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
baselinePosition | property |
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():Numberdocument | property |
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 component. A document object is an Object at the top of the hierarchy of a Flex application, MXML component, or ActionScript component.
Implementation
public function get document():Object public function set document(value:Object):voidenabled | property |
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.
Implementation
public function get enabled():Boolean public function set enabled(value:Boolean):voidexplicitHeight | property |
explicitHeight:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The explicitly specified height for the component,
in pixels, as the component's coordinates.
If no height is explicitly specified, the value is NaN.
Implementation
public function get explicitHeight():Number public function set explicitHeight(value:Number):voidRelated API Elements
explicitMaxHeight | property |
explicitMaxHeight:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
Implementation
public function get explicitMaxHeight():NumberRelated API Elements
explicitMaxWidth | property |
explicitMaxWidth:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
Implementation
public function get explicitMaxWidth():NumberRelated API Elements
explicitMinHeight | property |
explicitMinHeight:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
Implementation
public function get explicitMinHeight():NumberRelated API Elements
explicitMinWidth | property |
explicitMinWidth:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
Implementation
public function get explicitMinWidth():NumberRelated API Elements
explicitWidth | property |
explicitWidth:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The explicitly specified width for the component,
in pixels, as the component's coordinates.
If no width is explicitly specified, the value is NaN.
Implementation
public function get explicitWidth():Number public function set explicitWidth(value:Number):voidRelated API Elements
focusPane | property |
focusPane:Sprite| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A single Sprite object that is shared among components and used as an overlay for drawing the focus indicator. Components share this object if their parent is a focused component, not if the component implements the IFocusManagerComponent interface.
Implementation
public function get focusPane():Sprite public function set focusPane(value:Sprite):voidRelated API Elements
includeInLayout | property |
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.
Implementation
public function get includeInLayout():Boolean public function set includeInLayout(value:Boolean):voidisPopUp | property |
maxHeight | property |
maxHeight:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
Implementation
public function get maxHeight():NumberRelated API Elements
maxWidth | property |
maxWidth:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
Implementation
public function get maxWidth():NumberRelated API Elements
measuredMinHeight | property |
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):voidmeasuredMinWidth | property |
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):voidminHeight | property |
minHeight:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
Implementation
public function get minHeight():NumberRelated API Elements
minWidth | property |
minWidth:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
Implementation
public function get minWidth():NumberRelated API Elements
owner | property |
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):voidpercentHeight | property |
percentHeight:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the height of a component as a percentage of its parent's size. Allowed values are 0 to 100.
Implementation
public function get percentHeight():Number public function set percentHeight(value:Number):voidpercentWidth | property |
percentWidth:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the width of a component as a percentage of its parent's size. Allowed values are 0 to 100.
Implementation
public function get percentWidth():Number public function set percentWidth(value:Number):voidsystemManager | property |
systemManager:ISystemManager| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A reference to the SystemManager object for this component.
Implementation
public function get systemManager():ISystemManager public function set systemManager(value:ISystemManager):voidtweeningProperties | property |
tweeningProperties:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Used by EffectManager. Returns non-null if a component is not using the EffectManager to execute a Tween.
Implementation
public function get tweeningProperties():Array public function set tweeningProperties(value:Array):voidgetExplicitOrMeasuredHeight | () | 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
ReturnsNumber — 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
ReturnsNumber — A Number which is explicitWidth if defined
or measuredWidth if not.
|
initialize | () | method |
public function initialize():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Initialize the object.
Related API Elements
owns | () | method |
public function owns(displayObject: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
displayObject:DisplayObject — A UIComponent.
|
Boolean — true 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.
|
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)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.
|
Mon Nov 28 2011, 06:48 AM -08:00