Packagefr.kapit.pictogram.actions
Classpublic class Action
InheritanceAction Inheritance Object
Implements IAction
Subclasses PanAction

Action is the bacic class for action classes.



Public Properties
 PropertyDefined By
  canBeHibernated : Boolean
[read-only] Whether action can be hibernated.
Action
  data : Object
Data object containing action properties.
Action
  id : String
[read-only] Action identifier.
Action
  isExclusive : Boolean
If set to true, this action should be activated exclusively.
Action
  isKeyboardEnabled : Boolean
[read-only] Specifies whether this action can receive messages from KeyboardAction.
Action
  pictogramChart : PictogramChart
[write-only] Visualizer instance using this action.
Action
  status : String
A value from Action.UNREGISTRED, Action.ACTIVATED, Action.DEACTIVATED and Action.HIBERNATED indicating the action status.
Action
Public Methods
 MethodDefined By
  
Constuctor.
Action
  
activate():void
Activates action.
Action
  
deactivate():void
Deactivates action.
Action
  
handleMessage(message:Object):void
Method allowing to execute specific functionality for each message.
Action
  
hibernate():void
Hibernates action.
Action
  
update():void
Forces action properties update from data.
Action
  
wakeUp():void
Unhibernates action.
Action
Public Constants
 ConstantDefined By
  ACTIVATED : String = ACTIVATED
[static] An action with a status equal to ACTIVATED is registered in the pictogramChart and can be used.
Action
  DEACTIVATED : String = DEACTIVATED
[static] An action with a status equal to DEACTIVATED is registered in the pictogramChart but can't be used.
Action
  HIBERNATED : String = HIBERNATED
[static] An action with a status equal to HIBERNATED is registered in the pictogramChart but can't be used.
Action
  UNREGISTERED : String = UNREGISTERED
[static] An action with a status equal to UNREGISTERED is not registered in the pictogramChart and can't be used.
Action
Property Detail
canBeHibernatedproperty
canBeHibernated:Boolean  [read-only]

Whether action can be hibernated.


Implementation
    public function get canBeHibernated():Boolean
dataproperty 
data:Object

Data object containing action properties.


Implementation
    public function get data():Object
    public function set data(value:Object):void
idproperty 
id:String  [read-only]

Action identifier. Used for activating or deactivating action through Visualizer.


Implementation
    public function get id():String
isExclusiveproperty 
isExclusive:Boolean

If set to true, this action should be activated exclusively. When activated, Visualizer hibernates all other active actions.


Implementation
    public function get isExclusive():Boolean
    public function set isExclusive(value:Boolean):void
isKeyboardEnabledproperty 
isKeyboardEnabled:Boolean  [read-only]

Specifies whether this action can receive messages from KeyboardAction.


Implementation
    public function get isKeyboardEnabled():Boolean
pictogramChartproperty 
pictogramChart:PictogramChart  [write-only]

Visualizer instance using this action.


Implementation
    public function set pictogramChart(value:PictogramChart):void
statusproperty 
status:String

A value from Action.UNREGISTRED, Action.ACTIVATED, Action.DEACTIVATED and Action.HIBERNATED indicating the action status.


Implementation
    public function get status():String
    public function set status(value:String):void
Constructor Detail
Action()Constructor
public function Action()

Constuctor.

Method Detail
activate()method
public function activate():void

Activates action. Action status is set to Action.ACTIVATED.

deactivate()method 
public function deactivate():void

Deactivates action. Action status is set to Action.DEACTIVATED.

handleMessage()method 
public function handleMessage(message:Object):void

Method allowing to execute specific functionality for each message.

Parameters

message:Object — Message object consumed by the method.

hibernate()method 
public function hibernate():void

Hibernates action. Action status is set to Action.HIBERNATED.

update()method 
public function update():void

Forces action properties update from data.

wakeUp()method 
public function wakeUp():void

Unhibernates action. Action status is set to Action.ACTIVATED.

Constant Detail
ACTIVATEDConstant
public static const ACTIVATED:String = ACTIVATED

An action with a status equal to ACTIVATED is registered in the pictogramChart and can be used. When an exclusive action is activated, other actions become hibernated.

DEACTIVATEDConstant 
public static const DEACTIVATED:String = DEACTIVATED

An action with a status equal to DEACTIVATED is registered in the pictogramChart but can't be used. A registered action can be deactivated temporarily and reactivated later when necessary. Exclusive actions should be deactivated when they are not needed because when they are activated, other actions become hibernated.

HIBERNATEDConstant 
public static const HIBERNATED:String = HIBERNATED

An action with a status equal to HIBERNATED is registered in the pictogramChart but can't be used. Actions become hibernated when another exclusive action is activated.

UNREGISTEREDConstant 
public static const UNREGISTERED:String = UNREGISTERED

An action with a status equal to UNREGISTERED is not registered in the pictogramChart and can't be used. Once it is registered, it will become ACTIVATED.