IBM ILOG Dojo Diagrammer 1.1.1 API Documentation
Legend: Array Boolean Constructor Date DomNode Error Function Namespace Number Object RegExp Singleton String

ibm_ilog.diagram.interactors.KeyboardInteractorManager

Object » ibm_ilog.diagram.interactors.KeyboardInteractorManager
dojo.require("ibm_ilog.diagram.interactors.KeyboardInteractorManager");

This class manage the keyInteractor, by connection to the Diagram onkeydown event and pushing it to the appropriate registered Interactors. The associated diagram

Method Summary

  • activate() Activate the Manager, creating the connection.
  • add(id, keyInteractor) Adds a new keyInteractor.
  • clearHotKeys(id, hotKeys) This method is called to clear the hotkeys in the manager. Ideally, this is called inside the Interactors when trying to unregister it for removal or reconfiguration.
  • constructor(diagram) Creates a new instance.
  • deactivate() Deactivate the Manager, deleting the connection.
  • get(id) Gets a keyInteractor by its id.
  • keyPressed(e) This method is called when a key is pressed in the diagram.
  • remove(id) Removes a keyInteractor by its id.
  • setHotKeys(id, hotKeys) This method is called to register the hotkeys to the manager. Ideally, this is called inside the Interactors at initialization time.

Methods

activate
Activate the Manager, creating the connection.
add
Adds a new keyInteractor.
ParameterTypeDescription
idStringthe keyIntearctor id.
keyInteractoribm_ilog.diagram.interactors.Interactorthe keyIntearctor to be added.
clearHotKeys
This method is called to clear the hotkeys in the manager. Ideally, this is called inside the Interactors when trying to unregister it for removal or reconfiguration.
ParameterTypeDescription
idStringthe keyIntearctor id.
hotKeysJSobject a dictionary with the hotKeys to be register and the connections to be registered in each one. Format: {key1:[conn1,conn2], key2:[conn4]}
constructor
Creates a new instance.
ParameterTypeDescription
diagramibm_ilog.diagram.widget.Diagramthe associated diagram.
deactivate
Deactivate the Manager, deleting the connection.
get
Gets a keyInteractor by its id.
ParameterTypeDescription
idStringthe keyIntearctor id. return: ibm_ilog.diagram.interactors.Interactor
keyPressed
This method is called when a key is pressed in the diagram.
ParameterTypeDescription
eEventobject the event to be treated. return boolean
remove
Removes a keyInteractor by its id.
ParameterTypeDescription
idStringthe keyIntearctor id.
setHotKeys
This method is called to register the hotkeys to the manager. Ideally, this is called inside the Interactors at initialization time.
ParameterTypeDescription
idStringthe keyIntearctor id.
hotKeysJSobject a dictionary with the hotKeys to be register and the connections to be registered in each one. Format: {key1:[conn1,conn2], key2:[conn4]}