meka.gui.experimenter

Class AbstractSetupTab

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

meka.gui.core.MekaPanel

meka.gui.experimenter.AbstractExperimenterTab

meka.gui.experimenter.AbstractSetupTab

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, ExecutionStageListener

Direct Known Subclasses:

BasicSetup, ExpertSetup

public abstract class AbstractSetupTab
extends AbstractExperimenterTab

Ancestor for tabs that setup experiments.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

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
protected JButton	m_ButtonApply the button for applying the setup.
protected JButton	m_ButtonRevert the button for reverting the setup.
protected boolean	m_IgnoreChanges whether to ignore changes (= don't set modified flag).
protected boolean	m_Modified whether the setup has been modified.
protected JPanel	m_PanelSetup the panel for the setup.
protected JPanel	m_PanelUnsupported the message that experiment cannot be handled.

Fields inherited from class meka.gui.experimenter.AbstractExperimenterTab

m_Experiment, m_Owner

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
AbstractSetupTab()

Method Summary

Modifier and Type	Method and Description
protected void	apply() Applies the settings to the experiment.
protected abstract void	clear() Resets the interface.
void	experimentStage(ExecutionStageEvent e) Gets called when the experiment enters a new stage.
protected void	finishInit() Finishes the GUI setup.
protected abstract void	fromExperiment() Maps the experiment onto the parameters.
protected GenericObjectEditorDialog	getGOEDialog(Class cls, Object value) Returns a GOE dialog.
String	getTitle() Returns the title of the tab.
protected abstract boolean	handlesExperiment(Experiment exp) Checks whether this type of experiment is handled by this tab.
protected void	initGUI() Initializes the widgets.
protected void	initialize() Initializes the members.
boolean	isModified() Returns the modified state.
protected void	revert() Reverts the settings to the experiment ones.
void	setExperiment(Experiment value) Sets the experiment to use.
void	setModified(boolean value) Sets the modified state, updates the buttons.
protected JPanel	setPreferredSize(JPanel panel) Sets the preferred size of the panel.
protected abstract Experiment	toExperiment() Stores the parameters in an experiment.
protected void	update() Gets called when the experiment changed.
protected void	updateButtons() Updates the enabled state of the buttons.

Methods inherited from class meka.gui.experimenter.AbstractExperimenterTab

clearStatus, finishBusy, finishBusy, getExperiment, getMenu, getOwner, getTabs, handleException, hasExperiment, log, setOwner, showStatus, startBusy, startBusy

Methods inherited from class meka.gui.core.MekaPanel

closeParent, getParentDialog, getParentFrame

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

m_PanelUnsupported

protected JPanel m_PanelUnsupported

the message that experiment cannot be handled.

m_PanelSetup

protected JPanel m_PanelSetup

the panel for the setup.

m_ButtonApply

protected JButton m_ButtonApply

the button for applying the setup.

m_ButtonRevert

protected JButton m_ButtonRevert

the button for reverting the setup.

m_Modified

protected boolean m_Modified

whether the setup has been modified.

m_IgnoreChanges

protected boolean m_IgnoreChanges

whether to ignore changes (= don't set modified flag).

Constructor Detail

AbstractSetupTab

public AbstractSetupTab()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractExperimenterTab

initGUI

protected void initGUI()

Initializes the widgets.

Overrides:

initGUI in class MekaPanel

finishInit

protected void finishInit()

Finishes the GUI setup.

Overrides:

finishInit in class MekaPanel

setPreferredSize

protected JPanel setPreferredSize(JPanel panel)

Sets the preferred size of the panel.

Parameters:

panel - the panel to update

Returns:

the updated panel

updateButtons

protected void updateButtons()

Updates the enabled state of the buttons.

getTitle

public String getTitle()

Returns the title of the tab.

Specified by:

getTitle in class AbstractExperimenterTab

Returns:

the title

setModified

public void setModified(boolean value)

Sets the modified state, updates the buttons.

Parameters:

value - the state

isModified

public boolean isModified()

Returns the modified state.

Returns:

the state

getGOEDialog

protected GenericObjectEditorDialog getGOEDialog(Class cls,
                                                 Object value)

Returns a GOE dialog.

Parameters:

cls - the class hierarchy

value - the current value

Returns:

the dialog

clear

protected abstract void clear()

Resets the interface.

handlesExperiment

protected abstract boolean handlesExperiment(Experiment exp)

Checks whether this type of experiment is handled by this tab.

Parameters:

exp - the experiment to check

Returns:

true if handled

fromExperiment

protected abstract void fromExperiment()

Maps the experiment onto the parameters.

toExperiment

protected abstract Experiment toExperiment()

Stores the parameters in an experiment.

Returns:

the generated experiment

setExperiment

public void setExperiment(Experiment value)

Sets the experiment to use.

Overrides:

setExperiment in class AbstractExperimenterTab

Parameters:

value - the experiment to use

apply

protected void apply()

Applies the settings to the experiment.

revert

protected void revert()

Reverts the settings to the experiment ones.

update

protected void update()

Gets called when the experiment changed.

Overrides:

update in class AbstractExperimenterTab

experimentStage

public void experimentStage(ExecutionStageEvent e)

Gets called when the experiment enters a new stage.

Specified by:

experimentStage in interface ExecutionStageListener

Overrides:

experimentStage in class AbstractExperimenterTab

Parameters:

e - the event