org.midica.ui

Class UiController

java.lang.Object

org.midica.ui.UiController

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.ItemListener, java.awt.event.WindowListener, java.util.EventListener

public class UiController
extends java.lang.Object
implements java.awt.event.ActionListener, java.awt.event.WindowListener, java.awt.event.ItemListener

This class provides the controller of the main window.

It listens and reacts to events in the UiView.

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
private AbcImporter	abcImporter
private AldaImporter	aldaImporter
static java.lang.String	CMD_CANCELED
static java.lang.String	CMD_COMBOBOX_CHANGED
static java.lang.String	CMD_FILE_CHOSEN
private java.io.File	currentFile
private java.lang.String	currentFilePurpose
private java.lang.String	currentFileType
private FileSelector	exportSelector
static java.lang.String	FILE_PURPOSE_EXPORT
static java.lang.String	FILE_PURPOSE_PARSE
private FileSelector	importSelector
private LilypondImporter	lyImporter
private MidiParser	midiParser
private MidicaPLParser	mplParser
private MusescoreImporter	mscoreImporter
private PlayerView	player
private SoundbankParser	soundbankParser
private FileSelector	soundbankSelector
private UiView	view

Constructor Summary

Constructors

Constructor and Description
UiController() Sets up the UI of the main window by initializing the UiView and the parser classes.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) This method processes all action events in the UiView.
private void	configurationChanged(java.lang.String name, java.lang.String selectedId) Applies configuration changes.
private void	displayFilename(java.lang.String type, java.lang.String filename) Displays the parsed sequence or soundbank file name.
void	exportChosenFile(java.lang.String type, java.io.File file) Exports to the chosen file using the right exporter for this file type.
UiView	getView() Returns the view of the main window.
private void	initSelectorsIfNotYetDone() Initializes all possible types of FileSelectors.
private void	initView() Initializes the main window by creating the UiView object and all possible types of FileSelectors.
void	itemStateChanged(java.awt.event.ItemEvent e) Handles selecting/deselecting of one of the remember checkboxes.
private void	openExportFileSelector() Checks if a MIDI sequence is set and opens the file selector to choose the file to be exported.
void	parseChosenFile(java.lang.String type, java.lang.Object fileOrUrl) Parses the chosen file or URL using the right parser for the right file type.
private void	showErrorMessage(java.lang.String message) Opens an error message window showing the given message, if in GUI mode.
private void	showExportResult(ExportResult result) Opens an export result window showing the given export result.
void	soundbankLoadedBySourceCode() Sets the soundbank file name label after loading a soundbank by MidicaPL source code.
void	updateAfterPlayerClosed() Updates the parsed file label after the player has been closed.
void	updateImportedFileTypeAndName() Update the labels for the imported sequence file name and type, if any sequence is loaded.
void	windowActivated(java.awt.event.WindowEvent e) Initializes key bindings and refreshes the current transpose level that has been set in the player (or 0, if the transpose level has not yet been changed).
void	windowClosed(java.awt.event.WindowEvent e) Does nothing.
void	windowClosing(java.awt.event.WindowEvent e) Writes the current config to the config file, and exits.
void	windowDeactivated(java.awt.event.WindowEvent e) Does nothing.
void	windowDeiconified(java.awt.event.WindowEvent e) Does nothing.
void	windowIconified(java.awt.event.WindowEvent e) Does nothing.
void	windowOpened(java.awt.event.WindowEvent e) Checks if files must be loaded automatically, and loads them, if the check succeeds.

Methods inherited from class java.lang.Object

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

Field Detail

CMD_COMBOBOX_CHANGED

public static final java.lang.String CMD_COMBOBOX_CHANGED

See Also:

Constant Field Values

CMD_FILE_CHOSEN

public static final java.lang.String CMD_FILE_CHOSEN

See Also:

Constant Field Values

CMD_CANCELED

public static final java.lang.String CMD_CANCELED

See Also:

Constant Field Values

FILE_PURPOSE_PARSE

public static final java.lang.String FILE_PURPOSE_PARSE

See Also:

Constant Field Values

FILE_PURPOSE_EXPORT

public static final java.lang.String FILE_PURPOSE_EXPORT

See Also:

Constant Field Values

view

private UiView view

importSelector

private FileSelector importSelector

soundbankSelector

private FileSelector soundbankSelector

exportSelector

private FileSelector exportSelector

mplParser

private MidicaPLParser mplParser

midiParser

private MidiParser midiParser

aldaImporter

private AldaImporter aldaImporter

