org.jsynthlib.device.viewcontroller

Class PatchEditorFrame

java.lang.Object

org.jsynthlib.core.viewcontroller.desktop.JSLFrame

org.jsynthlib.device.viewcontroller.PatchEditorFrame

All Implemented Interfaces:

PatchHandler

Direct Known Subclasses:

AlesisDM5PrChgEditor, AlesisDM5SgSetEditor, AlesisDM5SysInfoEditor, AlesisDM5TrSetEditor, CasioCZ1000SingleEditor, D50SingleEditor, DX7FamilyAdditionalVoiceEditor, DX7FamilyFractionalScalingEditor, DX7FamilyMicroTuningEditor, DX7FamilyPerformanceEditor, DX7FamilyPerformanceIIEditor, DX7FamilyPerformanceIIIEditor, DX7FamilySystemSetupIIEditor, DX7FamilySystemSetupIIIEditor, DX7FamilyVoiceEditor, EmuProteus2SingleEditor, FCB1010Editor, JSLDriverEditorFrame, Line6BassPodSingleEditor, Line6Pod20SingleEditor, QuasimidiQuasarSingleEditor, RolandD10EditorFrame, RolandJV80PatchEditor, RolandJV80PerformanceEditor, RolandJV80SystemSetupEditor, SPD11ChainEditor, SPD11PadEditor, SPD11Patch2Editor, SPD11SettingsEditor, VAmp2Editor, YamahaCS2xCommonEditor, YamahaCS2xLayerEditor, YamahaMotifNormalVoiceEditor, YamahaTG100SingleEditor

public class PatchEditorFrame
extends JSLFrame
implements PatchHandler

A base class of a patch editor.

Version:

$Id: PatchEditorFrame.java 1120 2011-09-05 00:49:58Z billzwicky $

Author:

???

Field Summary

Fields

Modifier and Type	Field and Description
protected BankEditorFrame	bankFrame Information about BankEditorFrame which created this PatchEditor frame (if applicable) so we can update that frame with the edited data on close.
protected int	forceLabelWidth For Alignment, a size to scrollbar labels, zero disables
protected GridBagConstraints	gbc Note that calling addWidget() method may change the value of this.
protected Patch	p This is the patch we are working on.
protected JPanel	scrollPane Scroll Pane for the editor frame.
protected ArrayList	widgetList A list of widget added by addWidget method.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PatchEditorFrame(String name, Patch patch) Creates a new PatchEditorFrame instance.
protected	PatchEditorFrame(String name, Patch patch, JPanel panel)

Method Summary

Modifier and Type	Method and Description
protected void	addWidget(JComponent parent, SysexWidget widget, int gridx, int gridy, int gridwidth, int gridheight, int slidernum) Add SysexWidget widget to JComponent parent by using specified GridBagConstraints.
protected void	addWidget(JComponent parent, SysexWidget widget, int gridx, int gridy, int gridwidth, int gridheight, int anchor, int fill, int slidernum) Add SysexWidget widget to JComponent parent by using specified GridBagConstraints.
protected void	addWidget(SysexWidget widget, int gridx, int gridy, int gridwidth, int gridheight, int slidernum) Add SysexWidget widget to scrollPane by using specified GridBagConstraints.
void	copySelectedPatch() Copy the selected patch.
JSLFrame	editSelectedPatch() Invoke an editor for the selected patch.
protected void	frameActivated() Called when the frame is activated.
protected void	frameClosing() Called when the frame is closed.
protected void	frameDeactivated() Called when the frame is deactivated.
protected void	frameOpened() Called when the frame is opened.
Patch	getPatch() return the Patch which is edited.
Patch	getSelectedPatch() Get the selected patch.
void	nextFader()
void	playSelectedPatch() Play the selected patch.
void	prevFader()
void	reassignSelectedPatch() Reassign the driver of the selected patch.
void	revalidateDriver()
void	sendSelectedPatch() Send the selected patch to the Edit buffer of the synth for the patch.
void	sendToSelectedPatch() Send the selected patch to the Edit buffer of the synth specified by user.
void	setBankEditorInformation(BankEditorFrame bf, int row, int col) Let bankeditorframe set information about itself when it creates a patch editor frame.
void	setVisible(boolean b) Shows or hides this component depending on the value of parameter b.
void	storeSelectedPatch() Send the selected patch to a buffer of the synth specified by user.

Methods inherited from class org.jsynthlib.core.viewcontroller.desktop.JSLFrame

addFocusListener, addJSLFrameListener, canImport, dispose, getAppConfig, getContentPane, getJFrame, getJInternalFrame, getJSLFrameListeners, getMinimumSize, getSize, getSize, getTitle, getX, getY, isClosing, isIcon, isSelected, isVisible, moveToDefaultLocation, moveToFront, pack, removeJSLFrameListener, repaint, setClosed, setJMenuBar, setLocation, setLocation, setSelected, setSize, setTitle

Methods inherited from class java.lang.Object

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

Field Detail

p

protected Patch p

This is the patch we are working on.

scrollPane

