org.openbp.cockpit
Class Cockpit.HelpEvents

java.lang.Object
  org.openbp.jaspira.plugin.EventModule
      org.openbp.cockpit.Cockpit.HelpEvents

All Implemented Interfaces:

JaspiraEventListener

Enclosing class:

Cockpit

public class Cockpit.HelpEvents
extends EventModule

This event module containts event handlers for the implementation of functions of the help menu.

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

Cockpit.HelpEvents()

Method Summary

JaspiraEventHandlerCode	cockpit_help_javaapi(JaspiraActionEvent je) Event handler: Display the Java API documentation as HTML.
JaspiraEventHandlerCode	cockpit_help_manual(JaspiraActionEvent je) Event handler: Display the help overview as PDF document.
java.lang.String	getName() The name of this module like "editor.file".

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

Cockpit.HelpEvents

public Cockpit.HelpEvents()

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

cockpit_help_manual

public JaspiraEventHandlerCode cockpit_help_manual(JaspiraActionEvent je)

Event handler: Display the help overview as PDF document.

Parameters:

je - Event

Returns:

The event status code

cockpit_help_javaapi

public JaspiraEventHandlerCode cockpit_help_javaapi(JaspiraActionEvent je)

Event handler: Display the Java API documentation as HTML.

Parameters:

je - Event

Returns:

The event status code