Packagefr.kapit.pictogram.actions
Interfacepublic interface IAction
Implementors Action

IAction is the interface that any action should implement. An action is a class ensuring a user interaction such as pan, zoom, resize, and displace.



Public Properties
 PropertyDefined By
  canBeHibernated : Boolean
[read-only] Whether action can be hibernated.
IAction
  data : Object
Data object containing action properties.
IAction
  id : String
[read-only] Action identifier.
IAction
  isExclusive : Boolean
If set to true, this action should be activated exclusively.
IAction
  isKeyboardEnabled : Boolean
[read-only] Specifies whether this action can receive messages from KeyboardAction.
IAction
  pictogramChart : PictogramChart
[write-only] Visualizer instance using this action.
IAction
  status : String
A value from Action.UNREGISTRED, Action.ACTIVATED, Action.DEACTIVATED and Action.HIBERNATED indicating the action status.
IAction
Public Methods
 MethodDefined By
  
activate():void
Activates action.
IAction
  
deactivate():void
Deactivates action.
IAction
  
handleMessage(message:Object):void
Method allowing to execute specific functionality for each message.
IAction
  
hibernate():void
Hibernates action.
IAction
  
update():void
Forces action properties update from data.
IAction
  
wakeUp():void
Unhibernates action.
IAction
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

See also

fr.kapit.visualizer.Visualizer
fr.kapit.visualizer.Visualizer.activateAction()
fr.kapit.visualizer.Visualizer.deactivateAction()
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

See also

fr.kapit.visualizer.actions.KeyboardAction
pictogramChartproperty 
pictogramChart:PictogramChart  [write-only]

Visualizer instance using this action.


Implementation
    public function set pictogramChart(value:PictogramChart):void

See also

fr.kapit.visualizer.Visualizer
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

See also

fr.kapit.visualizer.actions.Action
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.