at.mug.iqm.api.operator

Class AbstractOperatorGUI

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

at.mug.iqm.api.operator.AbstractOperatorGUI

All Implemented Interfaces:

IOperatorGUI, ActionListener, WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

AbstractImageOperatorGUI, AbstractPlotOperatorGUI

public abstract class AbstractOperatorGUI
extends JFrame
implements IOperatorGUI, ActionListener, WindowListener

See Also:

Serialized Form

Nested Class Summary

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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 JButton	btnApply
private JButton	btnPreview
private JButton	btnReset
private JPanel	buttonPanel
private JScrollPane	contentScrollPane
private JPanel	controlsPanel
private JScrollPane	controlsScrollpane
private JPanel	customControls
private Component	horizontalGlue_1
private Component	horizontalStrut
private JLabel	lblMultiResults
private static org.apache.log4j.Logger	logger
private JPanel	opGUIContent
protected String	opName
private OutputOptionsPanel	outputOptionsPanel
protected List<DataType>	outputTypes
private JPanel	panel
protected PropertyChangeSupport	pcs
private JSeparator	separator_1
private static long	serialVersionUID
protected IWorkPackage	workPackage

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
AbstractOperatorGUI() Create the frame.

Method Summary

Modifier and Type	Method and Description
void	destroy() Custom routine for disposing the GUI, may be overridden.
protected void	disableESCOptionForClosing()
void	disableInputs() Disables inputs on the GUI elements.
void	disableMultiResultsButton()
protected void	enableESCOptionForClosing()
void	enableInputs() Enables or re-enables inputs on the GUI elements.
void	enableMultiResultsButton()
JButton	getBtnApply()
JButton	getBtnPreview()
JButton	getBtnReset()
JPanel	getButtonPanel()
JPanel	getControlsPanel()
JPanel	getCustomControls()
JPanel	getOpGUIContent()
String	getOpName() Gets the operator's name associated with this GUI.
OutputOptionsPanel	getOutputOptionsPanel()
JScrollPane	getScrollPane()
IWorkPackage	getWorkPackage() Gets the work package of an operator GUI using the current parameters set by the custom GUI elements.
void	initialize() Initialize the default settings for an IOperatorGUI, e.g.
static void	main(String[] args) Launch the application.
void	reset() Resets the GUI to it's default values and default parameters in the work package.
void	setOpName(String opName) Sets the name of the operator to this GUI.
abstract void	setParameterValuesToGUI() This method implements the initialization of the GUI.
protected void	setPreviewButtonState() The preview button will only be enabled, if there is something checked to be processed by the operator.
void	setVisible(boolean b) A custom routine for setting the GUI visible (this may override the default implementation when using JFrame as base container class).
void	setWorkPackage(IWorkPackage workPackage) Sets the work package to the operator's GUI, so that the custom GUI elements can be constructed using the parameter values.
void	showOrHideMultiResultList()
abstract void	showPreview() Performs a preview of the operator using the current work package.
abstract void	update() Instruct the GUI to validate and repaint for updated parameters, e.g.
abstract void	updateParameterBlock() Updates the parameter block in the work package using the current states of the custom GUI elements.
void	updateParameterBlock(ParameterBlockIQM pb) This method updates the parameter block and sets the containing parameters to the GUI elements.
void	windowActivated(WindowEvent e)
void	windowClosed(WindowEvent e)
void	windowClosing(WindowEvent e)
void	windowDeactivated(WindowEvent e)
void	windowDeiconified(WindowEvent e)
void	windowIconified(WindowEvent e)
void	windowOpened(WindowEvent e)

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface at.mug.iqm.api.operator.IOperatorGUI

isVisible

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

logger

private static final org.apache.log4j.Logger logger

opName

protected String opName

workPackage

protected IWorkPackage workPackage

outputTypes

protected List<DataType> outputTypes

pcs

protected PropertyChangeSupport pcs

customControls

private JPanel customControls

btnReset

private JButton btnReset

controlsPanel

private JPanel controlsPanel

buttonPanel

private JPanel buttonPanel

btnPreview

private JButton btnPreview

contentScrollPane

private JScrollPane contentScrollPane

opGUIContent

private JPanel opGUIContent

separator_1

private JSeparator separator_1

outputOptionsPanel

private OutputOptionsPanel outputOptionsPanel

controlsScrollpane

private JScrollPane controlsScrollpane

btnApply

private JButton btnApply

horizontalGlue_1

private Component horizontalGlue_1

horizontalStrut

private Component horizontalStrut

lblMultiResults

private JLabel lblMultiResults

panel

private JPanel panel

Constructor Detail

AbstractOperatorGUI

public AbstractOperatorGUI()

Create the frame.

Method Detail

main

public static void main(String[] args)

Launch the application.

showOrHideMultiResultList

public void showOrHideMultiResultList()

setPreviewButtonState

protected void setPreviewButtonState()

The preview button will only be enabled, if there is something checked to be processed by the operator.

enableESCOptionForClosing

protected void enableESCOptionForClosing()

disableESCOptionForClosing

protected void disableESCOptionForClosing()

getCustomControls

public JPanel getCustomControls()

getBtnReset

public JButton getBtnReset()

getControlsPanel

public JPanel getControlsPanel()

getOpGUIContent

