org.midica.ui.file

Class DecompileConfigController

java.lang.Object

org.midica.ui.file.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 java.lang.Object
implements java.awt.event.WindowListener, javax.swing.event.DocumentListener, java.awt.event.ActionListener, java.awt.event.FocusListener

Controller for the decompile config window.

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.HashMap<java.lang.String,java.lang.Class<?>>	configClasses
private static java.util.HashSet<java.lang.String>	configKeys
private static java.util.HashMap<java.lang.String,javax.swing.JComponent>	configWidgets
private static java.util.TreeSet<java.lang.Long>	extraGlobalTicks
(package private) DecompileConfigIcon	icon
private static java.util.HashMap<java.lang.String,java.lang.String>	sessionConfig
(package private) DecompileConfigView	view

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e)
private boolean	applyConfig() Copies each correct config value to the session config.
private boolean	applyConfigById(java.lang.String id) Copies the given config key’s value to the session config, if the value is correct.
void	changedUpdate(javax.swing.event.DocumentEvent e)
void	focusGained(java.awt.event.FocusEvent e)
void	focusLost(java.awt.event.FocusEvent e)
static javax.swing.DefaultComboBoxModel<NamedInteger>	getComboboxModel(java.lang.String id) Returns the model for a combobox.
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.
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.
private static java.lang.String	getSavedConfigValue(java.lang.String id) Returns the saved config value of the given decompile config ID.
static java.util.HashMap<java.lang.String,java.lang.String>	getSessionConfig() Returns the session config.
private void	handleDocumentChange(javax.swing.event.DocumentEvent e) Adjusts the background color of fields that are not directly related to a config variable.
private void	initSessionConfig(boolean fromConfig) Initializes the session config and the state of the widgets.
private void	initWidgetConfig(java.lang.String id, javax.swing.JComponent widget, java.lang.Class<?> type, boolean fromConfig) Initializes data structures for one decompile config element.
void	insertUpdate(javax.swing.event.DocumentEvent e)
private void	refillExtraGlobalField() (Re)fills the text area with ticks for extra global commands.
void	removeUpdate(javax.swing.event.DocumentEvent e)
private void	restoreDefaultConfig(java.lang.String id, java.lang.String value, javax.swing.JComponent widget) Restores the session config with the according default value.
private void	setWidget(javax.swing.JComponent widget, java.lang.String valueStr) Sets the given widget to the given value.
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)

Methods inherited from class java.lang.Object

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

Field Detail

view

DecompileConfigView view

icon

DecompileConfigIcon icon

configKeys

private static java.util.HashSet<java.lang.String> configKeys

configClasses

private static java.util.HashMap<java.lang.String,java.lang.Class<?>> configClasses

sessionConfig

private static java.util.HashMap<java.lang.String,java.lang.String> sessionConfig

configWidgets

private static java.util.HashMap<java.lang.String,javax.swing.JComponent> configWidgets

extraGlobalTicks

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

Constructor Detail

DecompileConfigController

public DecompileConfigController(DecompileConfigView view,
                                 DecompileConfigIcon icon)

Creates a controller for the decompile config window.

Parameters:

view - the window to be controlled

Method Detail

getSessionConfig

public static java.util.HashMap<java.lang.String,java.lang.String> getSessionConfig()

Returns the session config.

Returns:

the session config.

getExtraGlobalTicks

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

Returns the ticks for extra global commands.

Returns:

ticks for extra global commands

initSessionConfig

private void initSessionConfig(boolean fromConfig)

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.

Parameters:

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

initWidgetConfig

private void initWidgetConfig(java.lang.String id,
                              javax.swing.JComponent widget,
                              java.lang.Class<?> type,
                              boolean fromConfig)

Initializes data structures for one decompile config element.

Parameters:

id - the config ID

widget - the according widget

type - the class of the config variable

fromConfig - true, if the session config shall be overwritten with the saved config value

restoreDefaultConfig

private void restoreDefaultConfig(java.lang.String id,
                                  java.lang.String value,
                                  javax.swing.JComponent widget)

Restores the session config with the according default value.

Parameters:

id - config ID

value - config value

widget - the according widget

setWidget

private void setWidget(javax.swing.JComponent widget,
                       java.lang.String valueStr)

Sets the given widget to the given value.

Parameters:

widget - the widget to be adjusted

valueStr - the value

actionPerformed

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

Specified by:

actionPerformed in interface java.awt.event.ActionListener

focusGained

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

Specified by:

focusGained in interface java.awt.event.FocusListener

focusLost

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

Specified by:

focusLost in interface java.awt.event.FocusListener

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)

Specified by:

windowOpened in interface java.awt.event.WindowListener

refillExtraGlobalField

private void refillExtraGlobalField()

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

applyConfig

private boolean applyConfig()

Copies each correct config value to the session config.

Checks each config value first. Depending on the check value: Adjusts each incorrect widget accordingly (background of text fields etc.).

Adjusts the icon to open the config window accordingly:

• default appearance, if all config values are correct
• otherwise: failure appearance

Returns:

true if the session config is OK, otherwise false.

applyConfigById

private boolean applyConfigById(java.lang.String id)

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.).

Parameters:

id - config ID

Returns:

true if the value is correct, otherwise false

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.

changedUpdate

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

Specified by:

changedUpdate in interface javax.swing.event.DocumentListener

insertUpdate

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

Specified by:

insertUpdate in interface javax.swing.event.DocumentListener

removeUpdate

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

Specified by:

removeUpdate in interface javax.swing.event.DocumentListener

handleDocumentChange

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

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

Parameters:

e - document event

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.

getSavedConfigValue

private static java.lang.String getSavedConfigValue(java.lang.String id)

Returns the saved config value of the given decompile config ID. If the saved config value is not valid, the default config value is used instead.

Parameters:

id - the config ID

Returns:

the configured value, if the check succeeds, or otherwise the default value