| Package | mx.core |
| Interface | public interface IContainer extends IUIComponent, IFlexDisplayObject, flash.display.IBitmapDrawable, flash.events.IEventDispatcher |
| Implementors | Container, Legend |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
See also
| 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 | |
| buttonMode : Boolean | IContainer | ||
| cacheAsBitmap : Boolean | IFlexDisplayObject | |
| creatingContentPane : Boolean
Containers use an internal content pane to control scrolling. | IContainer | ||
| defaultButton : IFlexDisplayObject
The Button control designated as the default button
for the container. | IContainer | ||
| document : Object
A reference to the document object associated with this component. | IUIComponent | |
| doubleClickEnabled : Boolean | IContainer | ||
| dropTarget : DisplayObject [read-only] | IContainer | ||
| 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 | |
| focusManager : IFocusManager [read-only]
Gets the FocusManager that controls focus for this component
and its peers. | IContainer | ||
| focusPane : Sprite
A single Sprite object that is shared among components
and used as an overlay for drawing the focus indicator. | IUIComponent | |
| focusRect : Object | IContainer | ||
| graphics : Graphics [read-only] | IContainer | ||
| height : Number | IFlexDisplayObject | |
| hitArea : Sprite | IContainer | ||
| horizontalScrollPosition : Number
The current position of the horizontal scroll bar. | IContainer | ||
| 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] | 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 [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 | |
| mouseChildren : Boolean | IContainer | ||
| mouseEnabled : Boolean | IContainer | ||
| mouseX : Number [read-only] | IFlexDisplayObject | |
| mouseY : Number [read-only] | IFlexDisplayObject | |
| name : String | IFlexDisplayObject | |
| numChildren : int [read-only] | IContainer | ||
| opaqueBackground : Object | IFlexDisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | IUIComponent | |
| parent : DisplayObjectContainer [read-only] | 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] | IFlexDisplayObject | |
| rotation : Number | IFlexDisplayObject | |
| scale9Grid : Rectangle | IFlexDisplayObject | |
| scaleX : Number | IFlexDisplayObject | |
| scaleY : Number | IFlexDisplayObject | |
| scrollRect : Rectangle | IFlexDisplayObject | |
| soundTransform : SoundTransform | IContainer | ||
| stage : Stage [read-only] | IFlexDisplayObject | |
| systemManager : ISystemManager
A reference to the SystemManager object for this component. | IUIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | IContainer | ||
| tabEnabled : Boolean | IContainer | ||
| tabIndex : int | IContainer | ||
| textSnapshot : TextSnapshot [read-only] | IContainer | ||
| transform : Transform | IFlexDisplayObject | |
| tweeningProperties : Array
Used by EffectManager. | IUIComponent | |
| useHandCursor : Boolean | IContainer | ||
| verticalScrollPosition : Number
The current position of the vertical scroll bar. | IContainer | ||
| viewMetrics : EdgeMetrics [read-only]
Returns an object that has four properties: left,
top, right, and bottom. | IContainer | ||
| visible : Boolean | IFlexDisplayObject | |
| width : Number | IFlexDisplayObject | |
| x : Number | IFlexDisplayObject | |
| y : Number | IFlexDisplayObject | |
| Method | Defined By | ||
|---|---|---|---|
addChild(child:DisplayObject):DisplayObject | IContainer | ||
addChildAt(child:DisplayObject, index:int):DisplayObject | IContainer | ||
areInaccessibleObjectsUnderPoint(point:Point):Boolean | IContainer | ||
contains(child:DisplayObject):Boolean | IContainer | ||
| getBounds(targetCoordinateSpace:DisplayObject):Rectangle | IFlexDisplayObject | |
getChildAt(index:int):DisplayObject | IContainer | ||
getChildByName(name:String):DisplayObject | IContainer | ||
getChildIndex(child:DisplayObject):int | IContainer | ||
| 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 | |
getObjectsUnderPoint(point:Point):Array | IContainer | ||
| 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(displayObject: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 | |
removeChild(child:DisplayObject):DisplayObject | IContainer | ||
removeChildAt(index:int):DisplayObject | IContainer | ||
| setActualSize(newWidth:Number, newHeight:Number):void
Sets the actual size of this object. | IFlexDisplayObject | |
setChildIndex(child:DisplayObject, index:int):void | IContainer | ||
| setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes. | IUIComponent | |
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void | IContainer | ||
stopDrag():void | IContainer | ||
swapChildren(child1:DisplayObject, child2:DisplayObject):void | IContainer | ||
swapChildrenAt(index1:int, index2:int):void | IContainer | ||
| buttonMode | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesbuttonMode:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
public function get buttonMode():Boolean public function set buttonMode(value:Boolean):void| creatingContentPane | property |
creatingContentPane:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Containers use an internal content pane to control scrolling.
The creatingContentPane is true while the container is creating
the content pane so that some events can be ignored or blocked.
public function get creatingContentPane():Boolean public function set creatingContentPane(value:Boolean):void| defaultButton | property |
defaultButton:IFlexDisplayObject| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
The Button control designated as the default button for the container. When controls in the container have focus, pressing the Enter key is the same as clicking this Button control.
public function get defaultButton():IFlexDisplayObject public function set defaultButton(value:IFlexDisplayObject):void| doubleClickEnabled | property |
doubleClickEnabled:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
public function get doubleClickEnabled():Boolean public function set doubleClickEnabled(value:Boolean):void| dropTarget | property |
dropTarget:DisplayObject [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
public function get dropTarget():DisplayObject| focusManager | property |
focusManager:IFocusManager [read-only] | 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.
public function get focusManager():IFocusManager| focusRect | property |
focusRect:Object| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
public function get focusRect():Object public function set focusRect(value:Object):void| graphics | property |
graphics:Graphics [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
public function get graphics():Graphics| hitArea | property |
hitArea:Sprite| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
public function get hitArea():Sprite public function set hitArea(value:Sprite):void| horizontalScrollPosition | property |
horizontalScrollPosition:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
The current position of the horizontal scroll bar. This is equal to the distance in pixels between the left edge of the scrollable surface and the leftmost piece of the surface that is currently visible.
public function get horizontalScrollPosition():Number public function set horizontalScrollPosition(value:Number):void| mouseChildren | property |
mouseChildren:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
public function get mouseChildren():Boolean public function set mouseChildren(value:Boolean):void| mouseEnabled | property |
mouseEnabled:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
public function get mouseEnabled():Boolean public function set mouseEnabled(value:Boolean):void| numChildren | property |
numChildren:int [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
public function get numChildren():int| soundTransform | property |
soundTransform:SoundTransform| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
public function get soundTransform():SoundTransform public function set soundTransform(value:SoundTransform):void| tabChildren | property |
tabChildren:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Determines whether the children of the object are tab enabled.
Note: Do not use this property with Flex.
Instead, use the UIComponent.hasFocusableChildren property.
public function get tabChildren():Boolean public function set tabChildren(value:Boolean):voidSee also
| tabEnabled | property |
tabEnabled:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
public function get tabEnabled():Boolean public function set tabEnabled(value:Boolean):void| tabIndex | property |
tabIndex:int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
public function get tabIndex():int public function set tabIndex(value:int):void| textSnapshot | property |
textSnapshot:TextSnapshot [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
public function get textSnapshot():TextSnapshot| useHandCursor | property |
useHandCursor:Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
public function get useHandCursor():Boolean public function set useHandCursor(value:Boolean):void| verticalScrollPosition | property |
verticalScrollPosition:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
The current position of the vertical scroll bar. This is equal to the distance in pixels between the top edge of the scrollable surface and the topmost piece of the surface that is currently visible.
public function get verticalScrollPosition():Number public function set verticalScrollPosition(value:Number):void| viewMetrics | property |
viewMetrics:EdgeMetrics [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Returns an object that has four properties: left,
top, right, and bottom.
The value of each property equals the thickness of the chrome
(visual elements) around the edge of the container.
The chrome includes the border thickness.
If the horizontalScrollPolicy or verticalScrollPolicy
property value is ScrollPolicy.ON, the
chrome also includes the thickness of the corresponding
scroll bar. If a scroll policy is ScrollPolicy.AUTO,
the chrome measurement does not include the scroll bar thickness,
even if a scroll bar is displayed.
Subclasses of Container should override this method, so that
they include other chrome to be taken into account when positioning
the Container's children.
For example, the viewMetrics property for the
Panel class should return an object whose top property
includes the thickness of the Panel container's title bar.
public function get viewMetrics():EdgeMetrics| addChild | () | method |
public function addChild(child:DisplayObject):DisplayObject| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Parameters
child:DisplayObject |
DisplayObject |
| addChildAt | () | method |
public function addChildAt(child:DisplayObject, index:int):DisplayObject| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Parameters
child:DisplayObject | |
index:int |
DisplayObject |
| areInaccessibleObjectsUnderPoint | () | method |
public function areInaccessibleObjectsUnderPoint(point:Point):Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Parameters
point:Point |
Boolean |
| contains | () | method |
public function contains(child:DisplayObject):Boolean| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Parameters
child:DisplayObject |
Boolean |
| getChildAt | () | method |
public function getChildAt(index:int):DisplayObject| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Parameters
index:int |
DisplayObject |
| getChildByName | () | method |
public function getChildByName(name:String):DisplayObject| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Parameters
name:String |
DisplayObject |
| getChildIndex | () | method |
public function getChildIndex(child:DisplayObject):int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Parameters
child:DisplayObject |
int |
| getObjectsUnderPoint | () | method |
public function getObjectsUnderPoint(point:Point):Array| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Parameters
point:Point |
Array |
| removeChild | () | method |
public function removeChild(child:DisplayObject):DisplayObject| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Parameters
child:DisplayObject |
DisplayObject |
| removeChildAt | () | method |
public function removeChildAt(index:int):DisplayObject| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Parameters
index:int |
DisplayObject |
| setChildIndex | () | method |
public function setChildIndex(child:DisplayObject, index:int):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Parameters
child:DisplayObject | |
index:int |
| startDrag | () | method |
public function startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Parameters
lockCenter:Boolean (default = false) | |
bounds:Rectangle (default = null) |
| stopDrag | () | method |
public function stopDrag():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
| swapChildren | () | method |
public function swapChildren(child1:DisplayObject, child2:DisplayObject):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Parameters
child1:DisplayObject | |
child2:DisplayObject |
| swapChildrenAt | () | method |
public function swapChildrenAt(index1:int, index2:int):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | Flash Player 9, AIR 1.1 |
Parameters
index1:int | |
index2:int |