Package adams.gui.core

Class ToolBarPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

adams.gui.core.BasePanel

adams.gui.core.ToolBarPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

FlowEditorPanel, FlowRunnerPanel, SpreadSheetViewerPanel, ToolBarUndoPanel

public abstract class ToolBarPanel
extends BasePanel

Specialized panel with a toolbar. The actual content panel is accessible using getContentPanel().

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ToolBarPanel.ToolBarLocation	The location of the toolbar.

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 BasePanel	m_ContentPanel	the actual content panel.
protected ToolBarPanel.ToolBarLocation	m_Location	the location of the toolbar.
protected JToolBar	m_ToolBar	the toolbar.

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

Method Summary

Modifier and Type	Method	Description
void	addSeparator()	Adds a separator to the toolbar.
JButton	addToToolBar(Action action)	Adds the specified action to the toolbar.
Component	addToToolBar(JComponent comp)	Adds the specified component to the toolbar.
protected void	finishInit()	Finishes the initialization, setting up actions and toolbar.
BasePanel	getContentPanel()	Returns the content panel.
JToolBar	getToolBar()	Returns the underlying toolbar.
Component	getToolBarComponentAtIndex(int index)	Returns the component at the specified index.
int	getToolBarComponentCount()	Returns the number of components in the toolbar.
ToolBarPanel.ToolBarLocation	getToolBarLocation()	Returns the location of the toolbar.
protected abstract void	initActions()	Sets up all the actions.
protected void	initGUI()	Initializes the widgets.
protected void	initialize()	Initializes the members.
protected abstract void	initToolBar()	Sets up the toolbar, using the actions.
boolean	isFloatable()	Returns whether the toolbar is floatable or not, i.e., whether the user can move the toolbar around.
void	removeFromToolBar(JComponent comp)	Removes the specified component from the toolbar.
void	setFloatable(boolean value)	Sets whether the toolbar is to be floatable or not, i.e., whether the user can move the toolbar around.
void	setToolBarLocation(ToolBarPanel.ToolBarLocation value)	Sets the location of the toolbar.
protected abstract void	updateActions()	Updates the enabled state of the actions.

Methods inherited from class adams.gui.core.BasePanel

afterHide, afterShow, beforeHide, beforeShow, closeParent, getParentChild, getParentDialog, getParentFrame, getParentInternalFrame, getParentTitle, 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_Location

protected ToolBarPanel.ToolBarLocation m_Location

the location of the toolbar.

m_ToolBar

protected JToolBar m_ToolBar

the toolbar.

m_ContentPanel

protected BasePanel m_ContentPanel

the actual content panel.

Constructor Detail

ToolBarPanel

public ToolBarPanel()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class BasePanel

initGUI

protected void initGUI()

Initializes the widgets.

Overrides:

initGUI in class BasePanel

initActions

protected abstract void initActions()

Sets up all the actions.

See Also:

AbstractBaseAction

initToolBar

protected abstract void initToolBar()

Sets up the toolbar, using the actions.

See Also:

initActions()

finishInit

protected void finishInit()

Finishes the initialization, setting up actions and toolbar.

Overrides:

finishInit in class BasePanel

See Also:

initActions(), initToolBar(), updateActions()

setToolBarLocation

public void setToolBarLocation(ToolBarPanel.ToolBarLocation value)

Sets the location of the toolbar.

Parameters:

value - the location of the toolbar

getToolBarLocation

public ToolBarPanel.ToolBarLocation getToolBarLocation()

Returns the location of the toolbar.

Returns:

the location

addToToolBar

public JButton addToToolBar(Action action)

Adds the specified action to the toolbar.

Parameters:

action - the action to add

addToToolBar

public Component addToToolBar(JComponent comp)

Adds the specified component to the toolbar.

Parameters:

comp - the component to add

removeFromToolBar

public void removeFromToolBar(JComponent comp)

Removes the specified component from the toolbar.

Parameters:

comp - the component to remove

addSeparator

public void addSeparator()

Adds a separator to the toolbar.

getToolBarComponentCount

public int getToolBarComponentCount()

Returns the number of components in the toolbar.

Returns:

the number of components

getToolBarComponentAtIndex

public Component getToolBarComponentAtIndex(int index)

Returns the component at the specified index.

Parameters:

index - the index of the component to retrieve

Returns:

the component at the index

getToolBar

public JToolBar getToolBar()

Returns the underlying toolbar.

Returns:

the toolbar

getContentPanel

public BasePanel getContentPanel()

Returns the content panel.

Returns:

the content panel

setFloatable

public void setFloatable(boolean value)

Sets whether the toolbar is to be floatable or not, i.e., whether the user can move the toolbar around.

Parameters:

value - if true the user will be able to move the toolbar

isFloatable

public boolean isFloatable()

Returns whether the toolbar is floatable or not, i.e., whether the user can move the toolbar around.

Returns:

true if the user can move the toolbar

updateActions

protected abstract void updateActions()

Updates the enabled state of the actions.