Package adams.gui.workspace

Class AbstractWorkspacePanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.workspace.AbstractWorkspacePanel

All Implemented Interfaces:

CleanUpHandler, MenuBarProvider, ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

AbstractWorkspacePanelWithStatusBar, InvestigatorPanel, RemoteControlCenterPanel

public abstract class AbstractWorkspacePanel
extends BasePanel
implements MenuBarProvider, CleanUpHandler

The ancestor for a workspace panel.

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	Description
protected JMenuBar	m_MenuBar	the menu bar, if used.
protected TitleGenerator	m_TitleGenerator	for generating the title.

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	Description
AbstractWorkspacePanel()

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	Cleans up data structures, frees up memory.
void	close()	Closes the dialog.
protected void	finishInit()	finishes the initialization.
protected abstract String	getDefaultTitle()	Returns the default title.
abstract JMenuBar	getMenuBar()	Creates a menu bar (singleton per panel object).
String	getTitle()	Returns the base title in use by the title generator.
TitleGenerator	getTitleGenerator()	Returns the title generator in use.
protected void	initialize()	For initializing members.
abstract void	logError(String msg, String title)	Logs the error message and also displays an error dialog.
void	logError(String msg, Throwable t, String title)	Logs the exception and also displays an error dialog.
void	logError(Throwable t, String title)	Logs the exception and also displays an error dialog.
abstract void	logMessage(String msg)	Logs the message.
void	logMessage(Throwable t)	Logs the exception with no dialog.
void	setTitle(String value)	Sets the base title to use for the title generator.
void	update()	Updates title and menu items.
protected abstract void	updateMenu()	updates the enabled state of the menu items.
protected abstract void	updateTitle()	Updates the title of the dialog.

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, initGUI, main, printErrorMessage, printException, setEnabledCascade, setEnabledCascade, setParentTitle, setVisible

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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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_MenuBar

protected JMenuBar m_MenuBar

the menu bar, if used.

m_TitleGenerator

protected TitleGenerator m_TitleGenerator

for generating the title.

Constructor Detail

AbstractWorkspacePanel

public AbstractWorkspacePanel()

Method Detail

initialize

protected void initialize()

For initializing members.

Overrides:

initialize in class BasePanel

finishInit

protected void finishInit()

finishes the initialization.

Overrides:

finishInit in class BasePanel

close

public void close()

Closes the dialog.

getMenuBar

public abstract JMenuBar getMenuBar()

Creates a menu bar (singleton per panel object). Can be used in frames.

Specified by:

getMenuBar in interface MenuBarProvider

Returns:

the menu bar

update

public void update()

Updates title and menu items.

getTitleGenerator

public TitleGenerator getTitleGenerator()

Returns the title generator in use.

Returns:

the generator

updateTitle

protected abstract void updateTitle()

Updates the title of the dialog.

updateMenu

protected abstract void updateMenu()

updates the enabled state of the menu items.

getDefaultTitle

protected abstract String getDefaultTitle()

Returns the default title.

Returns:

the default title

setTitle

public void setTitle(String value)

Sets the base title to use for the title generator.

Parameters:

value - the title to use

See Also:

m_TitleGenerator

getTitle

public String getTitle()

Returns the base title in use by the title generator.

Returns:

the title in use

See Also:

m_TitleGenerator

logMessage

public void logMessage(Throwable t)

Logs the exception with no dialog.

Parameters:

t - the exception

logMessage

public abstract void logMessage(String msg)

Logs the message.

Parameters:

msg - the log message

logError

public void logError(String msg,
                     Throwable t,
                     String title)

Logs the exception and also displays an error dialog.

Parameters:

msg - the log message

t - the exception

title - the title for the dialog

logError

public void logError(Throwable t,
                     String title)

Logs the exception and also displays an error dialog.

Parameters:

t - the exception

title - the title for the dialog

logError

public abstract void logError(String msg,
                              String title)

Logs the error message and also displays an error dialog.

Parameters:

msg - the error message

title - the title for the dialog

cleanUp

public void cleanUp()

Cleans up data structures, frees up memory.
Default implementation does nothing.

Specified by:

cleanUp in interface CleanUpHandler