org.openbp.jaspira.plugins
Class AboutBoxPlugin

java.lang.Object
  org.openbp.jaspira.plugin.AbstractPlugin
      org.openbp.jaspira.gui.plugin.AbstractVisiblePlugin
          org.openbp.jaspira.plugins.AboutBoxPlugin

All Implemented Interfaces:

java.awt.event.HierarchyListener, java.util.EventListener, VisiblePlugin, Plugin

Direct Known Subclasses:

CockpitAboutBox

public abstract class AboutBoxPlugin
extends AbstractVisiblePlugin

This Plugin is a simple AboutBoxPlugin.

Author:

Jens Ferchland

Nested Class Summary

Nested classes/interfaces inherited from class org.openbp.jaspira.gui.plugin.AbstractVisiblePlugin

AbstractVisiblePlugin.StandardVisiblePluginEvents

Nested classes/interfaces inherited from class org.openbp.jaspira.plugin.AbstractPlugin

AbstractPlugin.StandardPluginEvents

Field Summary

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

PROPERTY_CONDITION, PROPERTY_DESCRIPTION, PROPERTY_ICON, PROPERTY_NAME, PROPERTY_SEQUENCE, PROPERTY_TITLE, PROPERTY_VENDOR, PROPERTY_VERSION

Fields inherited from interface org.openbp.jaspira.gui.plugin.VisiblePlugin

GER, GEU, SIZE_VARIABLE_BOTH, SIZE_VARIABLE_HEIGHT, SIZE_VARIABLE_NONE, SIZE_VARIABLE_WIDTH, TOOLBAR_DYNAMIC, TOOLBAR_EVENTS, TOOLBAR_NONE

Fields inherited from interface org.openbp.jaspira.plugin.Plugin

ID_DELIMETER, LEVEL_APPLICATION, LEVEL_FRAME, LEVEL_PAGE, LEVEL_PLUGIN

Constructor Summary

AboutBoxPlugin()

Method Summary

protected javax.swing.Icon	getAboutIcon() Returns the icon that is displayed in the about box.
javax.swing.JPanel	getContentPane() This method isn't allowed for adding somthing to the aboutbox.
protected java.awt.Component	getCopyrightComponent() Returns a component containing the copyright information or null.
protected java.awt.Component	getLicenseComponent() Returns a component containing the license information or null.
protected java.lang.String	getText() Returns the text that has to be displayed in the about box.
protected java.awt.Component	getUserComponent() To add your own content override this method.
protected void	initializeComponents() This template method is called after internal Components (i\.e\. title bar etc\.)

Methods inherited from class org.openbp.jaspira.gui.plugin.AbstractVisiblePlugin

addPluginFocusListener, applicationReady, canCopy, canCut, canDelete, canDrag, canPageChange, canPaste, copy, createToolbar, cut, delete, firePluginFocusGained, firePluginFocusLost, focusPlugin, getPage, getPluginComponent, getPluginFocusComponent, getPluginFromComponentHierarchy, getPluginHolder, getPluginPanel, getSizeBehavior, getSubClients, getToolbarType, hasCloseButton, hierarchyChanged, initializeResources, installPlugin, installPluginContent, isPluginFocused, isPluginVisible, paste, pluginHidden, pluginShown, postPluginContainerUpdate, removePluginFocusListener, setPluginHolder, showPlugin, stackEvent, uninstallPlugin, updatePluginContainer

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

addActionKeySequence, addPlugin, addToPeerGroup, canClose, closeCanceled, containsStackedEvent, fireEvent, fireEvent, fireEvent, getAction, getChildPlugins, getClassName, getCondition, getDescendantPlugins, getDescription, getEventActionNames, getEventModules, getExternalActions, getExternalEventModuleClasses, getExternalOptionModuleClasses, getIcon, getIcon, getLevel, getName, getOptionModules, getParentPlugin, getPeerGroup, getPeerGroupNames, getPeerGroups, getPluginResourceCollection, getPluginState, getResourceCollectionContainerName, getSubTitle, getTitle, getUniqueId, getVendor, getVersion, handleEvent, handleKeySequence, inheritEvent, initializeFromPluginProfile, initializePlugin, installFirstPlugin, matchesPeerGroup, matchesPeerGroups, passDown, pluginInstalled, pluginUninstalled, preClose, receiveEvent, removeFromPeerGroup, removePlugin, removeStackedEvent, requestClose, setDescription, setIcon, setName, setParentPlugin, setPluginState, setResourceCollection, setTitle, toString, uninstallLastPlugin

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openbp.jaspira.plugin.Plugin

addPlugin, addToPeerGroup, canClose, containsStackedEvent, fireEvent, fireEvent, fireEvent, getAction, getChildPlugins, getClassName, getCondition, getDescendantPlugins, getDescription, getEventActionNames, getIcon, getLevel, getName, getParentPlugin, getPeerGroup, getPeerGroupNames, getPeerGroups, getPluginResourceCollection, getPluginState, getSubTitle, getTitle, getUniqueId, getVendor, getVersion, handleEvent, inheritEvent, initializePlugin, installFirstPlugin, matchesPeerGroup, matchesPeerGroups, receiveEvent, removeFromPeerGroup, removePlugin, requestClose, setParentPlugin, setPluginState, uninstallLastPlugin

Constructor Detail

AboutBoxPlugin

public AboutBoxPlugin()

Method Detail

initializeComponents

protected void initializeComponents()

Description copied from class: AbstractVisiblePlugin

This template method is called after internal Components (i\.e\. title bar etc\.) have been initialized. It shoud be used to initialize plugin specific components.

Specified by:

initializeComponents in class AbstractVisiblePlugin

getUserComponent

protected java.awt.Component getUserComponent()

To add your own content override this method. If you don't override this the aboutbox will be generated using getText() and getIcon ().

Returns:

The user component or null of the default content

getText

protected java.lang.String getText()

Returns the text that has to be displayed in the about box.

Returns:

The default implementation returns the text taken from the resource file of the plugin using the resource key "about.text"

getAboutIcon

protected javax.swing.Icon getAboutIcon()

Returns the icon that is displayed in the about box.

Returns:

The default implementation returns the text taken from the resource file of the plugin using the resource key "about.icon"

getCopyrightComponent

protected java.awt.Component getCopyrightComponent()

Returns a component containing the copyright information or null.

getLicenseComponent

protected java.awt.Component getLicenseComponent()

Returns a component containing the license information or null.

getContentPane

public javax.swing.JPanel getContentPane()

This method isn't allowed for adding somthing to the aboutbox. Use getUserComponent and return your content! It returns null.

Overrides:

getContentPane in class AbstractVisiblePlugin

Returns:

A panel that uses the border layout