org.openbp.jaspira.plugin
Class ExternalInteractionModule

java.lang.Object
  org.openbp.jaspira.plugin.EventModule
      org.openbp.jaspira.plugin.ExternalEventModule
          org.openbp.jaspira.plugin.ExternalInteractionModule

All Implemented Interfaces:

JaspiraEventListener

Direct Known Subclasses:

ModelerInteractionModule

public abstract class ExternalInteractionModule
extends ExternalEventModule

Abstract super module for all external menu-, toolbar- and popup menu contributors. Override the event handling methods to implement handling.

Author:

Stephan Moritz

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

ExternalInteractionModule(Plugin plugin)
Constructor.

Method Summary

java.lang.String	getName() Get ths name of this interaction module.
JaspiraEventHandlerCode	popup(InteractionEvent ie) Standard event handler that is called when a popup menu is to be shown.
JaspiraEventHandlerCode	toolbar(InteractionEvent ie) Standard event handler that is called when a toolbar is (re-)generated.

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

getPlugin

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

ExternalInteractionModule

public ExternalInteractionModule(Plugin plugin)

Constructor.

Parameters:

plugin - The plugin this module is associated with

Method Detail

getName

public final java.lang.String getName()

Get ths name of this interaction module.

Specified by:

getName in class EventModule

Returns:

"global.interaction"

popup

public JaspiraEventHandlerCode popup(InteractionEvent ie)

Standard event handler that is called when a popup menu is to be shown. Override this to add your own actions to a popup menu.

Parameters:

ie - Event

Returns:

The event status code

toolbar

public JaspiraEventHandlerCode toolbar(InteractionEvent ie)

Standard event handler that is called when a toolbar is (re-)generated. Override this to add your own actions to the toolbar.

Parameters:

ie - Event

Returns:

The event status code