Packagecom.esri.aws.awx.widget
Classpublic class BaseWidgetContainer
InheritanceBaseWidgetContainer Inheritance mx.core.UIComponent
ImplementsIWidgetContainer, mx.controls.listClasses.IListItemRenderer, mx.core.IContainer, mx.managers.IFocusManagerContainer
SubclassesAccordionWidgetContainer, BarWidgetContainer, DockWidgetContainer, FloatingWidgetContainer, WidgetNavigator

BaseWidget container is an abstract implementation of IWidgetContainer for widget containers to extend.

It is extended by the five widget containers.

Default MXML PropertyMXMLwidgets


Public Properties
 PropertyDefined by
  data : Object
BaseWidgetContainer
  numWidgets : int
[read-only] Number of widgets in widget container.
BaseWidgetContainer
  widgets : WidgetCollection
The widgetCollection of the widget container.
BaseWidgetContainer
Protected Properties
 PropertyDefined by
  childrenCreationComplete : Boolean
Have the children been created?
BaseWidgetContainer
  collectionChanged : Boolean
Has the widget collection changed?
BaseWidgetContainer
  paddingBottom : Number
Padding for the bottom of the container.
BaseWidgetContainer
  paddingLeft : Number
Padding for the left of the container.
BaseWidgetContainer
  paddingRight : Number
Padding for the right of the container.
BaseWidgetContainer
  paddingTop : Number
Padding for the top of the container.
BaseWidgetContainer
  updateStyles : Boolean
Have the styles been updated?
BaseWidgetContainer
Public Methods
 MethodDefined by
  
BaseWidgetContainer()
Creates a new BaseWidgetContainer.
BaseWidgetContainer
  
addWidget(widget:IWidget):void
Adds a widget to widget container.
BaseWidgetContainer
  
addWidgetAt(widget:IWidget, index:int):void
Adds a widget to widget container (at a specific index).
BaseWidgetContainer
  
executeChildBindings(recurse:Boolean):void
Executes the bindings into this Container's child UIComponent objects.
BaseWidgetContainer
  
getAllWidgets():Array
Returns an array with all the widgets in the widget container.
BaseWidgetContainer
  
removeAllWidgets():void
Removes all widgets.
BaseWidgetContainer
  
removeWidget(widget:IWidget):void
Removes a widget from widget container.
BaseWidgetContainer
  
removeWidgetAt(index:int):IWidget
Removes widget from widget container (using index).
BaseWidgetContainer
Styles
 StyleDescriptionDefined by
  
paddingBottom
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the container's bottom border and the bottom of its content area. 		BaseWidgetContainer
  
paddingLeft
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the container's left border and the left of its content area. 		BaseWidgetContainer
  
paddingRight
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the container's right border and the right of its content area. 		BaseWidgetContainer
  
paddingTop
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the container's top border and the top of its content area. 		BaseWidgetContainer
Property detail
childrenCreationCompleteproperty
protected var childrenCreationComplete:Boolean

Have the children been created?

collectionChangedproperty 
protected var collectionChanged:Boolean

Has the widget collection changed?

dataproperty 
public var data:Object

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

numWidgetsproperty 
numWidgets:int  [read-only]

Number of widgets in widget container.

Implementation
    public function get numWidgets():int
paddingBottomproperty 
protected var paddingBottom:Number

Padding for the bottom of the container.

paddingLeftproperty 
protected var paddingLeft:Number

Padding for the left of the container.

paddingRightproperty 
protected var paddingRight:Number

Padding for the right of the container.

paddingTopproperty 
protected var paddingTop:Number

Padding for the top of the container.

updateStylesproperty 
protected var updateStyles:Boolean

Have the styles been updated?

widgetsproperty 
widgets:WidgetCollection  [read-write]

The widgetCollection of the widget container.

Implementation
    public function get widgets():WidgetCollection
    public function set widgets(value:WidgetCollection):void
Constructor detail
BaseWidgetContainer()constructor
public function BaseWidgetContainer()

Creates a new BaseWidgetContainer.

Method detail
addWidget()method
public function addWidget(widget:IWidget):void

Adds a widget to widget container.

Parameters
widget:IWidget
addWidgetAt()method 
public function addWidgetAt(widget:IWidget, index:int):void

Adds a widget to widget container (at a specific index).

Parameters
widget:IWidget
 
index:int
executeChildBindings()method 
public function executeChildBindings(recurse:Boolean):void

Executes the bindings into this Container's child UIComponent objects. Flex calls this method automatically once a Container has been created.

Parameters
recurse:Boolean — If false, then only execute the bindings on the immediate children of this Container. If true, then also execute the bindings on this container's grandchildren, great-grandchildren, and so on.
getAllWidgets()method 
public function getAllWidgets():Array

Returns an array with all the widgets in the widget container.

Returns
Array
removeAllWidgets()method 
public function removeAllWidgets():void

Removes all widgets.

removeWidget()method 
public function removeWidget(widget:IWidget):void

Removes a widget from widget container.

Parameters
widget:IWidget
removeWidgetAt()method 
public function removeWidgetAt(index:int):IWidget

Removes widget from widget container (using index).

Parameters
index:int

Returns
IWidget