Packagemx.core
Interfacepublic 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

IContainer is a interface that indicates a component extends or mimics mx.core.Container

See also

mx.core.Container


Public Properties
 PropertyDefined By
 InheritedaccessibilityProperties : AccessibilityProperties
IFlexDisplayObject
 Inheritedalpha : Number
IFlexDisplayObject
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
IUIComponent
 InheritedblendMode : String
IFlexDisplayObject
  buttonMode : Boolean
IContainer
 InheritedcacheAsBitmap : 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
 Inheriteddocument : Object
A reference to the document object associated with this component.
IUIComponent
  doubleClickEnabled : Boolean
IContainer
  dropTarget : DisplayObject
[read-only]
IContainer
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
IUIComponent
 InheritedexplicitHeight : Number
The explicitly specified height for the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMaxHeight : Number
[read-only] Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMaxWidth : Number
[read-only] Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMinHeight : Number
[read-only] Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMinWidth : Number
[read-only] Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitWidth : Number
The explicitly specified width for the component, in pixels, as the component's coordinates.
IUIComponent
 Inheritedfilters : Array
IFlexDisplayObject
  focusManager : IFocusManager
[read-only] Gets the FocusManager that controls focus for this component and its peers.
IContainer
 InheritedfocusPane : 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
 Inheritedheight : Number
IFlexDisplayObject
  hitArea : Sprite
IContainer
  horizontalScrollPosition : Number
The current position of the horizontal scroll bar.
IContainer
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
IUIComponent
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
IUIComponent
 InheritedloaderInfo : LoaderInfo
[read-only]
IFlexDisplayObject
 Inheritedmask : DisplayObject
IFlexDisplayObject
 InheritedmaxHeight : Number
[read-only] Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedmaxWidth : Number
[read-only] Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedmeasuredHeight : Number
[read-only] The measured height of this object.
IFlexDisplayObject
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
IUIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
IUIComponent
 InheritedmeasuredWidth : Number
[read-only] The measured width of this object.
IFlexDisplayObject
 InheritedminHeight : Number
[read-only] Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedminWidth : 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
 InheritedmouseX : Number
[read-only]
IFlexDisplayObject
 InheritedmouseY : Number
[read-only]
IFlexDisplayObject
 Inheritedname : String
IFlexDisplayObject
  numChildren : int
[read-only]
IContainer
 InheritedopaqueBackground : Object
IFlexDisplayObject
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
IUIComponent
 Inheritedparent : DisplayObjectContainer
[read-only]
IFlexDisplayObject
 InheritedpercentHeight : Number
Number that specifies the height of a component as a percentage of its parent's size.
IUIComponent
 InheritedpercentWidth : Number
Number that specifies the width of a component as a percentage of its parent's size.
IUIComponent
 Inheritedroot : DisplayObject
[read-only]
IFlexDisplayObject
 Inheritedrotation : Number
IFlexDisplayObject
 Inheritedscale9Grid : Rectangle
IFlexDisplayObject
 InheritedscaleX : Number
IFlexDisplayObject
 InheritedscaleY : Number
IFlexDisplayObject
 InheritedscrollRect : Rectangle
IFlexDisplayObject
  soundTransform : SoundTransform
IContainer
 Inheritedstage : Stage
[read-only]
IFlexDisplayObject
 InheritedsystemManager : 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
 Inheritedtransform : Transform
IFlexDisplayObject
 InheritedtweeningProperties : 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
 Inheritedvisible : Boolean
IFlexDisplayObject
 Inheritedwidth : Number
IFlexDisplayObject
 Inheritedx : Number
IFlexDisplayObject
 Inheritedy : Number
IFlexDisplayObject
Public Methods
 MethodDefined By
  
addChild(child:DisplayObject):DisplayObject
IContainer
  
addChildAt(child:DisplayObject, index:int):DisplayObject
IContainer
  
IContainer
  
contains(child:DisplayObject):Boolean
IContainer
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
IFlexDisplayObject
  
getChildAt(index:int):DisplayObject
IContainer
  
getChildByName(name:String):DisplayObject
IContainer
  
getChildIndex(child:DisplayObject):int
IContainer
 Inherited
