org.openbp.jaspira.plugins.statusbar
Class StatusBarPlugin.Events

java.lang.Object
  org.openbp.jaspira.plugin.EventModule
      org.openbp.jaspira.plugins.statusbar.StatusBarPlugin.Events

All Implemented Interfaces:

JaspiraEventListener

Enclosing class:

StatusBarPlugin

public class StatusBarPlugin.Events
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

StatusBarPlugin.Events()

Method Summary

JaspiraEventHandlerCode	busy(JaspiraEvent je) Event handler: Starts the status bar's busy animation.
int	getModuleType() The module type determines the way the events of this module are handled.
java.lang.String	getName() The name of this module like "editor.file".
JaspiraEventHandlerCode	managecomponent(StatusBarComponentEvent event) Event handler: Manage status bar components.
JaspiraEventHandlerCode	step(JaspiraEvent je) Event handler: Shows the given progress in the progress indicator of the status bar.
JaspiraEventHandlerCode	unbusy(JaspiraEvent je) Event handler: Stops the status bar's busy animation.
JaspiraEventHandlerCode	updatetext(StatusBarTextEvent event) Event handler: Updates the message text of the statusbar.

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

eventFired, getEventActionNames, getForeignEventNames, getPriority, handleUnaccountedEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusBarPlugin.Events

public StatusBarPlugin.Events()

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

getModuleType

public int getModuleType()

The module type determines the way the events of this module are handled.

Overrides:

getModuleType in class EventModule

Returns:

EventModule.MODULE_PRE_GLOBAL
Events of this module should always be handled on a global basis right away

updatetext

public JaspiraEventHandlerCode updatetext(StatusBarTextEvent event)

Event handler: Updates the message text of the statusbar.

Parameters:

event - Event

Returns:

The event status code

busy

public JaspiraEventHandlerCode busy(JaspiraEvent je)

Event handler: Starts the status bar's busy animation.

Parameters:

je - Event

Returns:

The event status code

unbusy

public JaspiraEventHandlerCode unbusy(JaspiraEvent je)

Event handler: Stops the status bar's busy animation.

Parameters:

je - Event

Returns:

The event status code

step

public JaspiraEventHandlerCode step(JaspiraEvent je)

Event handler: Shows the given progress in the progress indicator of the status bar.

Parameters:

je - Event

Returns:

The event status code

managecomponent

public JaspiraEventHandlerCode managecomponent(StatusBarComponentEvent event)

Event handler: Manage status bar components. Adds, removes or updates status bar components

Parameters:

event - Event

Returns:

The event status code