BaseHandler.kl¶
Types¶
BaseHandler (object)¶
バージョン 2.0.1 で追加.
BaseHandler class allows to handle/process user events. Any custom handlers should specialize this class. How handlers process events from the host application is down to the implementation of the onEvent method.
参考
:kl-ref:``, EventHandler, HandlerDispatcher, Tool
Members¶
Boolean | enabled | Handler is enabled. |
Key | enableKey | Enable key. |
HandlerExclusivity | handlerExclusivity | Handler exclusivity. |
Boolean | isIndependent | HandlerExclusivity local override. |
Boolean | takeAllEvents | It true, the handler takes all the events. |
Boolean | alwaysEnabled | It true, the handler takes all the events. |
Boolean | isOwnedByDispatcher | Checks if the handler is owned by a handlerDispatcher. In most of the cases, the dispatcher owns the handlers. However, it’s not true in DFG graphs where the handlers are owns by the nodes. |
Ref<HandlerDispatcher> | dispatcher | Reference to the dispatcher. |
Methods¶
BaseHandler ( in BaseHandler other ) | |
BaseHandler ( in Key enableKey, in HandlerExclusivity exclusivity, in Boolean isIndependent, in Boolean takeAllEvents, in Boolean isOwnedByDispatcher ) | |
BaseHandler () | |
BaseHandler | clone ? () |
disable ! () | |
enable ! () | |
HandlerDescription | getDescription ? () |
Ref<HandlerDispatcher> | getDispatcher ? () |
Key | getEnableKey ? () |
HandlerExclusivity | getExclusivity ? () |
Boolean | hasKey ? ( in Key key ) |
init ! ( in Key enableKey, in HandlerExclusivity exclusivity, in Boolean isIndependent, in Boolean takeAllEvents, in Boolean isOwnedByDispatcher ) | |
init ! ( in Key enableKey, in HandlerExclusivity exclusivity, in Boolean isOwnedByDispatcher ) | |
Boolean | isAlwaysEnabled ? () |
Boolean | isEnabled ? () |
Boolean | isIndependent ? () |
Boolean | isOwnedByDispatcher ? () |
onEvent ! ( io BaseEvent baseEvent ) | |
onEvent ! ( io Event event ) | |
setAlwaysEnabled ! ( in Boolean alwaysEnabled ) | |
setDispatcher ! ( in Ref<HandlerDispatcher> dispatcher ) | |
setEnableKey ! ( in Key key ) | |
setExclusivity ! ( in HandlerExclusivity handlerExclusivity ) | |
setIndependent ! ( in Boolean independent ) | |
setTakeAllEvents ! ( in Boolean takeAllEvents ) | |
Boolean | takeAllEvents ? () |
~BaseHandler () |