A convenience method for determining whether to use the explicit or measured height
IUIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
IUIComponent
  
getObjectsUnderPoint(point:Point):Array
IContainer
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
IFlexDisplayObject
 Inherited
globalToLocal(point:Point):Point
IFlexDisplayObject
 Inherited
hitTestObject(obj:DisplayObject):Boolean
IFlexDisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
IFlexDisplayObject
 Inherited
initialize():void
Initialize the object.
IUIComponent
 Inherited
localToGlobal(point:Point):Point
IFlexDisplayObject
 Inherited
move(x:Number, y:Number):void
Moves this object to the specified x and y coordinates.
IFlexDisplayObject
 Inherited
owns(displayObject:DisplayObject):Boolean
Returns true if the chain of owner properties points from child to this UIComponent.
IUIComponent
 Inherited
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
 Inherited
setActualSize(newWidth:Number, newHeight:Number):void
Sets the actual size of this object.
IFlexDisplayObject
  
setChildIndex(child:DisplayObject, index:int):void
IContainer
 Inherited
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
Property Detail
buttonModeproperty
buttonMode:Boolean

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


Implementation
    public function get buttonMode():Boolean
    public function set buttonMode(value:Boolean):void
creatingContentPaneproperty 
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.


Implementation
    public function get creatingContentPane():Boolean
    public function set creatingContentPane(value:Boolean):void
defaultButtonproperty 
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.


Implementation
    public function get defaultButton():IFlexDisplayObject
    public function set defaultButton(value:IFlexDisplayObject):void
doubleClickEnabledproperty 
doubleClickEnabled:Boolean

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


Implementation
    public function get doubleClickEnabled():Boolean
    public function set doubleClickEnabled(value:Boolean):void
dropTargetproperty 
dropTarget:DisplayObject  [read-only]

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


Implementation
    public function get dropTarget():DisplayObject
focusManagerproperty 
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.


Implementation
    public function get focusManager():IFocusManager
focusRectproperty 
focusRect:Object

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


Implementation
    public function get focusRect():Object
    public function set focusRect(value:Object):void
graphicsproperty 
graphics:Graphics  [read-only]

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


Implementation
    public function get graphics():Graphics
hitAreaproperty 
hitArea:Sprite

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


Implementation
    public function get hitArea():Sprite
    public function set hitArea(value:Sprite):void
horizontalScrollPositionproperty 
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.


Implementation
    public function get horizontalScrollPosition():Number
    public function set horizontalScrollPosition(value:Number):void
mouseChildrenproperty 
mouseChildren:Boolean

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


Implementation
    public function get mouseChildren():Boolean
    public function set mouseChildren(value:Boolean):void
mouseEnabledproperty 
mouseEnabled:Boolean

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


Implementation
    public function get mouseEnabled():Boolean
    public function set mouseEnabled(value:Boolean):void
numChildrenproperty 
numChildren:int  [read-only]

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


Implementation
    public function get numChildren():int
soundTransformproperty 
soundTransform:SoundTransform

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


Implementation
    public function get soundTransform():SoundTransform
    public function set soundTransform(value:SoundTransform):void
tabChildrenproperty 
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.


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

See also

tabEnabledproperty 
tabEnabled:Boolean

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


Implementation
    public function get tabEnabled():Boolean
    public function set tabEnabled(value:Boolean):void
tabIndexproperty 
tabIndex:int

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


Implementation
    public function get tabIndex():int
    public function set tabIndex(value:int):void
textSnapshotproperty 
textSnapshot:TextSnapshot  [read-only]

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


Implementation
    public function get textSnapshot():TextSnapshot
useHandCursorproperty 
useHandCursor:Boolean

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


Implementation
    public function get useHandCursor():Boolean
    public function set useHandCursor(value:Boolean):void
verticalScrollPositionproperty 
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.


Implementation
    public function get verticalScrollPosition():Number
    public function set verticalScrollPosition(value:Number):void
viewMetricsproperty 
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.


Implementation
    public function get viewMetrics():EdgeMetrics
Method Detail
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

Returns
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

Returns
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

Returns
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

Returns
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

Returns
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

Returns
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

Returns
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

Returns
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

Returns
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

Returns
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