Packagecom.esri.aws.awx.widget
Classpublic class DockWidgetContainer
InheritanceDockWidgetContainer Inheritance BaseWidgetContainer Inheritance mx.core.UIComponent

DockWidgetContainer is an interactive widget container that can be "docked" to the side of an application.

The DockWidgetContainer contains a BarWidgetContainer, and thus, like the BarWidgetContainer supports two widget states: WidgetStates.ICON and WidgetStates.ICON_ACTION.

Tip: set the layout property of the mx:Application to "absolute" for best default location of the DockWidgetContainer.


Example
Sample MXML usage of DockWidgetContainer: 
       <widget:DockWidgetContainer>
         <widget:PanZoomWidgetLoader id="panZoomW" />
         <widget:FindWidgetLoader id="findW" />
         <widget:BaseMapWidget id="baseMapW"/>
       </widget:DockWidgetContainer>


Public Properties
 PropertyDefined by
 Inheriteddata : Object
BaseWidgetContainer
  direction : String
Sets the direction of the bar -- either "horizontal" or "vertical".
DockWidgetContainer
  dockState : String
Sets the state of the dock -- either "open" or "close".
DockWidgetContainer
 InheritednumWidgets : int
Number of widgets in widget container.
BaseWidgetContainer
 Inheritedwidgets : WidgetCollection
The widgetCollection of the widget container.
BaseWidgetContainer
Protected Properties
 PropertyDefined by
 InheritedchildrenCreationComplete : Boolean
Have the children been created?
BaseWidgetContainer
 InheritedcollectionChanged : Boolean
Has the widget collection changed?
BaseWidgetContainer
 InheritedpaddingBottom : Number
Padding for the bottom of the container.
BaseWidgetContainer
 InheritedpaddingLeft : Number
Padding for the left of the container.
BaseWidgetContainer
 InheritedpaddingRight : Number
Padding for the right of the container.
BaseWidgetContainer
 InheritedpaddingTop : Number
Padding for the top of the container.
BaseWidgetContainer
 InheritedupdateStyles : Boolean
Have the styles been updated?
BaseWidgetContainer
  widgetBar : BarWidgetContainer
The widgetBar contained within the Dock.
DockWidgetContainer
Public Methods
 MethodDefined by
 Inherited
addWidget(widget:IWidget):void
Adds a widget to widget container.
BaseWidgetContainer
 Inherited
addWidgetAt(widget:IWidget, index:int):void
Adds a widget to widget container (at a specific index).
BaseWidgetContainer
 Inherited
executeChildBindings(recurse:Boolean):void
Executes the bindings into this Container's child UIComponent objects.
BaseWidgetContainer
 Inherited
getAllWidgets():Array
Returns an array with all the widgets in the widget container.
BaseWidgetContainer
 Inherited
removeAllWidgets():void
Removes all widgets.
BaseWidgetContainer
 Inherited
removeWidget(widget:IWidget):void
Removes a widget from widget container.
BaseWidgetContainer
 Inherited
removeWidgetAt(index:int):IWidget
Removes widget from widget container (using index).
BaseWidgetContainer
Protected Methods
 MethodDefined by
  
widgetBarItemClickHandler(event:ItemClickEvent):void
This method handles the click event from the barWidgetContainer contained within the dock container.
DockWidgetContainer
Styles
 StyleDescriptionDefined by
  
backgroundAlpha
Type: Number   CSS Inheritance: no
Alpha level of the color defined by the backgroundColor property of the image or SWF file defined by the backgroundImage style. Valid values range from 0.0 to 1.0. 		DockWidgetContainer
  
backgroundColor
Type: uint   Format: Color   CSS Inheritance: no
Background color of a component. 		DockWidgetContainer
  
borderSkin
Type: Class   CSS Inheritance: no
The border skin of the component. The default value is com.esri.aws.awx.widget.dockClasses.skins.DockBorder.		DockWidgetContainer
  
cornerRadius
Type: Number   Format: Length   CSS Inheritance: no
Radius of component corners. 		DockWidgetContainer
  
innerShadowEnabled
Type: Boolean   CSS Inheritance: no
Boolean property that specifies whether the component has a visible inner drop shadow. 		DockWidgetContainer
  
maximizeStyleName
Type: String   CSS Inheritance: no
Style name for the maximize button. 		DockWidgetContainer
  
minimizeStyleName
Type: String   CSS Inheritance: no
Style name for the minimize button. 		DockWidgetContainer
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
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
  
resizeHandleHeight
Type: uint   Format: Length   CSS Inheritance: no
Height of minimize and maximize buttons. 		DockWidgetContainer
  
resizeHandleWidth
Type: uint   Format: Length   CSS Inheritance: no
Width of minimize and maximize buttons. 		DockWidgetContainer
  
shadowAlpha
Type: Number   CSS Inheritance: no
Alpha level of the shadow. 		DockWidgetContainer
  
widgetBarStyleName
Type: String   CSS Inheritance: no
Style name for the BarWidgetContainer. 		DockWidgetContainer
Public Constants
 ConstantDefined by
  CLOSE : String = "close"
[static] Constant used to set the dock state to close.
DockWidgetContainer
  HORIZONTAL : String = "horizontal"
[static] Constant used to set the direction to horizontal.
DockWidgetContainer
  OPEN : String = "open"
[static] Constant used to set the dock state to open.
DockWidgetContainer
  VERTICAL : String = "vertical"
[static] Constant used to set the direction to vertical.
DockWidgetContainer
Property detail
directionproperty
direction:String  [read-write]

Sets the direction of the bar -- either "horizontal" or "vertical".

Implementation
    public function get direction():String
    public function set direction(value:String):void
dockStateproperty 
dockState:String  [read-write]

Sets the state of the dock -- either "open" or "close".

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

Implementation
    public function get dockState():String
    public function set dockState(value:String):void
widgetBarproperty 
protected var widgetBar:BarWidgetContainer

The widgetBar contained within the Dock. The widgetBar is the subcontainer that actually contains the widgets

Method detail
widgetBarItemClickHandler()method
protected function widgetBarItemClickHandler(event:ItemClickEvent):void

This method handles the click event from the barWidgetContainer contained within the dock container.

Parameters
event:ItemClickEvent
Constant detail
CLOSEconstant
public static const CLOSE:String = "close"

Constant used to set the dock state to close.

HORIZONTALconstant 
public static const HORIZONTAL:String = "horizontal"

Constant used to set the direction to horizontal.

OPENconstant 
public static const OPEN:String = "open"

Constant used to set the dock state to open.

VERTICALconstant 
public static const VERTICAL:String = "vertical"

Constant used to set the direction to vertical.