protected JPanel scrollPane

Scroll Pane for the editor frame.

gbc

protected GridBagConstraints gbc

Note that calling addWidget() method may change the value of this.

widgetList

protected ArrayList widgetList

A list of widget added by addWidget method.

forceLabelWidth

protected int forceLabelWidth

For Alignment, a size to scrollbar labels, zero disables

bankFrame

protected BankEditorFrame bankFrame

Information about BankEditorFrame which created this PatchEditor frame (if applicable) so we can update that frame with the edited data on close.

Constructor Detail

PatchEditorFrame

protected PatchEditorFrame(String name,
                           Patch patch)

Creates a new PatchEditorFrame instance.

Parameters:

name - a name to display in the title bar.

patch - a reference to ISinglePatch object stored in a patch library or a bank patch.

PatchEditorFrame

protected PatchEditorFrame(String name,
                           Patch patch,
                           JPanel panel)

Method Detail

setVisible

public void setVisible(boolean b)

Description copied from class: JSLFrame

Shows or hides this component depending on the value of parameter b.

Overrides:

setVisible in class JSLFrame

frameClosing

protected void frameClosing()

Called when the frame is closed. Default ask for keep changes. May be redefined in sub-classes.

frameOpened

protected void frameOpened()

Called when the frame is opened. May be redefined in sub-classes.

frameActivated

protected void frameActivated()

Called when the frame is activated. May be redefined in sub-classes.

frameDeactivated

protected void frameDeactivated()

Called when the frame is deactivated. May be redefined in sub-classes.

copySelectedPatch

public void copySelectedPatch()

Description copied from interface: PatchHandler

Copy the selected patch.

Specified by:

copySelectedPatch in interface PatchHandler

getSelectedPatch

public Patch getSelectedPatch()

Description copied from interface: PatchHandler

Get the selected patch.

Specified by:

getSelectedPatch in interface PatchHandler

sendSelectedPatch

public void sendSelectedPatch()

Description copied from interface: PatchHandler

Send the selected patch to the Edit buffer of the synth for the patch. Only for Single Patch.

Specified by:

sendSelectedPatch in interface PatchHandler

sendToSelectedPatch

public void sendToSelectedPatch()

Description copied from interface: PatchHandler

Send the selected patch to the Edit buffer of the synth specified by user. Only for Single Patch.

Specified by:

sendToSelectedPatch in interface PatchHandler

reassignSelectedPatch

public void reassignSelectedPatch()

Description copied from interface: PatchHandler

Reassign the driver of the selected patch.

Specified by:

reassignSelectedPatch in interface PatchHandler

playSelectedPatch

public void playSelectedPatch()

Description copied from interface: PatchHandler

Play the selected patch.

Specified by:

playSelectedPatch in interface PatchHandler

storeSelectedPatch

public void storeSelectedPatch()

Description copied from interface: PatchHandler

Send the selected patch to a buffer of the synth specified by user. Only for Single Patch.

Specified by:

storeSelectedPatch in interface PatchHandler

editSelectedPatch

public JSLFrame editSelectedPatch()

Description copied from interface: PatchHandler

Invoke an editor for the selected patch.

Specified by:

editSelectedPatch in interface PatchHandler

addWidget

protected void addWidget(JComponent parent,
                         SysexWidget widget,
                         int gridx,
                         int gridy,
                         int gridwidth,
                         int gridheight,
                         int anchor,
                         int fill,
                         int slidernum)

Add SysexWidget widget to JComponent parent by using specified GridBagConstraints.

Parameters:

parent - a parent JComponent to which widget is added.

widget - a SysexWidget to be added.

gridx - see GridBagConstraints.gridx.

gridy - see GridBagConstraints.gridy.

gridwidth - see GridBagConstraints.gridwidth.

gridheight - see GridBagConstraints.gridheight.

anchor - see GridBagConstraints.anchor.

fill - see GridBagConstraints.fill.

slidernum - a slider number. Only used by ScrollBar Widgets.

See Also:

GridBagConstraints

addWidget

protected void addWidget(JComponent parent,
                         SysexWidget widget,
                         int gridx,
                         int gridy,
                         int gridwidth,
                         int gridheight,
                         int slidernum)

Add SysexWidget widget to JComponent parent by using specified GridBagConstraints.

NORTHEAST is used for the anchor constraint and HORIZONTAL is used for the fill constraint.

addWidget

protected void addWidget(SysexWidget widget,
                         int gridx,
                         int gridy,
                         int gridwidth,
                         int gridheight,
                         int slidernum)

Add SysexWidget widget to scrollPane by using specified GridBagConstraints.

EAST is used for the anchor constraint and BOTH is used for the fill constraint.

nextFader

public void nextFader()

prevFader

public void prevFader()

setBankEditorInformation

public void setBankEditorInformation(BankEditorFrame bf,
                                     int row,
                                     int col)

Let bankeditorframe set information about itself when it creates a patch editor frame.

revalidateDriver

public void revalidateDriver()

getPatch

public Patch getPatch()

return the Patch which is edited.