abcImporter

private AbcImporter abcImporter

lyImporter

private LilypondImporter lyImporter

mscoreImporter

private MusescoreImporter mscoreImporter

soundbankParser

private SoundbankParser soundbankParser

player

private PlayerView player

currentFile

private java.io.File currentFile

currentFileType

private java.lang.String currentFileType

currentFilePurpose

private java.lang.String currentFilePurpose

Constructor Detail

UiController

public UiController()

Sets up the UI of the main window by initializing the UiView and the parser classes.

Method Detail

initView

private void initView()

Initializes the main window by creating the UiView object and all possible types of FileSelectors.

This method is also called after changing the language in order to re-draw everything.

initSelectorsIfNotYetDone

private void initSelectorsIfNotYetDone()

Initializes all possible types of FileSelectors.

getView

public UiView getView()

Returns the view of the main window.

Returns:

main window view.

soundbankLoadedBySourceCode

public void soundbankLoadedBySourceCode()

Sets the soundbank file name label after loading a soundbank by MidicaPL source code.

actionPerformed

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

This method processes all action events in the UiView.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

e - The event to be handled.

itemStateChanged

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

Handles selecting/deselecting of one of the remember checkboxes.

Specified by:

itemStateChanged in interface java.awt.event.ItemListener

Parameters:

e - The event to be handled.

openExportFileSelector

private void openExportFileSelector()

Checks if a MIDI sequence is set and opens the file selector to choose the file to be exported.

If no MIDI sequence is set, shows an error message instead of opening the file selector.

parseChosenFile

public void parseChosenFile(java.lang.String type,
                            java.lang.Object fileOrUrl)

Parses the chosen file or URL using the right parser for the right file type. A wait dialog is shown during parsing. The parsing itself is executed by a SwingWorker.

Parameters:

type - Import type.

fileOrUrl - Selected file or URL (as string).

updateAfterPlayerClosed

public void updateAfterPlayerClosed()

Updates the parsed file label after the player has been closed. This is necessary because a reparse from the player could have failed. Then the label must not display the file name any more.

exportChosenFile

public void exportChosenFile(java.lang.String type,
                             java.io.File file)

Exports to the chosen file using the right exporter for this file type.

Parameters:

type - File type.

file - Selected file.

showErrorMessage

private void showErrorMessage(java.lang.String message)

Opens an error message window showing the given message, if in GUI mode. In CLI mode, prints the message to STDERR.

Parameters:

message - Error message.

showExportResult

private void showExportResult(ExportResult result)

Opens an export result window showing the given export result.

Parameters:

result - Export result containing warnings and errors of a file export.

updateImportedFileTypeAndName

public void updateImportedFileTypeAndName()

Update the labels for the imported sequence file name and type, if any sequence is loaded.

This is needed only in case of language switches to make sure that the correct files are still displayed.

displayFilename

private void displayFilename(java.lang.String type,
                             java.lang.String filename)

Displays the parsed sequence or soundbank file name. In case of a sequence, also displays the file type.

Parameters:

type - File type.

filename - File name.

windowActivated

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

Initializes key bindings and refreshes the current transpose level that has been set in the player (or 0, if the transpose level has not yet been changed).

Specified by:

windowActivated in interface java.awt.event.WindowListener

Parameters:

e - Window event.

windowClosed

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

Does nothing.

Specified by:

windowClosed in interface java.awt.event.WindowListener

Parameters:

e - Window event.

windowClosing

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

Writes the current config to the config file, and exits.

Specified by:

windowClosing in interface java.awt.event.WindowListener

Parameters:

e - Window event.

windowDeactivated

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

Does nothing.

Specified by:

windowDeactivated in interface java.awt.event.WindowListener

Parameters:

e - Window event.

windowDeiconified

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

Does nothing.

Specified by:

windowDeiconified in interface java.awt.event.WindowListener

Parameters:

e - Window closed event.

windowIconified

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

Does nothing.

Specified by:

windowIconified in interface java.awt.event.WindowListener

Parameters:

e - Window event.

windowOpened

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

Checks if files must be loaded automatically, and loads them, if the check succeeds.

Specified by:

windowOpened in interface java.awt.event.WindowListener

Parameters:

e - Window event.

configurationChanged

private void configurationChanged(java.lang.String name,
                                  java.lang.String selectedId)

Applies configuration changes.

This method is called whenever one of the configuration comboboxes is changed.

Parameters:

name - Name of the combobox that has been changed.

selectedId - ID of the selected item in the combobox.