Packageorg.apache.flex.core
Classpublic class ContainerBase
InheritanceContainerBase Inheritance UIBase Inheritance HTMLElementWrapper Inheritance flash.display.Sprite
Implements IMXMLDocument, IStatesObject, IContainer, IContentViewHost
Subclasses Container, DOMWrapper, GraphicContainer, ViewBase

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

The ContainerBase class is the base class for most containers in FlexJS. It is usable as the root tag of MXML documents and UI controls and containers are added to it.

Default MXML PropertymxmlContent



Public Properties
 PropertyDefined By
 Inherited$height : Number
[read-only] Retrieve the low-level bounding box height.
UIBase
 Inherited$width : Number
[read-only] Retrieve the low-level bounding box width.
UIBase
 Inheritedbeads : Array
The array property that is used to add additional beads to an MXML tag.
UIBase
 InheritedclassName : String
The classname.
UIBase
  currentState : String
The name of the current state.
ContainerBase
 Inheritedelement : IFlexJSElement
[read-only] Each IUIBase has an element that is actually added to the platform's display list DOM.
UIBase
 InheritedexplicitHeight : Number
The explicitly set width (as opposed to measured width or percentage width).
UIBase
 InheritedexplicitWidth : Number
The explicitly set width (as opposed to measured width or percentage width).
UIBase
 Inheritedheight : Number
[override] The height of the component.
UIBase
 Inheritedid : String
An id property for MXML documents.
UIBase
 InheritedmeasurementBead : IMeasurementBead
[read-only] A measurement bead, if one exists.
UIBase
 Inheritedmodel : Object
An IBeadModel that serves as the data model for the component.
UIBase
  mxmlContent : Array
The default property.
ContainerBase
  MXMLDescriptor : Array
[read-only] An array of data that describes the MXML attributes and tags in an MXML document.
ContainerBase
 InheritednumElements : int
[read-only] The number of elements in the parent.
UIBase
 InheritedpercentHeight : Number
The requested percentage height this component should have in the parent container.
UIBase
 InheritedpercentWidth : Number
The requested percentage width this component should have in the parent container.
UIBase
  states : Array
The array of view states.
ContainerBase
 Inheritedstyle : Object
The object that contains "styles" and other associated name-value pairs.
UIBase
 InheritedtopMostEventDispatcher : IEventDispatcher
[read-only] The top most event dispatcher.
UIBase
  transitions : Array
The array of transitions.
ContainerBase
 InheritedtypeNames : String
A list of type names.
UIBase
 Inheritedview : IBeadView
An IBeadView that serves as the view for the component.
UIBase
 Inheritedwidth : Number
[override] The width of the component.
UIBase
Public Methods
 MethodDefined By
  
Constructor.
ContainerBase
 Inherited
addBead(bead:IBead):void
[override] Add a bead to the strand.
UIBase
  
[override] A ContainerBase doesn't create its children until it is added to a parent.
ContainerBase
 Inherited
addElement(c:Object, dispatchEvent:Boolean = true):void
Add a component to the parent.
UIBase
 Inherited
addElementAt(c:Object, index:int, dispatchEvent:Boolean = true):void
Add a component to the parent.
UIBase
  
generateMXMLAttributes(data:Array):void
An method called by the compiler's generated code to kick off the setting of MXML attribute values and instantiation of child tags.
ContainerBase
 Inherited
getBeadByType(classOrInterface:Class):IBead
Find a bead on the strand.
UIBase
  
getElementAt(index:int):Object
[override] Get a component from the parent.
ContainerBase
 Inherited
getElementIndex(c:Object):int
Gets the index of this subcomponent.
UIBase
  
hasState(state:String):Boolean
true if the array of states contains a state with this name.
ContainerBase
 Inherited
UIBase
 Inherited
UIBase
 Inherited
Remove a bead from the strand.
UIBase
 Inherited
removeElement(c:Object, dispatchEvent:Boolean = true):void
Remove a component from the parent.
UIBase
 Inherited
setHeight(value:Number, noEvent:Boolean = false):void
UIBase
 Inherited
