Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The IUIComponent interface defines the basic set of APIs
that you must implement to create a child of a Flex container or list.
baselinePosition:Number
[read-only]
Language Version : | ActionScript 3.0 |
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
document:Object
Language Version : | ActionScript 3.0 |
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):void
enabled:Boolean
Language Version : | ActionScript 3.0 |
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):void
explicitHeight:Number
Language Version : | ActionScript 3.0 |
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):void
See also
explicitMaxHeight:Number
[read-only]
Language Version : | ActionScript 3.0 |
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():Number
See also
explicitMaxWidth:Number
[read-only]
Language Version : | ActionScript 3.0 |
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():Number
See also
explicitMinHeight:Number
[read-only]
Language Version : | ActionScript 3.0 |
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():Number
See also
explicitMinWidth:Number
[read-only]
Language Version : | ActionScript 3.0 |
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():Number
See also
explicitWidth:Number
Language Version : | ActionScript 3.0 |
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):void
See also
focusPane:Sprite
Language Version : | ActionScript 3.0 |
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):void
See also
includeInLayout:Boolean
Language Version : | ActionScript 3.0 |
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):void
isPopUp:Boolean
Language Version : | ActionScript 3.0 |
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
maxHeight:Number
[read-only]
Language Version : | ActionScript 3.0 |
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():Number
See also
maxWidth:Number
[read-only]
Language Version : | ActionScript 3.0 |
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():Number
See also
measuredMinHeight:Number
Language Version : | ActionScript 3.0 |
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
measuredMinWidth:Number
Language Version : | ActionScript 3.0 |
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
minHeight:Number
[read-only]
Language Version : | ActionScript 3.0 |
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():Number
See also
minWidth:Number
[read-only]
Language Version : | ActionScript 3.0 |
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():Number
See also
owner:DisplayObjectContainer
Language Version : | ActionScript 3.0 |
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
percentHeight:Number
Language Version : | ActionScript 3.0 |
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):void
percentWidth:Number
Language Version : | ActionScript 3.0 |
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):void
systemManager:ISystemManager
Language Version : | ActionScript 3.0 |
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):void
tweeningProperties:Array
Language Version : | ActionScript 3.0 |
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):void
public function getExplicitOrMeasuredHeight():Number
Language Version : | ActionScript 3.0 |
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.
|
public function getExplicitOrMeasuredWidth():Number
Language Version : | ActionScript 3.0 |
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.
|
public function initialize():void
Language Version : | ActionScript 3.0 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Initialize the object.
See also
public function owns(displayObject:DisplayObject):Boolean
Language Version : | ActionScript 3.0 |
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.
|
Returns | Boolean — true if the child is parented or owned by this UIComponent.
|
public function parentChanged(p:DisplayObjectContainer):void
Language Version : | ActionScript 3.0 |
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.
|
public function setVisible(value:Boolean, noEvent:Boolean = false):void
Language Version : | ActionScript 3.0 |
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.
|
Mon Jul 9 2012, 07:18 PM -04:00