org.midica.ui.file.config

Class DecompileConfigController

java.lang.Object

org.midica.ui.file.config.FileConfigController

org.midica.ui.file.config.DecompileConfigController

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.event.FocusListener, java.awt.event.WindowListener, java.util.EventListener, javax.swing.event.DocumentListener

public class DecompileConfigController
extends FileConfigController

Controller for the decompile config window.

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
private static DecompileConfigController	controller
private static java.util.TreeSet<java.lang.Long>	extraGlobalTicks

Fields inherited from class org.midica.ui.file.config.FileConfigController

configClasses, configKeys, configWidgets, icon, sessionConfig, view

Constructor Summary

Constructors

Modifier	Constructor and Description
private	DecompileConfigController(DecompileConfigView view, ConfigIcon icon) Creates a controller for the decompile config window.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e)
protected boolean	applyConfigById(java.lang.String id) Copies the given config key’s value to the session config, if the value is correct.
protected void	createDefaultView() Creates a default view that is not intended to be used as a real window.
void	focusGained(java.awt.event.FocusEvent e)
static javax.swing.DefaultComboBoxModel<NamedInteger>	getComboboxModel(java.lang.String id) Returns the model for a combobox.
protected java.util.HashMap<java.lang.String,java.lang.String>	getDefaultConfig() Returns the hard-coded default config.
static java.util.TreeSet<java.lang.Long>	getExtraGlobalTicks() Returns the ticks for extra global commands.
private java.util.TreeSet<java.lang.Long>	getExtraTicksFromTxtArea() Converts the comma-separated extra ticks from the text area into a data structure.
static DecompileConfigController	getInstance(DecompileConfigView view, ConfigIcon icon) Creates a singleton instance of the controller.
private static NamedInteger	getMaxNoteLengthCbxModelElement(int ticks, java.lang.String lengthName) Creates a numbered integer that can be put into the combobox model for the max note length combobox.
protected void	handleDocumentChange(javax.swing.event.DocumentEvent e) Adjusts the background color of fields that are not directly related to a config variable, if overridden accordingly.
protected void	initSessionConfig(boolean fromConfig) Initializes the session config and the state of the widgets.
protected void	initSessionConfigSpecific(boolean fromConfig) Initializes the specific part of the session config.
private void	refillExtraGlobalField() (Re)fills the text area with ticks for extra global commands.

Methods inherited from class org.midica.ui.file.config.FileConfigController

applyConfig, changedUpdate, focusLost, getSessionConfig, init, initWidgetConfig, insertUpdate, removeUpdate, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class java.lang.Object

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

Field Detail

controller

private static DecompileConfigController controller

extraGlobalTicks

private static java.util.TreeSet<java.lang.Long> extraGlobalTicks

Constructor Detail

DecompileConfigController

private DecompileConfigController(DecompileConfigView view,
                                  ConfigIcon icon)

Creates a controller for the decompile config window.

Parameters:

view - the window to be controlled

icon - the icon that is used to open the config window

Method Detail

getInstance

public static DecompileConfigController getInstance(DecompileConfigView view,
                                                    ConfigIcon icon)

Creates a singleton instance of the controller.

Parameters:

view - the window to be controlled

icon - the icon that is used to open the config window

Returns:

the created controller.

createDefaultView

protected void createDefaultView()

Description copied from class: FileConfigController

Creates a default view that is not intended to be used as a real window. This is used to initialize data structures, if the user does not want to config window is.

Specified by:

createDefaultView in class FileConfigController

getExtraGlobalTicks

public static java.util.TreeSet<java.lang.Long> getExtraGlobalTicks()

Returns the ticks for extra global commands.

Returns:

ticks for extra global commands

initSessionConfig

protected void initSessionConfig(boolean fromConfig)

Description copied from class: FileConfigController

Initializes the session config and the state of the widgets.

If the parameter fromConfig is true, the config is copied from Config to the session config. Otherwise the session config is left unchanged.

Overrides:

initSessionConfig in class FileConfigController

Parameters:

fromConfig - true if the session config shall be copied from the Config class.

getDefaultConfig

protected java.util.HashMap<java.lang.String,java.lang.String> getDefaultConfig()

Description copied from class: FileConfigController

Returns the hard-coded default config.

Specified by:

getDefaultConfig in class FileConfigController

Returns:

the default config.

initSessionConfigSpecific

protected void initSessionConfigSpecific(boolean fromConfig)

Description copied from class: FileConfigController

Initializes the specific part of the session config.

Specified by:

initSessionConfigSpecific in class FileConfigController

Parameters:

fromConfig - true if the session config shall be copied from the Config class.

actionPerformed

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

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Overrides:

actionPerformed in class FileConfigController

focusGained

public void focusGained(java.awt.event.FocusEvent e)

Specified by:

focusGained in interface java.awt.event.FocusListener

Overrides:

focusGained in class FileConfigController

applyConfigById

protected boolean applyConfigById(java.lang.String id)

Description copied from class: FileConfigController

Copies the given config key’s value to the session config, if the value is correct.

Adjusts the widget according to the correctness (background of text fields etc.).

Overrides:

applyConfigById in class FileConfigController

Parameters:

id - config ID

Returns:

true if the value is correct, otherwise false

handleDocumentChange

protected void handleDocumentChange(javax.swing.event.DocumentEvent e)

Description copied from class: FileConfigController

Adjusts the background color of fields that are not directly related to a config variable, if overridden accordingly.

Does nothing by default. Per default, this is called by all kinds of document change event.

Overrides:

handleDocumentChange in class FileConfigController

Parameters:

e - document event

refillExtraGlobalField

private void refillExtraGlobalField()

(Re)fills the text area with ticks for extra global commands. Makes the according config variable ready to be saved.

getExtraTicksFromTxtArea

private java.util.TreeSet<java.lang.Long> getExtraTicksFromTxtArea()
                                                            throws java.lang.NumberFormatException

Converts the comma-separated extra ticks from the text area into a data structure.

Returns:

the ticks

Throws:

java.lang.NumberFormatException - if there are errors in the text string.

getComboboxModel

public static javax.swing.DefaultComboBoxModel<NamedInteger> getComboboxModel(java.lang.String id)

Returns the model for a combobox.

Parameters:

id - config ID, identifying the config variable that the combobox controls

Returns:

the combobox model

getMaxNoteLengthCbxModelElement

private static NamedInteger getMaxNoteLengthCbxModelElement(int ticks,
                                                            java.lang.String lengthName)

Creates a numbered integer that can be put into the combobox model for the max note length combobox.

Parameters:

ticks - note length in ticks of the target resolution (480 PPQ)

lengthName - note length name or description

Returns:

the created element.