setWidth(value:Number, noEvent:Boolean = false):void
UIBase
 Inherited
setWidthAndHeight(newWidth:Number, newHeight:Number, noEvent:Boolean = false):void
UIBase
 Inherited
setX(value:Number):void
UIBase
 Inherited
setY(value:Number):void
UIBase
Protected Methods
 MethodDefined By
 Inherited
Rebroadcast an event from a sub component from the component.
UIBase
Events
 Event Summary Defined By
  Indicates that the children of the container is have been added.ContainerBase
 InheritedSet a different class for click events so that there aren't dependencies on the flash classes on the JS side.UIBase
  Indicates that the initialization of the container is complete.ContainerBase
 InheritedSet a different class for mouseDown events so that there aren't dependencies on the flash classes on the JS side.UIBase
 InheritedSet a different class for mouseMove events so that there aren't dependencies on the flash classes on the JS side.UIBase
 InheritedSet a different class for mouseOut events so that there aren't dependencies on the flash classes on the JS side.UIBase
 InheritedSet a different class for mouseOver events so that there aren't dependencies on the flash classes on the JS side.UIBase
 InheritedSet a different class for mouseUp events so that there aren't dependencies on the flash classes on the JS side.UIBase
 InheritedSet a different class for rollOut events so that there aren't dependencies on the flash classes on the JS side.UIBase
 InheritedSet a different class for rollOver events so that there aren't dependencies on the flash classes on the JS side.UIBase
  Indicates that the state change has completed.ContainerBase
Property Detail
currentStateproperty
currentState:String

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

The name of the current state.

This property can be used as the source for data binding.


Implementation
    public function get currentState():String
    public function set currentState(value:String):void
mxmlContentproperty 
public var mxmlContent:Array

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

The default property. Child tags in MXML documents get assigned to this property, but are actually encoded by the compiler into the MXMLDescriptor array. Therefore, setting this property from ActionScript will have no effect at runtime.

MXMLDescriptorproperty 
MXMLDescriptor:Array  [read-only]

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

An array of data that describes the MXML attributes and tags in an MXML document. This data is usually decoded by an MXMLDataInterpreter


Implementation
    public function get MXMLDescriptor():Array
statesproperty 
states:Array

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

The array of view states. These should be instances of org.apache.flex.states.State.


Implementation
    public function get states():Array
    public function set states(value:Array):void
transitionsproperty 
transitions:Array

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

The array of transitions.


Implementation
    public function get transitions():Array
    public function set transitions(value:Array):void
Constructor Detail
ContainerBase()Constructor
public function ContainerBase()

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Constructor.

Method Detail
addedToParent()method
override public function addedToParent():void

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

A ContainerBase doesn't create its children until it is added to a parent.

generateMXMLAttributes()method 
public function generateMXMLAttributes(data:Array):void

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

An method called by the compiler's generated code to kick off the setting of MXML attribute values and instantiation of child tags. The call has to be made in the generated code in order to ensure that the constructors have completed first.

Parameters

data:Array — The encoded data representing the MXML attributes.

getElementAt()method 
override public function getElementAt(index:int):Object

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Get a component from the parent.

Parameters

index:int — The index of the subcomponent.

Returns
Object
hasState()method 
public function hasState(state:String):Boolean

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

true if the array of states contains a state with this name.

Parameters

state:String — The state namem.

Returns
Boolean — True if state in state array
Event Detail
childrenAdded Event
Event Object Type: org.apache.flex.events.Event

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Indicates that the children of the container is have been added.

initComplete Event  
Event Object Type: org.apache.flex.events.Event

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Indicates that the initialization of the container is complete.

stateChangeComplete Event  
Event Object Type: org.apache.flex.events.Event

Language Version : ActionScript 3.0
Product Version : FlexJS 0.0
Runtime Versions : Flash Player 10.2, AIR 2.6

Indicates that the state change has completed. All properties that need to change have been changed, and all transitinos that need to run have completed. However, any deferred work may not be completed, and the screen may not be updated until code stops executing.