public JPanel getOpGUIContent()

getButtonPanel

public JPanel getButtonPanel()

getBtnPreview

public JButton getBtnPreview()

getScrollPane

public JScrollPane getScrollPane()

initialize

public void initialize()

Description copied from interface: IOperatorGUI

Initialize the default settings for an IOperatorGUI, e.g. the location of the window or the default close operation.

Specified by:

initialize in interface IOperatorGUI

update

public abstract void update()
                     throws Exception

Description copied from interface: IOperatorGUI

Instruct the GUI to validate and repaint for updated parameters, e.g. if the GUI is altered for another input type.

This method alters the GUI elements in a container, if the input type is non-standard for this operator GUI. Furthermore, this method is responsible for setting the parameters to the elements and calls IOperatorGUI.updateParameterBlock() before IOperatorGUI.setParameterValuesToGUI() as last statements.

Specified by:

update in interface IOperatorGUI

Throws:

Exception

setParameterValuesToGUI

public abstract void setParameterValuesToGUI()
                                      throws Exception

Description copied from interface: IOperatorGUI

This method implements the initialization of the GUI. An instance of IOperatorGUI may be constructed empty or directly using a valid IWorkPackage.

If the GUI is constructed empty, the work package must be set manually using IOperatorGUI.setWorkPackage(IWorkPackage) and IOperatorGUI.setParameterValuesToGUI() must be called in order to set the parameter values to the GUI.

Specified by:

setParameterValuesToGUI in interface IOperatorGUI

Throws:

Exception

updateParameterBlock

public abstract void updateParameterBlock()
                                   throws Exception

Description copied from interface: IOperatorGUI

Updates the parameter block in the work package using the current states of the custom GUI elements.

Specified by:

updateParameterBlock in interface IOperatorGUI

Throws:

Exception

showPreview

public abstract void showPreview()

Description copied from interface: IOperatorGUI

Performs a preview of the operator using the current work package. This method calls executeTask(AbstractProcessingTask).

Specified by:

showPreview in interface IOperatorGUI

updateParameterBlock

public void updateParameterBlock(ParameterBlockIQM pb)

This method updates the parameter block and sets the containing parameters to the GUI elements. Furthermore, it updates the GUI in order to reflect any new changes.

Specified by:

updateParameterBlock in interface IOperatorGUI

Parameters:

pb - the updated parameters for this operator

setVisible

public void setVisible(boolean b)

Description copied from interface: IOperatorGUI

A custom routine for setting the GUI visible (this may override the default implementation when using JFrame as base container class).

Specified by:

setVisible in interface IOperatorGUI

Overrides:

setVisible in class Window

setOpName

public void setOpName(String opName)

Description copied from interface: IOperatorGUI

Sets the name of the operator to this GUI.

Specified by:

setOpName in interface IOperatorGUI

getOpName

public String getOpName()

Description copied from interface: IOperatorGUI

Gets the operator's name associated with this GUI.

Specified by:

getOpName in interface IOperatorGUI

Returns:

the opName

getWorkPackage

public IWorkPackage getWorkPackage()

Description copied from interface: IOperatorGUI

Gets the work package of an operator GUI using the current parameters set by the custom GUI elements.

Specified by:

getWorkPackage in interface IOperatorGUI

Returns:

the work package

setWorkPackage

public void setWorkPackage(IWorkPackage workPackage)

Description copied from interface: IOperatorGUI

Sets the work package to the operator's GUI, so that the custom GUI elements can be constructed using the parameter values.

Specified by:

setWorkPackage in interface IOperatorGUI

reset

public void reset()

Description copied from interface: IOperatorGUI

Resets the GUI to it's default values and default parameters in the work package.

Specified by:

reset in interface IOperatorGUI

disableInputs

public void disableInputs()

Description copied from interface: IOperatorGUI

Disables inputs on the GUI elements.

Specified by:

disableInputs in interface IOperatorGUI

enableInputs

public void enableInputs()

Description copied from interface: IOperatorGUI

Enables or re-enables inputs on the GUI elements.

Specified by:

enableInputs in interface IOperatorGUI

destroy

public void destroy()

Description copied from interface: IOperatorGUI

Custom routine for disposing the GUI, may be overridden.

Specified by:

destroy in interface IOperatorGUI

windowClosing

public void windowClosing(WindowEvent e)

Specified by:

windowClosing in interface WindowListener

windowClosed

public void windowClosed(WindowEvent e)

Specified by:

windowClosed in interface WindowListener

windowIconified

public void windowIconified(WindowEvent e)

Specified by:

windowIconified in interface WindowListener

windowDeiconified

public void windowDeiconified(WindowEvent e)

Specified by:

windowDeiconified in interface WindowListener

windowActivated

public void windowActivated(WindowEvent e)

Specified by:

windowActivated in interface WindowListener

windowDeactivated

public void windowDeactivated(WindowEvent e)

Specified by:

windowDeactivated in interface WindowListener

windowOpened

public void windowOpened(WindowEvent e)

Specified by:

windowOpened in interface WindowListener

getOutputOptionsPanel

public OutputOptionsPanel getOutputOptionsPanel()

getBtnApply

public JButton getBtnApply()

enableMultiResultsButton

public void enableMultiResultsButton()

disableMultiResultsButton

public void disableMultiResultsButton()