Packagecom.esri.aws.awx.widget
Interfacepublic interface IWidget extends flash.events.IEventDispatcher
ImplementorsBarWidgetContainer, BaseWidget, BaseWidgetContainer, IconWidgetView, WidgetLoader

IWidget is the interface that widgets must extend.



Public Properties
 PropertyDefined by
  artifactID : String
[read-only] The widget's artifactID.
IWidget
  author : String
[read-only] The widget author.
IWidget
  description : String
[read-only] The widget description.
IWidget
  groupID : String
[read-only] The widget's groupID.
IWidget
  link : String
[read-only] A link to the widget web site.
IWidget
  name : String
[read-only] The widget name.
IWidget
  version : String
[read-only] The widget's version.
IWidget
  widgetStates : Array
[read-only] The supported states of this widget.
IWidget
Public Methods
 MethodDefined by
  
createWidgetView(widgetState:String):IWidgetView
Creates a widget view for a given state.
IWidget
  
loadProperty(name:String, defaultValue:Object = null):Object
Loads a property from this widget module's SharedObject.
IWidget
  
storeProperty(name:String, value:Object):void
Stores properties to this widget module's SharedObject.
IWidget
Property detail
artifactIDproperty
artifactID:String  [read-only]

The widget's artifactID.

Implementation
    public function get artifactID():String
authorproperty 
author:String  [read-only]

The widget author.

Implementation
    public function get author():String
descriptionproperty 
description:String  [read-only]

The widget description.

Implementation
    public function get description():String
groupIDproperty 
groupID:String  [read-only]

The widget's groupID.

Implementation
    public function get groupID():String
linkproperty 
link:String  [read-only]

A link to the widget web site.

Implementation
    public function get link():String
nameproperty 
name:String  [read-only]

The widget name.

Implementation
    public function get name():String
versionproperty 
version:String  [read-only]

The widget's version.

Implementation
    public function get version():String
widgetStatesproperty 
widgetStates:Array  [read-only]

The supported states of this widget.

Implementation
    public function get widgetStates():Array
Method detail
createWidgetView()method
public function createWidgetView(widgetState:String):IWidgetView

Creates a widget view for a given state.

Parameters
widgetState:String

Returns
IWidgetView — The widget view.
loadProperty()method 
public function loadProperty(name:String, defaultValue:Object = null):Object

Loads a property from this widget module's SharedObject.

Parameters
name:String — the name of the property to be loaded.
 
defaultValue:Object (default = null) — an optional default value.

Returns
Object — The value.
storeProperty()method 
public function storeProperty(name:String, value:Object):void

Stores properties to this widget module's SharedObject.

Parameters
name:String — the name of the property to be stored.
 
value:Object — the value of the property to be stored.