Packagecom.esri.aws.awx.widget
Classpublic class BarWidgetContainer
InheritanceBarWidgetContainer Inheritance BaseWidgetContainer Inheritance mx.core.UIComponent
ImplementsIWidgetView

BarWidgetContainer is a type of "carousel container" that provides the ability to scroll through its content, either horizontally or vertically.

BaseMapWidget is a good example of a BarWidgetContainer.

The BarWidgetContainer uses two different widget states: WidgetStates.ICON and WidgetStates.ICON_ACTION.

See also

BaseMapWidget

Public Properties
 PropertyDefined by
 Inheriteddata : Object
BaseWidgetContainer
  direction : String
Set the direction of the bar -- either "horizontal" or "vertical".
BarWidgetContainer
  maxScrollPosition : int
The maximum allowable scroll position.
BarWidgetContainer
 InheritednumWidgets : int
Number of widgets in widget container.
BaseWidgetContainer
  pageSize : int
The size of the visible page.
BarWidgetContainer
  scrollPosition : int
The current scroll position of the container.
BarWidgetContainer
  widget : IWidget
[read-only]
BarWidgetContainer
  widgetContainer : IWidgetContainer
BarWidgetContainer
 Inheritedwidgets : WidgetCollection
The widgetCollection of the widget container.
BaseWidgetContainer
  widgetState : String
The widget state.
BarWidgetContainer
  widgetStatesInBar : Array
Sets the states of the widgets loaded in the bar.
BarWidgetContainer
Protected Properties
 PropertyDefined by
  arrowGap : uint
The gap between icons and directional arrows.
BarWidgetContainer
  arrowHeight : uint
The height of "next" and "previous" arrows.
BarWidgetContainer
  arrowWidth : uint
The width of "next" and "previous" arrows.
BarWidgetContainer
  barBase : UIComponent
The UIComponent used as the widget bar.
BarWidgetContainer
  barMask : DisplayObject
The UIComponent used as the widget bar mask.
BarWidgetContainer
 InheritedchildrenCreationComplete : Boolean
Have the children been created?
BaseWidgetContainer
 InheritedcollectionChanged : Boolean
Has the widget collection changed?
BaseWidgetContainer
  horizontalGap : uint
The horizontal gap between icons (when direction=horizontal).
BarWidgetContainer
  iconHeight : uint
The height of each icon.
BarWidgetContainer
  iconWidth : uint
The width of each icon.
BarWidgetContainer
  moveEffect : Move
The effect used when scrolling between pages.
BarWidgetContainer
  nextArrowStyleName : String
The style setting for the "Next" arrow.
BarWidgetContainer
  nextPageArrow : Button
The next page arrow button.
BarWidgetContainer
 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
  previousArrowStyleName : String
The style setting for the "Previous" arrow.
BarWidgetContainer
  previousPageArrow : Button
The previous page arrow button.
BarWidgetContainer
  scrollBase : UIComponent
The UIComponent used as the scroll bar.
BarWidgetContainer
 InheritedupdateStyles : Boolean
Have the styles been updated?
BaseWidgetContainer
  verticalGap : uint
The vertical gap between icons (when direction=vertical).
BarWidgetContainer
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
  
setWidget(value:IWidget):void
BarWidgetContainer
Protected Methods
 MethodDefined by
  
collectionChangeHandler(event:CollectionEvent):void
BarWidgetContainer
  
iconClickHandler(event:MouseEvent):void
This method handles the click event of the widget icon states.
BarWidgetContainer
Events
 EventSummaryDefined by
  
itemClick
 BarWidgetContainer
Styles
 StyleDescriptionDefined by
  
arrowGap
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between icons and directional arrows. 		BarWidgetContainer
  
arrowHeight
Type: uint   Format: Length   CSS Inheritance: no
Height of "next" and "previous" arrows. 		BarWidgetContainer
  
arrowWidth
Type: uint   Format: Length   CSS Inheritance: no
Width of "next" and "previous" arrows. 		BarWidgetContainer
  
horizontalGap
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between icons in the horizontal direction. 		BarWidgetContainer
  
iconHeight
Type: uint   Format: Length   CSS Inheritance: no
Height of each icon. 		BarWidgetContainer
  
iconWidth
Type: uint   Format: Length   CSS Inheritance: no
Width of each icon. 		BarWidgetContainer
  
