Packagecom.esri.aws.awx.widget
Classpublic class BaseWidget
InheritanceBaseWidget Inheritance mx.modules.Module
Implementscom.esri.aws.osgi.framework.IBundleActivator, IWidget

BaseWidget is an abstract implementation of IWidget for widgets to extend.



Public Properties
 PropertyDefined by
  artifactID : String
The widget's artifactID.
BaseWidget
  author : String
The widget author.
BaseWidget
  description : String
The widget description.
BaseWidget
  groupID : String
The widget's groupID.
BaseWidget
  link : String
A link to the widget web site.
BaseWidget
  version : String
The widget's version.
BaseWidget
  widgetStates : Array
The supported states of this widget.
BaseWidget
Protected Properties
 PropertyDefined by
  context : IBundleContext
Context to the OSGi framework.
BaseWidget
Public Methods
 MethodDefined by
  
Creates a new BaseWidget.
BaseWidget
  
This method is abstract and extending widgets must override it.
BaseWidget
  
loadProperty(name:String, defaultValue:Object = null):Object
Loads a property from this widget module's SharedObject.
BaseWidget
  
start(context:IBundleContext):void
Called when this bundle is started so the Framework can perform the bundle-specific activities necessary to start this bundle.
BaseWidget
  
stop(context:IBundleContext):void
Called when this bundle is stopped so the Framework can perform the bundle-specific activities necessary to stop the bundle.
BaseWidget
  
storeProperty(name:String, value:Object):void
Stores properties to this widget module's SharedObject.
BaseWidget
Property detail
artifactIDproperty
artifactID:String  [read-write]

The widget's artifactID.

Implementation
    public function get artifactID():String
    public function set artifactID(value:String):void
authorproperty 
author:String  [read-write]

The widget author.

Implementation
    public function get author():String
    public function set author(value:String):void
contextproperty 
protected var context:IBundleContext

Context to the OSGi framework.

descriptionproperty 
description:String  [read-write]

The widget description.

Implementation
    public function get description():String
    public function set description(value:String):void
groupIDproperty 
groupID:String  [read-write]

The widget's groupID.

Implementation
    public function get groupID():String
    public function set groupID(value:String):void
linkproperty 
link:String  [read-write]

A link to the widget web site.

Implementation
    public function get link():String
    public function set link(value:String):void
versionproperty 
version:String  [read-write]

The widget's version.

Implementation
    public function get version():String
    public function set version(value:String):void
widgetStatesproperty 
widgetStates:Array  [read-write]

The supported states of this widget.

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

Implementation
    public function get widgetStates():Array
    public function set widgetStates(value:Array):void
Constructor detail
BaseWidget()constructor
public function BaseWidget()

Creates a new BaseWidget.

Method detail
createWidgetView()method
public function createWidgetView(widgetState:String):IWidgetView

This method is abstract and extending widgets must override it.

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.
start()method 
public function start(context:IBundleContext):void

Called when this bundle is started so the Framework can perform the bundle-specific activities necessary to start this bundle. This method can be used to register services or to allocate any resources that this bundle needs.

This method must complete and return to its caller in a timely manner.

Parameters
context:IBundleContext — is passed into the IBundleActivator to give it access to the OSGi Framework

See also

IBundle.start()
stop()method 
public function stop(context:IBundleContext):void

Called when this bundle is stopped so the Framework can perform the bundle-specific activities necessary to stop the bundle. In general, this method should undo the work that the BundleActivator.start method started. A stopped bundle should be stopped and should not call any Framework objects.

This method must complete and return to its caller in a timely manner.

Parameters
context:IBundleContext — is passed into the IBundleActivator to give it access to the OSGi Framework

See also

IBundle.stop()
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.