Apache Flex (FlexJS) 0.7.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
ContainerBase

Package | org.apache.flex.core
Class | public class ContainerBase
Inheritance | ContainerBase UIBase HTMLElementWrapper 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 Property `mxmlContent`

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | $height : Number [read-only] Retrieve the low-level bounding box height. | UIBase
|  | $width : Number [read-only] Retrieve the low-level bounding box width. | UIBase
|  | beads : Array The array property that is used to add additional beads to an MXML tag. | UIBase
|  | className : String The classname. | UIBase
|  | currentState : String The name of the current state. | ContainerBase
|  | element : IFlexJSElement [read-only] Each IUIBase has an element that is actually added to the platform's display list DOM. | UIBase
|  | explicitHeight : Number The explicitly set width (as opposed to measured width or percentage width). | UIBase
|  | explicitWidth : Number The explicitly set width (as opposed to measured width or percentage width). | UIBase
|  | height : Number [override] The height of the component. | UIBase
|  | id : String An id property for MXML documents. | UIBase
|  | measurementBead : IMeasurementBead [read-only] A measurement bead, if one exists. | UIBase
|  | model : 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
|  | numElements : int [read-only] The number of elements in the parent. | UIBase
|  | percentHeight : Number The requested percentage height this component should have in the parent container. | UIBase
|  | percentWidth : Number The requested percentage width this component should have in the parent container. | UIBase
|  | states : Array The array of view states. | ContainerBase
|  | style : Object The object that contains "styles" and other associated name-value pairs. | UIBase
|  | topMostEventDispatcher : IEventDispatcher [read-only] The top most event dispatcher. | UIBase
|  | transitions : Array The array of transitions. | ContainerBase
|  | typeNames : String A list of type names. | UIBase
|  | view : IBeadView An IBeadView that serves as the view for the component. | UIBase
|  | width : Number [override] The width of the component. | UIBase

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | ContainerBase() Constructor. | ContainerBase
|  | addBead(bead:IBead):void [override] Add a bead to the strand. | UIBase
|  | addedToParent():void [override] A ContainerBase doesn't create its children until it is added to a parent. | ContainerBase
|  | addElement(c:Object, dispatchEvent:Boolean = true):void Add a component to the parent. | UIBase
|  | 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
|  | getBeadByType(classOrInterface:Class):IBead Find a bead on the strand. | UIBase
|  | getElementAt(index:int):Object [override] Get a component from the parent. | ContainerBase
|  | 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
|  | isHeightSizedToContent():Boolean | UIBase
|  | isWidthSizedToContent():Boolean | UIBase
|  | removeBead(value:IBead):IBead Remove a bead from the strand. | UIBase
|  | removeElement(c:Object, dispatchEvent:Boolean = true):void Remove a component from the parent. | UIBase
|  | setHeight(value:Number, noEvent:Boolean = false):void | UIBase
|  | setWidth(value:Number, noEvent:Boolean = false):void | UIBase
|  | setWidthAndHeight(newWidth:Number, newHeight:Number, noEvent:Boolean = false):void | UIBase
|  | setX(value:Number):void | UIBase
|  | setY(value:Number):void | UIBase

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | repeaterListener(event:Event):void Rebroadcast an event from a sub component from the component. | UIBase

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | childrenAdded | Indicates that the children of the container is have been added. | ContainerBase
|  | click | Set a different class for click events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | initComplete | Indicates that the initialization of the container is complete. | ContainerBase
|  | mouseDown | Set a different class for mouseDown events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseMove | Set a different class for mouseMove events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseOut | Set a different class for mouseOut events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseOver | Set a different class for mouseOver events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | mouseUp | Set a different class for mouseUp events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | rollOut | Set a different class for rollOut events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | rollOver | Set a different class for rollOver events so that there aren't dependencies on the flash classes on the JS side. | UIBase
|  | stateChangeComplete | Indicates that the state change has completed. | ContainerBase

Property Detail

currentState | property

`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`

mxmlContent | property |

`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.

MXMLDescriptor | property |

`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`

states | property |

`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`

transitions | property |

`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.

Mon Sep 5 2016, 07:19 AM -07:00