org.openbp.jaspira.gui.plugin
Class AbstractVisiblePlugin.StandardVisiblePluginEvents

java.lang.Object
  org.openbp.jaspira.plugin.EventModule
      org.openbp.jaspira.gui.plugin.AbstractVisiblePlugin.StandardVisiblePluginEvents

All Implemented Interfaces:

JaspiraEventListener

Enclosing class:

AbstractVisiblePlugin

public class AbstractVisiblePlugin.StandardVisiblePluginEvents
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

AbstractVisiblePlugin.StandardVisiblePluginEvents()

Method Summary

java.lang.String	getName() The name of this module like "editor.file".
JaspiraEventHandlerCode	global_init_completed(JaspiraEvent je) Event handler: Called when the application initialization is complete.
JaspiraEventHandlerCode	global_page_askchange(VetoableEvent ve) Event handler: Called when a page is about to change.
JaspiraEventHandlerCode	global_plugin_addtocontainer(JaspiraEvent je) Event handler: Adds another plugin to the container of this plugin.
JaspiraEventHandlerCode	rebuild(JaspiraEvent je) Event handler: Called when a global environment rebuild is being performed.
JaspiraEventHandlerCode	update(JaspiraEvent je) Event handler: Called when a global environment update is being performed.

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

AbstractVisiblePlugin.StandardVisiblePluginEvents

public AbstractVisiblePlugin.StandardVisiblePluginEvents()

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

update

public JaspiraEventHandlerCode update(JaspiraEvent je)

Event handler: Called when a global environment update is being performed. This causes the plugin to rebuild its toolbar, if dynamic.

Parameters:

je - Event

Returns:

The event status code

rebuild

public JaspiraEventHandlerCode rebuild(JaspiraEvent je)

Event handler: Called when a global environment rebuild is being performed. This causes the plugin to rebuild its toolbar, if dynamic.

Parameters:

je - Event

Returns:

The event status code

global_page_askchange

public JaspiraEventHandlerCode global_page_askchange(VetoableEvent ve)

Event handler: Called when a page is about to change. Invokes the AbstractVisiblePlugin.canPageChange(org.openbp.jaspira.gui.plugin.JaspiraPage, org.openbp.jaspira.gui.plugin.JaspiraPage) method and vetoes the event if unsuccessful.

Parameters:

ve - Event

Returns:

The event status code

global_init_completed

public JaspiraEventHandlerCode global_init_completed(JaspiraEvent je)

Event handler: Called when the application initialization is complete.

Parameters:

je - Event

Returns:

The event status code

global_plugin_addtocontainer

public JaspiraEventHandlerCode global_plugin_addtocontainer(JaspiraEvent je)

Event handler: Adds another plugin to the container of this plugin. Consumes the event if successful.

Parameters:

je - Event

Returns:

The event status code