org.midica.ui.player.soundcheck

Class SoundcheckController

java.lang.Object

org.midica.ui.player.soundcheck.SoundcheckController

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.ItemListener, java.awt.event.MouseWheelListener, java.awt.event.WindowListener, java.util.EventListener, javax.swing.event.ChangeListener, javax.swing.event.DocumentListener, javax.swing.event.ListSelectionListener, javax.swing.event.RowSorterListener

public class SoundcheckController
extends java.lang.Object
implements java.awt.event.ActionListener, javax.swing.event.ListSelectionListener, java.awt.event.ItemListener, javax.swing.event.ChangeListener, java.awt.event.MouseWheelListener, javax.swing.event.DocumentListener, java.awt.event.WindowListener, javax.swing.event.RowSorterListener

This class provides the controller and event listener for the soundcheck window. It’s implemented as a singleton.

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
private static SoundcheckController	controller
private static int	DEFAULT_NOTE_NUM
private static int	DEFAULT_PERCUSSION_NUM
private static SoundcheckInstrumentModel	instrumentModel
private static SoundcheckNoteModel	noteModel
private static java.util.TreeMap<java.lang.Integer,java.lang.Integer>	selectedInstrumentRow
private static java.util.TreeMap<java.lang.Integer,java.util.TreeMap<java.lang.Boolean,java.lang.Integer>>	selectedNoteRow
private static SoundcheckView	view

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SoundcheckController() The actual constructor - private in order to enforce singleton behaviour.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Action listener for the soundcheck window.
void	changedUpdate(javax.swing.event.DocumentEvent e) Called if one of the text fields has been changed.
private void	checkDurationField() Checks if the duration textfield contains a usable string.
private void	checkVolOrVelField(java.lang.String type) Checks if the volume or velocity textfield contains a usable string.
private void	fillInstrumentsTable() (Re)fills the instruments/drumkits table according to the currently selected channel.
private void	fillNoteTable() (Re)fills the note/percussion table according to the currently selected instrument type.
static int	getChannel() Returns the currently selected channel.
static SoundcheckController	getController() Returns the singleton SoundcheckController object.
static SoundcheckController	getController(SoundcheckView scView, SoundcheckNoteModel scNoteModel, SoundcheckInstrumentModel scInstrModel) Creates a SoundcheckController object by calling the private constructor, if not yet done.
int[]	getInstrument() Returns the currently (or last) selected instrument coordinates from the instruments combobox.
static int	getLastSelectedInstrumentTableRow(int channel) Returns the last (remembered) selected table model index of the given channel.
int	getNote() Returns the currently selected note (or percussion instrument) from the note/percussion table.
private void	handleTextFieldChanges(javax.swing.event.DocumentEvent e) Called if a text field value changes by one of the according event handlers.
void	insertUpdate(javax.swing.event.DocumentEvent e) Called if one of the text fields has been changed.
void	itemStateChanged(java.awt.event.ItemEvent event) Combobox selection listener for the channel combobox.
void	mouseWheelMoved(java.awt.event.MouseWheelEvent e) Handles volume or velocity slider scrolls with the mouse wheel.
private void	play() Plays the customized sound.
void	removeUpdate(javax.swing.event.DocumentEvent e) Called if one of the text fields has been changed.
void	sorterChanged(javax.swing.event.RowSorterEvent e) Scrolls to the currently selected instruments table row, if possible.
void	stateChanged(javax.swing.event.ChangeEvent e) Handles volume or velocity slider changes via mouse clicks.
void	valueChanged(javax.swing.event.ListSelectionEvent event) Handles selections of instruments or notes.
void	windowActivated(java.awt.event.WindowEvent e)
void	windowClosed(java.awt.event.WindowEvent e)
void	windowClosing(java.awt.event.WindowEvent e)
void	windowDeactivated(java.awt.event.WindowEvent e)
void	windowDeiconified(java.awt.event.WindowEvent e)
void	windowIconified(java.awt.event.WindowEvent e)
void	windowOpened(java.awt.event.WindowEvent e) Fills the instruments table and the notes list (in the right order) and ensures that in both of them one element is selected.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_NOTE_NUM

private static final int DEFAULT_NOTE_NUM

See Also:

Constant Field Values

DEFAULT_PERCUSSION_NUM

private static final int DEFAULT_PERCUSSION_NUM

See Also:

Constant Field Values

controller

private static SoundcheckController controller

view

private static SoundcheckView view

noteModel

private static SoundcheckNoteModel noteModel

instrumentModel

private static SoundcheckInstrumentModel instrumentModel

selectedInstrumentRow

private static java.util.TreeMap<java.lang.Integer,java.lang.Integer> selectedInstrumentRow

selectedNoteRow

private static java.util.TreeMap<java.lang.Integer,java.util.TreeMap<java.lang.Boolean,java.lang.Integer>> selectedNoteRow

Constructor Detail

SoundcheckController

private SoundcheckController()

The actual constructor - private in order to enforce singleton behaviour.

Method Detail

getController

public static SoundcheckController getController(SoundcheckView scView,
                                                 SoundcheckNoteModel scNoteModel,
                                                 SoundcheckInstrumentModel scInstrModel)

Creates a SoundcheckController object by calling the private constructor, if not yet done. Returns the object.

This method is called from outside instead of the constructor itself in order to ensure the singleton behaviour.

Parameters:

scView - Soundcheck window.

scNoteModel - Note combobox model.

scInstrModel - Instruments table model.

Returns:

a singleton SoundcheckController object.

getController

public static SoundcheckController getController()

Returns the singleton SoundcheckController object.

Returns:

SoundcheckController object.

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent event)

