meka.gui.experimenter

Class AbstractExperimenterTab

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

meka.gui.core.MekaPanel

meka.gui.experimenter.AbstractExperimenterTab

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, ExecutionStageListener

Direct Known Subclasses:

AbstractSetupTab, LogTab, Statistics

public abstract class AbstractExperimenterTab
extends MekaPanel
implements ExecutionStageListener

Ancestor for experimenter tabs.

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 Experiment	m_Experiment the current experiment.
protected Experimenter	m_Owner the owning experimenter.

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

Method Summary

Modifier and Type	Method and Description
void	clearStatus() Clears status message.
void	experimentStage(ExecutionStageEvent e) Gets called when the experiment enters a new stage.
void	finishBusy() Stops the animated icon, without setting status message.
void	finishBusy(String msg) Stops the animated icon, setting the specified status message.
Experiment	getExperiment() Returns the current experiment.
JMenu	getMenu() Returns an optional menu to be added to the Experimenter menu.
Experimenter	getOwner() Returns the Experimenter instance this tab belongs to.
static List<String>	getTabs() Returns all the available tabs.
abstract String	getTitle() Returns the title of the tab.
String	handleException(String msg, Throwable t) Logs the stacktrace along with the message on the log tab and returns a combination of both of them as string.
boolean	hasExperiment() Returns whether experiment is currently present.
protected void	initialize() Initializes the members.
protected void	log(String msg) For logging messages.
void	setExperiment(Experiment value) Sets the experiment to use.
void	setOwner(Experimenter value) Sets the Experimenter instance this tab belongs to.
void	showStatus(String msg) Displays the specified status message.
void	startBusy() Starts the animated icon, without setting status message.
void	startBusy(String msg) Starts the animated icon, setting the specified status message.
protected void	update() Gets called when the experiment changed.

Methods inherited from class meka.gui.core.MekaPanel

closeParent, finishInit, getParentDialog, getParentFrame, initGUI

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_Owner

protected Experimenter m_Owner

the owning experimenter.

m_Experiment

protected Experiment m_Experiment

the current experiment.

Constructor Detail

AbstractExperimenterTab

public AbstractExperimenterTab()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class MekaPanel

setOwner

public void setOwner(Experimenter value)

Sets the Experimenter instance this tab belongs to.

Parameters:

value - the Experimenter instance

getOwner

public Experimenter getOwner()

Returns the Experimenter instance this tab belongs to.

Returns:

the Experimenter instance

getTitle

public abstract String getTitle()

Returns the title of the tab.

Returns:

the title

getMenu

public JMenu getMenu()

Returns an optional menu to be added to the Experimenter menu.
Default implementation returns null.

Returns:

the menu

hasExperiment

public boolean hasExperiment()

Returns whether experiment is currently present.

Returns:

true if experiment is loaded

getExperiment

public Experiment getExperiment()

Returns the current experiment.

Returns:

the experiment, can be null if none set

setExperiment

public void setExperiment(Experiment value)

Sets the experiment to use.

Parameters:

value - the experiment to use

update

protected void update()

Gets called when the experiment changed.

Default implementation does nothing.

showStatus

public void showStatus(String msg)

Displays the specified status message.

Parameters:

msg - the message to display

clearStatus

public void clearStatus()

Clears status message.

startBusy

public void startBusy()

Starts the animated icon, without setting status message.

startBusy

public void startBusy(String msg)

Starts the animated icon, setting the specified status message.

Parameters:

msg - the message to display

finishBusy

public void finishBusy()

Stops the animated icon, without setting status message.

finishBusy

public void finishBusy(String msg)

Stops the animated icon, setting the specified status message.

Parameters:

msg - the message to display

getTabs

public static List<String> getTabs()

Returns all the available tabs.

Returns:

the classnames of the tabs

log

protected void log(String msg)

For logging messages. Uses stderr if no listeners defined.

Parameters:

msg - the message to output

handleException

public String handleException(String msg,
                              Throwable t)

Logs the stacktrace along with the message on the log tab and returns a combination of both of them as string.

Parameters:

msg - the message for the exception

t - the exception

Returns:

the full error message (message + stacktrace)

experimentStage

public void experimentStage(ExecutionStageEvent e)

Gets called when the experiment enters a new stage.
Default implementation does nothing.

Specified by:

experimentStage in interface ExecutionStageListener

Parameters:

e - the event