org.barrelorgandiscovery.gui.aprintng.helper

Class BaseVirtualBookExtension

java.lang.Object

org.barrelorgandiscovery.gui.aprintng.helper.BaseExtension

org.barrelorgandiscovery.gui.aprintng.helper.BaseVirtualBookExtension

All Implemented Interfaces:

IExtension, IExtensionPoint, HelpMenuItemsExtensionPoint, InformCurrentInstrumentExtensionPoint, InformCurrentVirtualBookExtensionPoint, LayersExtensionPoint, OptionMenuItemsExtensionPoint, ToolbarAddExtensionPoint, InformVirtualBookFrameExtensionPoint, InitNGExtensionPoint, VirtualBookFrameExtensionPoints

Direct Known Subclasses:

CADExporterExtensionVirtualBook, RecognitionVirtualBookExtensionWindow

public abstract class BaseVirtualBookExtension
extends BaseExtension
implements VirtualBookFrameExtensionPoints, ToolbarAddExtensionPoint, InformCurrentInstrumentExtensionPoint, InformCurrentVirtualBookExtensionPoint, LayersExtensionPoint, InformVirtualBookFrameExtensionPoint

Class For Ease VirtualBook Extensions

Field Summary

Fields

Modifier and Type	Field and Description
protected APrintNGVirtualBookFrame	currentFrame Frame of the VirtualBook, for getting frame services
protected Instrument	currentInstrument Current Virtual Book Window Instrument
protected VirtualBook	currentVirtualBook Current Virtual Book Reference

Fields inherited from class org.barrelorgandiscovery.gui.aprintng.helper.BaseExtension

application, defaultAboutAuthor, defaultAboutVersion, extensionPreferences, extspts

Constructor Summary

Constructors

Constructor and Description
BaseVirtualBookExtension() Constructor

Method Summary

Modifier and Type	Method and Description
abstract void	addLayers(JVirtualBookScrollableComponent c) Override this method to add new layer on the book component
abstract javax.swing.JToolBar[]	addToolBars() Override this method to add a new toolbar to the virtualbook window
protected javax.swing.JButton	createGroovyButton(groovy.lang.Closure closure, java.awt.Image icon, java.lang.String text) Internal method for ease the creation of a groovy script based button
void	informCurrentInstrument(Instrument instrument)
void	informCurrentVirtualBook(VirtualBook vb) This method is called by aprint to pass the virtual book reference, this permit the extension to know what is the currently displayed book.
void	informVirtualBookFrame(APrintNGVirtualBookFrame frame) this extension inform virtualbook extensions of the frame services
IExtension	newExtension() get a New extension instance for the Virtualbook Frame
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 org.barrelorgandiscovery.gui.aprintng.helper.BaseExtension

addHelpMenuItem, addOptionMenuItem, createAboutForm, createExtensionPoint, createExtensionPoint, getExtensionPoints, getName, init

Methods inherited from class java.lang.Object

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

Field Detail

currentInstrument

protected Instrument currentInstrument

Current Virtual Book Window Instrument

currentVirtualBook

protected VirtualBook currentVirtualBook

Current Virtual Book Reference

currentFrame

protected APrintNGVirtualBookFrame currentFrame

Frame of the VirtualBook, for getting frame services

Constructor Detail

BaseVirtualBookExtension

public BaseVirtualBookExtension()
                         throws java.lang.Exception

Constructor

Throws:

java.lang.Exception

Method Detail

setupExtensionPoint

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

Description copied from class: BaseExtension

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

Overrides:

setupExtensionPoint in class BaseExtension

Throws:

java.lang.Exception

newExtension

public IExtension newExtension()

Description copied from interface: VirtualBookFrameExtensionPoints

get a New extension instance for the Virtualbook Frame

Specified by:

newExtension in interface VirtualBookFrameExtensionPoints

Returns:

informCurrentVirtualBook

public void informCurrentVirtualBook(VirtualBook vb)

Description copied from interface: InformCurrentVirtualBookExtensionPoint

This method is called by aprint to pass the virtual book reference, this permit the extension to know what is the currently displayed book. You can also make modifications on the virtual book before using in the software

Specified by:

informCurrentVirtualBook in interface InformCurrentVirtualBookExtensionPoint

informCurrentInstrument

public void informCurrentInstrument(Instrument instrument)

Specified by:

informCurrentInstrument in interface InformCurrentInstrumentExtensionPoint

informVirtualBookFrame

public void informVirtualBookFrame(APrintNGVirtualBookFrame frame)

Description copied from interface: InformVirtualBookFrameExtensionPoint

this extension inform virtualbook extensions of the frame services

Specified by:

informVirtualBookFrame in interface InformVirtualBookFrameExtensionPoint

addLayers

public abstract void addLayers(JVirtualBookScrollableComponent c)

Override this method to add new layer on the book component

Specified by:

addLayers in interface LayersExtensionPoint

addToolBars

public abstract javax.swing.JToolBar[] addToolBars()

Override this method to add a new toolbar to the virtualbook window

Specified by:

addToolBars in interface ToolbarAddExtensionPoint

createGroovyButton

protected javax.swing.JButton createGroovyButton(groovy.lang.Closure closure,
                                                 java.awt.Image icon,
                                                 java.lang.String text)

Internal method for ease the creation of a groovy script based button

Parameters:

closure - closure to be launch with a hash in parameter containing the variable accessible (pianoroll, currentinstrument, virtualbook)

icon - the icon of the button

text - the text of the command

Returns:

the created button