Package | mx.core |
Interface | public interface IUIComponent extends IFlexDisplayObject, flash.display.IBitmapDrawable, flash.events.IEventDispatcher |
Subinterfaces | IButton, IContainer, IDeferredInstantiationUIComponent, IListItemRenderer, IToolTip, IUITextField |
Implementors | UIComponent |
Property | Defined by | ||
---|---|---|---|
accessibilityProperties : AccessibilityProperties | IFlexDisplayObject | ||
alpha : Number | IFlexDisplayObject | ||
baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component.
| IUIComponent | ||
blendMode : String | IFlexDisplayObject | ||
cacheAsBitmap : Boolean | 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 | IFlexDisplayObject | ||
focusPane : Sprite
A single Sprite object that is shared among components
and used as an overlay for drawing focus.
| IUIComponent | ||
height : Number | 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 | IFlexDisplayObject | ||
mask : DisplayObject | 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
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
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 | IFlexDisplayObject | ||
mouseY : Number | IFlexDisplayObject | ||
name : String | IFlexDisplayObject | ||
opaqueBackground : Object | IFlexDisplayObject | ||
owner : DisplayObjectContainer
Typically the parent container of this component.
| IUIComponent | ||
parent : DisplayObjectContainer | 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
The methods here would normally just be in IDisplayObject,
but for backward compatibility, they have to be included
directly into IFlexDisplayObject, so they are kept in
this separate include file.
| IFlexDisplayObject | ||
rotation : Number | IFlexDisplayObject | ||
scale9Grid : Rectangle | IFlexDisplayObject | ||
scaleX : Number | IFlexDisplayObject | ||
scaleY : Number | IFlexDisplayObject | ||
scrollRect : Rectangle | IFlexDisplayObject | ||
stage : Stage | IFlexDisplayObject | ||
systemManager : ISystemManager
A reference to the SystemManager object for this component.
| IUIComponent | ||
transform : Transform | IFlexDisplayObject | ||
tweeningProperties : Array
Used by EffectManager.
| IUIComponent | ||
visible : Boolean | IFlexDisplayObject | ||
width : Number | IFlexDisplayObject | ||
x : Number | IFlexDisplayObject | ||
y : Number | IFlexDisplayObject |
Method | Defined by | ||
---|---|---|---|
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
| IFlexDisplayObject | ||
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| IUIComponent | ||
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| IUIComponent | ||
getRect(targetCoordinateSpace:DisplayObject):Rectangle
| IFlexDisplayObject | ||
globalToLocal(point:Point):Point
| IFlexDisplayObject | ||
hitTestObject(obj:DisplayObject):Boolean
| IFlexDisplayObject | ||
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
| IFlexDisplayObject | ||
initialize():void
Initialize the object.
| IUIComponent | ||
localToGlobal(point:Point):Point
| IFlexDisplayObject | ||
move(x:Number, y:Number):void
Moves this object to the specified x and y coordinates.
| IFlexDisplayObject | ||
owns(child:DisplayObject):Boolean
Returns
true if the chain of owner properties
points from child to this UIComponent. | IUIComponent | ||
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
| IUIComponent | ||
setActualSize(newWidth:Number, newHeight:Number):void
Sets the actual size of this object.
| IFlexDisplayObject | ||
Called when the
visible property changes. | IUIComponent |
baselinePosition | property |
baselinePosition:Number
[read-only]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.
public function get baselinePosition():Number
document | property |
document:Object
[read-write]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):void
enabled | property |
enabled:Boolean
[read-write]
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.
public function get enabled():Boolean
public function set enabled(value:Boolean):void
explicitHeight | property |
explicitHeight:Number
[read-write]
The explicitly specified height for the component,
in pixels, as the component's coordinates.
If no height is explicitly specified, the value is NaN
.
public function get explicitHeight():Number
public function set explicitHeight(value:Number):void
See also
explicitMaxHeight | property |
explicitMaxHeight:Number
[read-only]Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
Implementation public function get explicitMaxHeight():Number
See also
explicitMaxWidth | property |
explicitMaxWidth:Number
[read-only]Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
Implementation public function get explicitMaxWidth():Number
See also
explicitMinHeight | property |
explicitMinHeight:Number
[read-only]Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
Implementation public function get explicitMinHeight():Number
See also
explicitMinWidth | property |
explicitMinWidth:Number
[read-only]Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
Implementation public function get explicitMinWidth():Number
See also
explicitWidth | property |
explicitWidth:Number
[read-write]
The explicitly specified width for the component,
in pixels, as the component's coordinates.
If no width is explicitly specified, the value is NaN
.
public function get explicitWidth():Number
public function set explicitWidth(value:Number):void
See also
focusPane | property |
focusPane:Sprite
[read-write]A single Sprite object that is shared among components and used as an overlay for drawing focus. Components share this object if their parent is a focused component, not if the component implements the IFocusManagerComponent interface.
Implementation public function get focusPane():Sprite
public function set focusPane(value:Sprite):void
See also
includeInLayout | property |
includeInLayout:Boolean
[read-write]
Specifies whether this component is included in the layout of the
parent container.
If true
, the object is included in its parent container's
layout. If false
, the object is positioned by its parent
container as per its layout rules, but it is ignored for the purpose of
computing the position of the next child.
public function get includeInLayout():Boolean
public function set includeInLayout(value:Boolean):void
isPopUp | property |
isPopUp:Boolean
[read-write]
Set to true
by the PopUpManager to indicate
that component has been popped up.
public function get isPopUp():Boolean
public function set isPopUp(value:Boolean):void
maxHeight | property |
maxHeight:Number
[read-only]Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
Implementation public function get maxHeight():Number
See also
maxWidth | property |
maxWidth:Number
[read-only]Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
Implementation public function get maxWidth():Number
See also
measuredMinHeight | property |
measuredMinHeight:Number
[read-write]
The default minimum height of the component, in pixels.
This value is set by the measure()
method.
public function get measuredMinHeight():Number
public function set measuredMinHeight(value:Number):void
measuredMinWidth | property |
measuredMinWidth:Number
[read-write]
The default minimum width of the component, in pixels.
This value is set by the measure()
method.
public function get measuredMinWidth():Number
public function set measuredMinWidth(value:Number):void
minHeight | property |
minHeight:Number
[read-only]Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
Implementation public function get minHeight():Number
See also
minWidth | property |
minWidth:Number
[read-only]Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
Implementation public function get minWidth():Number
See also
owner | property |
owner:DisplayObjectContainer
[read-write]Typically the parent container of this component. However, if this is a popup component, the owner is the component that popped it up. For example, the owner of a dropdown list of a ComboBox control is the ComboBox control itself. This property is not managed by Flex, but by each component. Therefore, if you popup a component, you should set this property accordingly.
Implementation public function get owner():DisplayObjectContainer
public function set owner(value:DisplayObjectContainer):void
percentHeight | property |
percentHeight:Number
[read-write]Number that specifies the height of a component as a percentage of its parent's size. Allowed values are 0 to 100.
Implementation public function get percentHeight():Number
public function set percentHeight(value:Number):void
percentWidth | property |
percentWidth:Number
[read-write]Number that specifies the width of a component as a percentage of its parent's size. Allowed values are 0 to 100.
Implementation public function get percentWidth():Number
public function set percentWidth(value:Number):void
systemManager | property |
systemManager:ISystemManager
[read-write]A reference to the SystemManager object for this component.
Implementation public function get systemManager():ISystemManager
public function set systemManager(value:ISystemManager):void
tweeningProperties | property |
tweeningProperties:Array
[read-write]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):void
getExplicitOrMeasuredHeight | () | method |
public function getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the explicit or measured height
ReturnsNumber — A Number which is explicitHeight if defined
or measuredHeight if not.
|
getExplicitOrMeasuredWidth | () | method |
public function getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the explicit or measured width
ReturnsNumber — A Number which is explicitWidth if defined
or measuredWidth if not.
|
initialize | () | method |
owns | () | method |
public function owns(child:DisplayObject):Boolean
Returns true
if the chain of owner
properties
points from child
to this UIComponent.
child:DisplayObject — A UIComponent.
|
Boolean — true if the child is parented or owned by this UIComponent.
|
parentChanged | () | method |
public function parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent. Developers typically never need to call this method.
Parametersp:DisplayObjectContainer — The parent of this UIComponent object.
|
setVisible | () | method |
public function setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible
property changes.
You should set the visible
property to show or hide
a component instead of calling this method directly.
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.
|