Combobox selection listener for the channel combobox. Refills the instruments table based on the new channel and pre-selects the last selected row for this channel.

Specified by:

itemStateChanged in interface java.awt.event.ItemListener

Parameters:

event - selection change event

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Action listener for the soundcheck window.

Handles:

• clicks on the play button
• changes of the ‘keep settings’ checkbox
• pressing Enter in one of the text fields

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - The event to be handled.

sorterChanged

public void sorterChanged(javax.swing.event.RowSorterEvent e)

Scrolls to the currently selected instruments table row, if possible. Called when the table string filter or sorter has been changed.

Specified by:

sorterChanged in interface javax.swing.event.RowSorterListener

Parameters:

e - the row sorter event

getLastSelectedInstrumentTableRow

public static int getLastSelectedInstrumentTableRow(int channel)

Returns the last (remembered) selected table model index of the given channel.

Parameters:

channel - The requested channel.

Returns:

last selected table (model) row.

getInstrument

public int[] getInstrument()

Returns the currently (or last) selected instrument coordinates from the instruments combobox.

The returned value consists of the following parts:

• program number
• bank MSB
• bank LSB

If no instrument is selected, all these values are -1.

Returns:

program number, bank MSB and bank LSB of the selected instrument.

getNote

public int getNote()

Returns the currently selected note (or percussion instrument) from the note/percussion table.

In case of an error, -1 is returned.

Returns:

the currently selected note or percussion number or -1 on error.

play

private void play()

Plays the customized sound.

checkVolOrVelField

private void checkVolOrVelField(java.lang.String type)
                         throws java.lang.NumberFormatException

Checks if the volume or velocity textfield contains a usable string.

If the check succeeds: sets the volume/velocity slider according to the value from the text field.

Parameters:

type - volume or velocity, depending on the field to be checked.

Throws:

java.lang.NumberFormatException - if the field cannot be used as a volume/velocity value.

checkDurationField

private void checkDurationField()
                         throws java.lang.NumberFormatException

Checks if the duration textfield contains a usable string.

Throws:

java.lang.NumberFormatException - if the field cannot be used as a duration value.

stateChanged

public void stateChanged(javax.swing.event.ChangeEvent e)

Handles volume or velocity slider changes via mouse clicks. Sets the volume or velocity text field’s content to the new value.

Specified by:

stateChanged in interface javax.swing.event.ChangeListener

Parameters:

e - The event to be handled.

mouseWheelMoved

public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)

Handles volume or velocity slider scrolls with the mouse wheel. Sets the volume or velocity text field’s content to the new value.

Specified by:

mouseWheelMoved in interface java.awt.event.MouseWheelListener

Parameters:

e - The event to be handled.

changedUpdate

public void changedUpdate(javax.swing.event.DocumentEvent e)

Called if one of the text fields has been changed.

Passes the event to handleTextFieldChanges(DocumentEvent) in order to check the content and adjust the background color.

Specified by:

changedUpdate in interface javax.swing.event.DocumentListener

Parameters:

e - The event to be handled.

insertUpdate

public void insertUpdate(javax.swing.event.DocumentEvent e)

Called if one of the text fields has been changed.

Passes the event to handleTextFieldChanges(DocumentEvent) in order to check the content and adjust the background color.

Specified by:

insertUpdate in interface javax.swing.event.DocumentListener

Parameters:

e - The event to be handled.

removeUpdate

public void removeUpdate(javax.swing.event.DocumentEvent e)

Called if one of the text fields has been changed.

Passes the event to handleTextFieldChanges(DocumentEvent) in order to check the content and adjust the background color.

Specified by:

removeUpdate in interface javax.swing.event.DocumentListener

Parameters:

e - The event to be handled.

handleTextFieldChanges

private void handleTextFieldChanges(javax.swing.event.DocumentEvent e)

Called if a text field value changes by one of the according event handlers. Checks the content of the changed field and adjusts the background color according to the check result.

Parameters:

e - The event to be handled.

windowActivated

public void windowActivated(java.awt.event.WindowEvent e)

Specified by:

windowActivated in interface java.awt.event.WindowListener

windowClosed

public void windowClosed(java.awt.event.WindowEvent e)

Specified by:

windowClosed in interface java.awt.event.WindowListener

windowClosing

public void windowClosing(java.awt.event.WindowEvent e)

Specified by:

windowClosing in interface java.awt.event.WindowListener

windowDeactivated

public void windowDeactivated(java.awt.event.WindowEvent e)

Specified by:

windowDeactivated in interface java.awt.event.WindowListener

windowDeiconified

public void windowDeiconified(java.awt.event.WindowEvent e)

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

windowIconified

public void windowIconified(java.awt.event.WindowEvent e)

Specified by:

windowIconified in interface java.awt.event.WindowListener

windowOpened

public void windowOpened(java.awt.event.WindowEvent e)

Fills the instruments table and the notes list (in the right order) and ensures that in both of them one element is selected.

Specified by:

windowOpened in interface java.awt.event.WindowListener

Parameters:

e - event

valueChanged

public void valueChanged(javax.swing.event.ListSelectionEvent event)

Handles selections of instruments or notes.

Instruments or drumkits are selected from a MidicaTable. Notes or percussion instruments are selected from a JList.

Specified by:

valueChanged in interface javax.swing.event.ListSelectionListener

Parameters:

event - Table row or list item selection event.

getChannel

public static int getChannel()

Returns the currently selected channel.

Returns:

the currently selected channel

fillInstrumentsTable

private void fillInstrumentsTable()

(Re)fills the instruments/drumkits table according to the currently selected channel.

fillNoteTable

private void fillNoteTable()

(Re)fills the note/percussion table according to the currently selected instrument type.