org.midica.ui.file.config

Class FileConfigController

java.lang.Object

org.midica.ui.file.config.FileConfigController

All Implemented Interfaces:

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

Direct Known Subclasses:

AudioConfigController, DecompileConfigController

public abstract class FileConfigController
extends java.lang.Object
implements java.awt.event.WindowListener, javax.swing.event.DocumentListener, java.awt.event.ActionListener, java.awt.event.FocusListener

This is the base class of controllers for file-based config windows.

Author:

Jan Trukenmüller

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.HashMap<java.lang.String,java.lang.Class<?>>	configClasses
protected java.util.HashSet<java.lang.String>	configKeys
protected java.util.HashMap<java.lang.String,javax.swing.JComponent>	configWidgets
protected ConfigIcon	icon
protected java.util.HashMap<java.lang.String,java.lang.String>	sessionConfig
protected FileConfigView	view

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileConfigController(FileConfigView view, ConfigIcon icon) Creates a file config controller.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e)
protected boolean	applyConfig() Copies each correct config value to the session config.
protected 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)
protected abstract void	createDefaultView() Creates a default view that is not intended to be used as a real window.
void	focusGained(java.awt.event.FocusEvent e)
void	focusLost(java.awt.event.FocusEvent e)
protected abstract java.util.HashMap<java.lang.String,java.lang.String>	getDefaultConfig() Returns the hard-coded default config.
private java.lang.String	getSavedConfigValue(java.lang.String id) Returns the saved config value of the given config ID.
java.util.HashMap<java.lang.String,java.lang.String>	getSessionConfig() Returns the session config.
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	init(FileConfigView view, ConfigIcon icon) Initializes the controller.
protected void	initSessionConfig(boolean fromConfig) Initializes the session config and the state of the widgets.
protected abstract void	initSessionConfigSpecific(boolean fromConfig) Initializes the specific part of the session config.
protected void	initWidgetConfig(java.lang.String id, javax.swing.JComponent widget, java.lang.Class<?> type, boolean fromConfig) Initializes data structures for one config element.
void	insertUpdate(javax.swing.event.DocumentEvent e)
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	restoreDefaultSettings() Applies the (hard-coded) default settings to the session config and the widgets.
private void	saveSettings() Saves the session config to the config file.
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

icon

protected ConfigIcon icon

view

protected FileConfigView view

configKeys

protected java.util.HashSet<java.lang.String> configKeys

configClasses

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

sessionConfig

protected java.util.HashMap<java.lang.String,java.lang.String> sessionConfig

configWidgets

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

Constructor Detail

FileConfigController

protected FileConfigController(FileConfigView view,
                               ConfigIcon icon)

Creates a file config controller.

Parameters:

view - the window to be controlled

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

Method Detail

getSessionConfig

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

Returns the session config.

Returns:

the session config.

createDefaultView

protected abstract void createDefaultView()

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.

init

protected void init(FileConfigView view,
                    ConfigIcon icon)

Initializes the controller.

Connects view and icon with the controller, if not yet done. Initializes the session config, if not yet done. Connects the session config to the widgets.

Parameters:

view - the window to be controlled

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

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

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

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

initSessionConfig

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

initSessionConfigSpecific

protected abstract void initSessionConfigSpecific(boolean fromConfig)

Initializes the specific part of the session config.

Parameters:

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

initWidgetConfig

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

Initializes data structures for one 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

getDefaultConfig

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

Returns the hard-coded default config.

Returns:

the default config.

applyConfig

protected boolean applyConfig()

Copies each correct config value to the session config.

Checks each config value first. Depending on the check result: 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

protected 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

handleDocumentChange

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.

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

Parameters:

e - document event

saveSettings

private void saveSettings()

Saves the session config to the config file.

restoreDefaultSettings

private void restoreDefaultSettings()

Applies the (hard-coded) default settings to the session config and the widgets.

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

getSavedConfigValue

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

Returns the saved config value of the given 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