nextArrowStyleName
Type: String   CSS Inheritance: no
Style name for the next arrow button. If the direction is horizontal the next arrow button is the one on the right. Otherwise, when direction is vertical, the button is the one at the bottom. 		BarWidgetContainer
 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
  
previousArrowStyleName
Type: String   CSS Inheritance: no
Style name for the previous arrow button. If the direction is horizontal the previous arrow button is the one on the left. Otherwise, when direction is vertical, the button is the one at the top. 		BarWidgetContainer
  
previousArrowStyleName
Type: String   CSS Inheritance: no
Number of pixels between icons and directional arrows. 		BarWidgetContainer
  
verticalGap
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between icons in the vertical direction. 		BarWidgetContainer
Public Constants
 ConstantDefined by
  HORIZONTAL : String = "horizontal"
[static] Constant used to set the direction to horizontal.
BarWidgetContainer
  VERTICAL : String = "vertical"
[static] Constant used to set the direction to vertical.
BarWidgetContainer
Property detail
arrowGapproperty
protected var arrowGap:uint

The gap between icons and directional arrows.

arrowHeightproperty 
protected var arrowHeight:uint

The height of "next" and "previous" arrows.

arrowWidthproperty 
protected var arrowWidth:uint

The width of "next" and "previous" arrows.

barBaseproperty 
protected var barBase:UIComponent

The UIComponent used as the widget bar.

barMaskproperty 
protected var barMask:DisplayObject

The UIComponent used as the widget bar mask.

directionproperty 
direction:String  [read-write]

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

Implementation
    public function get direction():String
    public function set direction(value:String):void
horizontalGapproperty 
protected var horizontalGap:uint

The horizontal gap between icons (when direction=horizontal).

iconHeightproperty 
protected var iconHeight:uint

The height of each icon.

iconWidthproperty 
protected var iconWidth:uint

The width of each icon.

maxScrollPositionproperty 
maxScrollPosition:int  [read-write]

The maximum allowable scroll position.

Implementation
    public function get maxScrollPosition():int
    public function set maxScrollPosition(value:int):void
moveEffectproperty 
protected var moveEffect:Move

The effect used when scrolling between pages.

nextArrowStyleNameproperty 
protected var nextArrowStyleName:String

The style setting for the "Next" arrow.

nextPageArrowproperty 
protected var nextPageArrow:Button

The next page arrow button.

pageSizeproperty 
pageSize:int  [read-write]

The size of the visible page.

Implementation
    public function get pageSize():int
    public function set pageSize(value:int):void
previousArrowStyleNameproperty 
protected var previousArrowStyleName:String

The style setting for the "Previous" arrow.

previousPageArrowproperty 
protected var previousPageArrow:Button

The previous page arrow button.

scrollBaseproperty 
protected var scrollBase:UIComponent

The UIComponent used as the scroll bar.

scrollPositionproperty 
scrollPosition:int  [read-write]

The current scroll position of the container.

Implementation
    public function get scrollPosition():int
    public function set scrollPosition(value:int):void
verticalGapproperty 
protected var verticalGap:uint

The vertical gap between icons (when direction=vertical).

widgetproperty 
widget:IWidget  [read-only]Implementation
    public function get widget():IWidget
widgetContainerproperty 
widgetContainer:IWidgetContainer  [read-write]

Implementation
    public function get widgetContainer():IWidgetContainer
    public function set widgetContainer(value:IWidgetContainer):void
widgetStateproperty 
widgetState:String  [read-write]

The widget state.

Implementation
    public function get widgetState():String
    public function set widgetState(value:String):void
widgetStatesInBarproperty 
widgetStatesInBar:Array  [read-write]

Sets the states of the widgets loaded in the bar.

Implementation
    public function get widgetStatesInBar():Array
    public function set widgetStatesInBar(value:Array):void
Method detail
collectionChangeHandler()method
protected override function collectionChangeHandler(event:CollectionEvent):voidParameters
event:CollectionEvent
iconClickHandler()method 
protected function iconClickHandler(event:MouseEvent):void

This method handles the click event of the widget icon states.

Parameters
event:MouseEvent
setWidget()method 
public function setWidget(value:IWidget):void

Parameters
value:IWidget
Event detail
itemClickevent 
Event object type: mx.events.ItemClickEvent

Constant detail
HORIZONTALconstant
public static const HORIZONTAL:String = "horizontal"

Constant used to set the direction to horizontal.

VERTICALconstant 
public static const VERTICAL:String = "vertical"

Constant used to set the direction to vertical.