WidgetSprite

Sprite

WidgetSprite

9 other children

Base class for widgets to enable/disable event listeners and keep a global tab order of all widgets (provided they are created and registered in tab order.

Summary

WidgetSprite	Base class for widgets to enable/disable event listeners and keep a global tab order of all widgets (provided they are created and registered in tab order.
Variables
widgets	A static associative table indexed by owner of arrays of WidgetSprite instances belonging to the owner.
registerCount	Count of number of widgets that have been registered.
instanceOwner	The registered owner of this WidgetSprite instance
activeState	Stores whether the widget is active or inactive.
Properties
isActive	Indicates whether the widget is active or not.
Functions
setActive	Sets the state of the widget to active or inactive.
register	Register the owner of a widget.
unregister	Removes the registered ownership of a widget.
setOwnerActive	Sets all widgets registered to owner to the given state.
isOwnerActive	Gets the state of a widget owner.
toString	Describes the widget sprite class state.

Variables

widgets

private static var widgets: Object

A static associative table indexed by owner of arrays of WidgetSprite instances belonging to the owner.

registerCount

private static var registerCount: int

Count of number of widgets that have been registered. Used to keep a global tab order irrespective of unregister.

instanceOwner

private var instanceOwner: String

The registered owner of this WidgetSprite instance

activeState

private var activeState: Boolean

Stores whether the widget is active or inactive.

Properties

isActive

public function get isActive():Boolean

Indicates whether the widget is active or not.

Returns

True if active, false otherwise.

Functions

setActive

public function setActive( state: Boolean ):void

Sets the state of the widget to active or inactive.

Parameters

state

True to activate, false otherwise.

register

public function register( owner: String ):void

Parameters

owner

The owner of widget

unregister

public function unregister():void

Removes the registered ownership of a widget.

setOwnerActive

public static function setOwnerActive( owner: String,
state: Boolean ):void

Sets all widgets registered to owner to the given state.

Parameters

owner	The owner of widgets
state	True to activate the widgets, false to disactivate.

isOwnerActive

public static function isOwnerActive( owner: String ):Boolean

Gets the state of a widget owner.

Parameters

owner

The owner of widgets

Returns

True if the owner is active, false otherwise.

toString

public static function toString():String

Describes the widget sprite class state.

Returns

String with information about each widget owner and state.