at.mug.iqm.api.operator

Class PreferencesPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

at.mug.iqm.api.operator.PreferencesPanel

All Implemented Interfaces:

ITemplateSupport, ImageObserver, MenuContainer, Serializable, Accessible

public class PreferencesPanel
extends JPanel
implements ITemplateSupport

This JPanel is the GUI front end for managing the operator preferences.

Author:

Philipp Kainz

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
private int	lastChosenTemplateIndex The last chosen template index, this value will be passed to the ITemplateManagerGUI instance in this class for convenient template managing.
private JLabel	lblPreferences The label containing the description of the combo box.
private static org.apache.log4j.Logger	logger
private String	opName The cached name of the operator.
private IOperatorGUI	parentGUI The cached reference to the parent IOperatorGUI.
private JComboBox	preferenceBox The combo box containing the template names for a given operator.
private static long	serialVersionUID The UID for serialization.
private List<IqmOperatorDescriptor>	templateList The actual templates as Java objects (read from IQMOperatorTemplates.xml).
private ITemplateManagerGUI	templateManagerGUI The reference to the ITemplateManagerGUI.
private DefaultComboBoxModel	templateModel The model of the combo-box.

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
PreferencesPanel() Create the panel.
PreferencesPanel(IOperatorGUI parentGUI) Ties the preferences to a specific operator GUI.

Method Summary

Modifier and Type	Method and Description
protected void	createParametersFromTemplate(String templateName) Sets the GUI's ParameterBlock with a template saved in the IQMOperatorTemplates.xml.
private ITemplateManagerGUI	createTemplateManagerGUI() Create a new ITemplateManagerGUI associated with this as particular operator GUI and PreferencesPanel .
protected DefaultComboBoxModel	createTemplateModel()
void	fillPreferencesBox() This function is called to fill the combo-box with appropriate templates from IQMOperatorTemplates.xml. The entries are sorted alphabetically, but the first entry is "default" and the last is "New Template". If no template is found in IQMOperatorTemplates.xml this function also generates a new "default" template from the hard-coded default values and saves them to IQMOperatorTemplates.xml.
int	getLastChosenTemplateIndex()
JLabel	getLblPreferences()
String	getOpName() Gets the name of the operator.
ParameterBlockIQM	getParameters() Get the parameters wrapped in a ParameterBlockIQM of a GUI.
JComboBox	getPreferenceBox()
DefaultComboBoxModel	getTemplateModel() Get the template model of the combo box.
protected void	handleItemStateChange() A custom handler, if the user changes a value in the combo box of templates.
void	initialize(IOperatorGUI parentGUI) Initializes all functionality of the panel.
protected void	preferenceBoxItemStateChanged(ItemEvent evt) A wrapper for custom ItemEvent on the preferenceBox.
void	setChosenTemplate(String templateName) Set the template name, selected in the TemplateManagerGUI in the combo box, when the manager's GUI is closed.
void	setLastChosenTemplateIndex(int lastChosenTemplateIndex)
void	setOpName(String opName)
void	setTemplateModel(DefaultComboBoxModel templateModel) Set the template model for the combo box.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.apache.log4j.Logger logger

serialVersionUID

private static final long serialVersionUID

The UID for serialization.

See Also:

Constant Field Values

opName

private String opName

The cached name of the operator.

parentGUI

private IOperatorGUI parentGUI

The cached reference to the parent IOperatorGUI.

templateManagerGUI

private ITemplateManagerGUI templateManagerGUI

The reference to the ITemplateManagerGUI.

preferenceBox

private JComboBox preferenceBox

The combo box containing the template names for a given operator.

templateList

private List<IqmOperatorDescriptor> templateList

The actual templates as Java objects (read from IQMOperatorTemplates.xml).

templateModel

private DefaultComboBoxModel templateModel

The model of the combo-box.

lastChosenTemplateIndex

private int lastChosenTemplateIndex

The last chosen template index, this value will be passed to the ITemplateManagerGUI instance in this class for convenient template managing.

lblPreferences

private JLabel lblPreferences

The label containing the description of the combo box.

Constructor Detail

PreferencesPanel

public PreferencesPanel(IOperatorGUI parentGUI)

Ties the preferences to a specific operator GUI.

Parameters:

parentGUI -

PreferencesPanel

public PreferencesPanel()

Create the panel.

The use of PreferencesPanel(IOperatorGUI) is encouraged.

You will have to set the following properties manually:

• opName
• parentGUI

and after that you have to call initialize(IOperatorGUI) in order to get a working PreferencesPanel.

Method Detail

initialize

public void initialize(IOperatorGUI parentGUI)

Initializes all functionality of the panel.

preferenceBoxItemStateChanged

protected void preferenceBoxItemStateChanged(ItemEvent evt)

A wrapper for custom ItemEvent on the preferenceBox.

Parameters:

evt -

handleItemStateChange

protected void handleItemStateChange()

A custom handler, if the user changes a value in the combo box of templates.

setOpName

public void setOpName(String opName)

getOpName

public String getOpName()

Description copied from interface: ITemplateSupport

Gets the name of the operator. This String is queried by the XMLPreferencesManager when managing templates for an operator.

Specified by:

getOpName in interface ITemplateSupport

Returns:

the operator name for this ITemplateSupport

getPreferenceBox

public JComboBox getPreferenceBox()

getLblPreferences

public JLabel getLblPreferences()

createTemplateModel

protected DefaultComboBoxModel createTemplateModel()

fillPreferencesBox

public void fillPreferencesBox()

This function is called to fill the combo-box with appropriate templates from IQMOperatorTemplates.xml.
The entries are sorted alphabetically, but the first entry is "default" and the last is "New Template".
If no template is found in IQMOperatorTemplates.xml this function also generates a new "default" template from the hard-coded default values and saves them to IQMOperatorTemplates.xml.

Author: Philipp W.

Specified by:

fillPreferencesBox in interface ITemplateSupport

createParametersFromTemplate

protected void createParametersFromTemplate(String templateName)

Sets the GUI's ParameterBlock with a template saved in the IQMOperatorTemplates.xml.
This function is called, by the combo-box. If called otherwise make sure the template exists, as nothing will happen on a wrong name.

Author: Philipp W.

Parameters:

templateName - Name of the template in IQMOperatorTemplates.xml

setTemplateModel

public void setTemplateModel(DefaultComboBoxModel templateModel)

Set the template model for the combo box.

Parameters:

templateModel -

getTemplateModel

public DefaultComboBoxModel getTemplateModel()

Get the template model of the combo box.

Returns:

the template model of the combo box

getLastChosenTemplateIndex

public int getLastChosenTemplateIndex()

setLastChosenTemplateIndex

public void setLastChosenTemplateIndex(int lastChosenTemplateIndex)

createTemplateManagerGUI

private ITemplateManagerGUI createTemplateManagerGUI()

Create a new ITemplateManagerGUI associated with this as particular operator GUI and PreferencesPanel .

Returns:

a new instance of ITemplateManagerGUI

getParameters

public ParameterBlockIQM getParameters()

Get the parameters wrapped in a ParameterBlockIQM of a GUI.

Specified by:

getParameters in interface ITemplateSupport

Returns:

the parameter block

setChosenTemplate

public void setChosenTemplate(String templateName)

Set the template name, selected in the TemplateManagerGUI in the combo box, when the manager's GUI is closed.

Specified by:

setChosenTemplate in interface ITemplateSupport

Parameters:

templateName -