com.esri.aws.awx.widget.FloatingWidgetContainer

Package	com.esri.aws.awx.widget
Class	public class FloatingWidgetContainer
Inheritance	FloatingWidgetContainer BaseWidgetContainer mx.core.UIComponent

FloatingWidgetContainer is a "popup" widget container that "floats" atop the application.

The FloatingWidgetContainer supports three widget states: WidgetStates.ICON, WidgetStates.INFO, and WidgetStates.DEFAULT. The DEFAULT widget state is displayed by default. The ICON state is displayed when a user clicks the "i" of the floating widget container.

PanZoomWidget is a good example of a FloatingWidgetContainer. It uses the INFO widget state to allow users to pick between options. Another possible use of the INFO widget state would be to provide instructions about a widget.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined by
		data : Object	BaseWidgetContainer
		flipBackProperty : Object [write-only] The percentage used to determine the flip effect of the front view	FloatingWidgetContainer
		flipFrontProperty : Object [write-only] The percentage used to determine the flip effect of the back view	FloatingWidgetContainer
		numWidgets : int Number of widgets in widget container.	BaseWidgetContainer
		widgets : WidgetCollection The widgetCollection of the widget container.	BaseWidgetContainer

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined by
		childrenCreationComplete : Boolean Have the children been created?	BaseWidgetContainer
		collectionChanged : Boolean Has the widget collection changed?	BaseWidgetContainer
		currentView : IUIComponent The current view of the widgetContainer	FloatingWidgetContainer
		defaultView : FloatingContainerView The default view of the widgetContainer	FloatingWidgetContainer
		infoView : FloatingContainerView The default view of the widgetContainer	FloatingWidgetContainer
		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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		FloatingWidgetContainer() Creates a new FloatingWidgetContainer.	FloatingWidgetContainer
		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
		close():void Closes the floating widget container	FloatingWidgetContainer
		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

Protected Methods

	Method		Defined by
		createDefaultView():void Creates the widgetContainer's default view	FloatingWidgetContainer
		createInfoView():void Creates the widgetContainer's info view	FloatingWidgetContainer
		layoutBack():void Lays out the "back" view of the widget container	FloatingWidgetContainer
		layoutFront():void Lays out the front view of the widget container	FloatingWidgetContainer
		mainViewCloseHandler(event:FloatingContainerEvent):void Triggers the close method when the close button is clicked	FloatingWidgetContainer
		mainViewInfoHandler(event:FloatingContainerEvent):void Triggers the flipperoo to the back view when the info button is clicked	FloatingWidgetContainer
		renderSides(leftPercentageDistance:Number, topPercentageDistance:Number, rightPercentageDistance:Number, bottomPercentageDistance:Number, offsetRect:Rectangle, distort:DistortImage):void Calculates the distortions used during the "Fliperoo" transition.	FloatingWidgetContainer

Events

	Event		Summary	Defined by
		containerDoneClickEvent	The containerDoneClickEvent is dispatched when the user clicks the "Done" button from the info state of the widget.	FloatingWidgetContainer

Styles

Hide Inherited Styles

Show Inherited Styles

	Style		Description	Defined 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.	FloatingWidgetContainer
		backgroundColor	Type: uint Format: Color CSS Inheritance: no Background color of a component.	FloatingWidgetContainer
		borderColor	Type: uint Format: Color CSS Inheritance: no Color of the border.	FloatingWidgetContainer
		borderSkin	Type: Class CSS Inheritance: no The border skin of the component. The default value is `mx.skins.halo.HaloBorder`.	FloatingWidgetContainer
		borderThickness	Type: Number Format: Length CSS Inheritance: no Bounding box thickness. Only used when `borderStyle` is set to `"solid"`. The default value is `1`.	FloatingWidgetContainer
		contentAreaStyleName	Type: String CSS Inheritance: no Style name for the content area.	FloatingWidgetContainer
		cornerRadius	Type: Number Format: Length CSS Inheritance: no Radius of component corners.	FloatingWidgetContainer
		dropShadowColor	Type: uint Format: Color CSS Inheritance: yes Color of the drop shadow.	FloatingWidgetContainer
		dropShadowEnabled	Type: Boolean CSS Inheritance: no Boolean property that specifies whether the component has a visible drop shadow. This style is used with `borderStyle="solid"`. Note: For drop shadows to appear on containers, set `backgroundColor` or `backgroundImage` properties. Otherwise, the shadow appears behind the container because the default background of a container is transparent. The default value is `true`.	FloatingWidgetContainer
		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
		shadowDirection	Type: String CSS Inheritance: no Direction of the drop shadow. Possible values are `"left"`, `"center"`, and `"right"`.	FloatingWidgetContainer
		shadowDistance	Type: Number Format: Length CSS Inheritance: no Distance of the drop shadow. If the property is set to a negative value, the shadow appears above the component.	FloatingWidgetContainer

Property detail

currentView

property

protected var currentView:IUIComponent

The current view of the widgetContainer

defaultView

property

protected var defaultView:FloatingContainerView

The default view of the widgetContainer

flipBackProperty

property

flipBackProperty:Object [write-only]

The percentage used to determine the flip effect of the front view

Implementation
public function set flipBackProperty(value:Object):void

flipFrontProperty

property

flipFrontProperty:Object [write-only]

The percentage used to determine the flip effect of the back view

Implementation
public function set flipFrontProperty(value:Object):void

infoView

property

protected var infoView:FloatingContainerView

The default view of the widgetContainer

Constructor detail

FloatingWidgetContainer

()

constructor

public function FloatingWidgetContainer()

Creates a new FloatingWidgetContainer.

Method detail

close

()

method

public function close():void

Closes the floating widget container

createDefaultView

()

method

protected function createDefaultView():void

Creates the widgetContainer's default view

createInfoView

()

method

protected function createInfoView():void

Creates the widgetContainer's info view

layoutBack

()

method

protected function layoutBack():void

Lays out the "back" view of the widget container

layoutFront

()

method

protected function layoutFront():void

Lays out the front view of the widget container

mainViewCloseHandler

()

method

protected function mainViewCloseHandler(event:FloatingContainerEvent):void

Triggers the close method when the close button is clicked

Parameters

event:FloatingContainerEvent

mainViewInfoHandler

()

method

protected function mainViewInfoHandler(event:FloatingContainerEvent):void

Triggers the flipperoo to the back view when the info button is clicked

Parameters

event:FloatingContainerEvent

renderSides

()

method

protected function renderSides(leftPercentageDistance:Number, topPercentageDistance:Number, rightPercentageDistance:Number, bottomPercentageDistance:Number, offsetRect:Rectangle, distort:DistortImage):void

Calculates the distortions used during the "Fliperoo" transition.

Parameters

	`leftPercentageDistance:Number`

	`topPercentageDistance:Number`

	`rightPercentageDistance:Number`

	`bottomPercentageDistance:Number`

	`offsetRect:Rectangle`

	`distort:DistortImage`

Event detail

containerDoneClickEvent

event

Event object type: Event

The containerDoneClickEvent is dispatched when the user clicks the "Done" button from the info state of the widget.