Packagefr.kapit.pictogram.actions
Classpublic class PanAction
InheritancePanAction Inheritance Action Inheritance Object



Public Properties
 PropertyDefined By
 InheritedcanBeHibernated : Boolean
[read-only] Whether action can be hibernated.
Action
  data : Object
[override] Data object containing action properties.
PanAction
  id : String
[override] [read-only] Action identifier.
PanAction
 InheritedisExclusive : Boolean
If set to true, this action should be activated exclusively.
Action
 InheritedisKeyboardEnabled : Boolean
[read-only] Specifies whether this action can receive messages from KeyboardAction.
Action
  panStatus : String
PanAction
 InheritedpictogramChart : PictogramChart
[write-only] Visualizer instance using this action.
Action
 Inheritedstatus : String
A value from Action.UNREGISTRED, Action.ACTIVATED, Action.DEACTIVATED and Action.HIBERNATED indicating the action status.
Action
Public Methods
 MethodDefined By
  
PanAction
  
activate():void
[override] Activates action.
PanAction
  
deactivate():void
[override] Deactivates action.
PanAction
  
handleMessage(message:Object):void
[override] Method allowing to execute specific functionality for each message.
PanAction
 Inherited
hibernate():void
Hibernates action.
Action
 Inherited
update():void
Forces action properties update from data.
Action
 Inherited
wakeUp():void
Unhibernates action.
Action
Protected Methods
 MethodDefined By
  
[override]
PanAction
Public Constants
 ConstantDefined By
 InheritedACTIVATED : String = ACTIVATED
[static] An action with a status equal to ACTIVATED is registered in the pictogramChart and can be used.
Action
 InheritedDEACTIVATED : String = DEACTIVATED
[static] An action with a status equal to DEACTIVATED is registered in the pictogramChart but can't be used.
Action
 InheritedHIBERNATED : String = HIBERNATED
[static] An action with a status equal to HIBERNATED is registered in the pictogramChart but can't be used.
Action
  ID : String = panAction
[static]
PanAction
 InheritedUNREGISTERED : 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
dataproperty
data:Object[override]

Data object containing action properties.


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

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


Implementation
    public function get id():String
panStatusproperty 
panStatus:String


Implementation
    public function get panStatus():String
    public function set panStatus(value:String):void
Constructor Detail
PanAction()Constructor
public function PanAction()



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

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

deactivate()method 
override public function deactivate():void

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

getActivationCursor()method 
override protected function getActivationCursor():Class

Returns
Class
handleMessage()method 
override public function handleMessage(message:Object):void

Method allowing to execute specific functionality for each message.

Parameters

message:Object — Message object consumed by the method.

Constant Detail
IDConstant
public static const ID:String = panAction