org.openbp.jaspira.plugin
Class AbstractPlugin.StandardPluginEvents

java.lang.Object
  org.openbp.jaspira.plugin.EventModule
      org.openbp.jaspira.plugin.AbstractPlugin.StandardPluginEvents

All Implemented Interfaces:

JaspiraEventListener

Enclosing class:

AbstractPlugin

public class AbstractPlugin.StandardPluginEvents
extends EventModule

Event module.

Field Summary

Fields inherited from class org.openbp.jaspira.plugin.EventModule

EVENT_CONSUMED, EVENT_HANDLED, EVENT_IGNORED, MODULE_POST_GLOBAL, MODULE_PRE_GLOBAL, MODULE_TREE

Constructor Summary

AbstractPlugin.StandardPluginEvents()

Method Summary

java.lang.String	getName() The name of this module like "editor.file".
JaspiraEventHandlerCode	global_askclose(VetoableEvent ve) Event handler: Checks if this plugin can be closed.
JaspiraEventHandlerCode	global_closecanceled(JaspiraEvent ve) Event handler: Called when the close operation has been vetoed by a plugin.
JaspiraEventHandlerCode	global_doclose(StackActionEvent ve) Event handler: Closes the plugin.
JaspiraEventHandlerCode	global_keyevent(KeySequenceEvent kse) Event handler: Receives key sequence events and passes them to the Plugin itself.

Methods inherited from class org.openbp.jaspira.plugin.EventModule

eventFired, getEventActionNames, getForeignEventNames, getModuleType, getPriority, handleUnaccountedEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractPlugin.StandardPluginEvents

public AbstractPlugin.StandardPluginEvents()

Method Detail

getName

public java.lang.String getName()

Description copied from class: EventModule

The name of this module like "editor.file". Decides which events will be received.

Specified by:

getName in class EventModule

global_askclose

public JaspiraEventHandlerCode global_askclose(VetoableEvent ve)

Event handler: Checks if this plugin can be closed.

Parameters:

ve - Event

Returns:

The event status code

global_doclose

public JaspiraEventHandlerCode global_doclose(StackActionEvent ve)

Event handler: Closes the plugin.

Parameters:

ve - Event

Returns:

The event status code

global_closecanceled

public JaspiraEventHandlerCode global_closecanceled(JaspiraEvent ve)

Event handler: Called when the close operation has been vetoed by a plugin.

Parameters:

ve - Event

Returns:

The event status code

global_keyevent

public JaspiraEventHandlerCode global_keyevent(KeySequenceEvent kse)

Event handler: Receives key sequence events and passes them to the Plugin itself.

Parameters:

kse - Event

Returns:

The event status code
Consumes the key event if the sequence can be handled by this plugin.