org.barrelorgandiscovery.gui.aprintng.helper

Class BaseExtension

java.lang.Object

org.barrelorgandiscovery.gui.aprintng.helper.BaseExtension

All Implemented Interfaces:

IExtension, IExtensionPoint, HelpMenuItemsExtensionPoint, OptionMenuItemsExtensionPoint, InitNGExtensionPoint

Direct Known Subclasses:

APrintDiskRecognitionExtension, APrintRecognitionExtension, BaseVirtualBookExtension, PerfoExtensionMachine, ScannerExtension

public abstract class BaseExtension
extends java.lang.Object
implements IExtension, HelpMenuItemsExtensionPoint, InitNGExtensionPoint, OptionMenuItemsExtensionPoint

Base extension for aprintng, provide the loading / plugin, about action provide also a preference configuration for the extension.

Field Summary

Fields

Modifier and Type	Field and Description
protected APrintNG	application Application reference
protected java.lang.String	defaultAboutAuthor Default informations on the author
protected java.lang.String	defaultAboutVersion Default information on the version of the extension (for the about form)
protected IPrefsStorage	extensionPreferences Object permitting to save extension properties and user preferences, saving a lot of time for the user
protected ExtensionPoint[]	extspts

Constructor Summary

Constructors

Constructor and Description
BaseExtension() Constructor

Method Summary

Modifier and Type	Method and Description
void	addHelpMenuItem(javax.swing.JMenu helpMenu) Override an add wished help Menu commands (about for example)
void	addOptionMenuItem(javax.swing.JMenu options) Override this method for permitting adding elements in the option menu
protected javax.swing.JPanel	createAboutForm(java.awt.event.ActionListener okActionListener) Default method for creating the about panel
protected ExtensionPoint	createExtensionPoint(java.lang.Class extensionPoint) Helper method for creating a new Hook Registration for the extension the implementation is the class itself
protected ExtensionPoint	createExtensionPoint(java.lang.Class extensionPoint, java.lang.Object classImplementing) Helper method for creating a new hook,
ExtensionPoint[]	getExtensionPoints() Extension points
abstract java.lang.String	getName() Override this method for giving a name to the extension
void	init(APrintNG f) base implementation of the extension initialization, this implementation create a user preference store for the extension (permit the extension to store specific user parameters) ie : extensionPreferences
protected void	setupExtensionPoint(java.util.List<ExtensionPoint> initExtensionPoints) At the Extension startup, this method is called for creating extension points Method permitting to create new hook in derived classes

Methods inherited from class java.lang.Object

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

Field Detail

extspts

protected ExtensionPoint[] extspts

application

protected APrintNG application

Application reference

extensionPreferences

protected IPrefsStorage extensionPreferences

Object permitting to save extension properties and user preferences, saving a lot of time for the user

defaultAboutAuthor

protected java.lang.String defaultAboutAuthor

Default informations on the author

defaultAboutVersion

protected java.lang.String defaultAboutVersion

Default information on the version of the extension (for the about form)

Constructor Detail

BaseExtension

public BaseExtension()
              throws java.lang.Exception

Constructor

Throws:

java.lang.Exception

Method Detail

setupExtensionPoint

protected void setupExtensionPoint(java.util.List<ExtensionPoint> initExtensionPoints)
                            throws java.lang.Exception

At the Extension startup, this method is called for creating extension points Method permitting to create new hook in derived classes

Parameters:

initExtensionPoints -

Throws:

java.lang.Exception

createExtensionPoint

protected ExtensionPoint createExtensionPoint(java.lang.Class extensionPoint)
                                       throws java.lang.Exception

Helper method for creating a new Hook Registration for the extension the implementation is the class itself

Parameters:

extensionPoint -

Returns:

Throws:

java.lang.Exception

createExtensionPoint

protected ExtensionPoint createExtensionPoint(java.lang.Class extensionPoint,
                                              java.lang.Object classImplementing)
                                       throws java.lang.Exception

Helper method for creating a new hook,

Parameters:

extensionPoint -

classImplementing -

Returns:

Throws:

java.lang.Exception

getExtensionPoints

public ExtensionPoint[] getExtensionPoints()

Description copied from interface: IExtension

Extension points

Specified by:

getExtensionPoints in interface IExtension

Returns:

the array of the extension points implemented by the extension

init

public void init(APrintNG f)

base implementation of the extension initialization, this implementation create a user preference store for the extension (permit the extension to store specific user parameters) ie : extensionPreferences

Specified by:

init in interface InitNGExtensionPoint

getName

public abstract java.lang.String getName()

Override this method for giving a name to the extension

Specified by:

getName in interface IExtension

addHelpMenuItem

public void addHelpMenuItem(javax.swing.JMenu helpMenu)

Override an add wished help Menu commands (about for example)

Specified by:

addHelpMenuItem in interface HelpMenuItemsExtensionPoint

addOptionMenuItem

public void addOptionMenuItem(javax.swing.JMenu options)

Override this method for permitting adding elements in the option menu

Specified by:

addOptionMenuItem in interface OptionMenuItemsExtensionPoint

createAboutForm

protected javax.swing.JPanel createAboutForm(java.awt.event.ActionListener okActionListener)
                                      throws java.lang.Exception

Default method for creating the about panel

Returns:

Throws:

java.lang.Exception