com.metamatrix.toolbox.ui.widget
Class ToolBar

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JToolBar
                  com.metamatrix.toolbox.ui.widget.ToolBar

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.SwingConstants

public class ToolBar
extends javax.swing.JToolBar

Like the JToolBar class, the Toolbar is a UI component meant to house commonly-used controls. The only major change, compared to the JToolBar, is that the Toolbar creates ButtonWidgets when dealing with Action objects.

Because of this change, we had to copy in some of the private implementation mechanisms used in the JToolBar class. This includes the registerButtonForAction and unregisterButtonForAction methods, as well as the inner class ActionChangedListener. The two aforementioned methods utilize this inner class. Other calls to superclass methods will call this class's implementation of the register/unregister methods.

Since:

2.1

Version:

2.1

Author:

mbrinkmeier, John P. A. Verhaeg

See Also:

add(Action), Serialized Form

Nested Class Summary

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

javax.swing.JToolBar.AccessibleJToolBar, javax.swing.JToolBar.Separator

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

ToolBar()
Creates an empty, floatable toolbar oriented in the X direction

ToolBar(int orientation)
Creates and empty, floatable toolbar oriented according to the orientation parameter.

Method Summary

javax.swing.JButton	add(javax.swing.Action action)
protected void	addImpl(java.awt.Component component, java.lang.Object constraints, int index)
void	addSeparator()
void	addSeparator(java.awt.Dimension d)
void	addSeparator(java.awt.Dimension d, int gap)
void	addSeparator(java.awt.Insets insets)
void	addSeparator(int gap)
java.awt.Container	getButtonContainer()
java.awt.Component	getComponentAtIndex(int index)
int	getComponentIndex(java.awt.Component component)
protected void	initializeToolBar() Sets toolBar margins, changes layout to BorderLayout to accomodate left and right scrolling buttons, and adds ComponnentListener to dynamically add and remove scrolling buttons as necessary.
void	remove(java.awt.Component comp)
void	remove(int index)
void	removeAll()
void	setLayout(java.awt.LayoutManager layout)
protected void	unregisterButtonForAction(javax.swing.JButton item)
protected void	updateScrollButtons()
void	updateUI()

Methods inherited from class javax.swing.JToolBar

createActionChangeListener, createActionComponent, getAccessibleContext, getMargin, getOrientation, getUI, getUIClassID, isBorderPainted, isFloatable, isRollover, paintBorder, paramString, setBorderPainted, setFloatable, setMargin, setOrientation, setRollover, setUI

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, 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, 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, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, 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, hide, 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, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolBar

public ToolBar()

Creates an empty, floatable toolbar oriented in the X direction

Since:

2.1

ToolBar

public ToolBar(int orientation)

Creates and empty, floatable toolbar oriented according to the orientation parameter.

Since:

2.1

Method Detail

add

public javax.swing.JButton add(javax.swing.Action action)

Overrides:

add in class javax.swing.JToolBar

addImpl

protected void addImpl(java.awt.Component component,
                       java.lang.Object constraints,
                       int index)

Overrides:

addImpl in class javax.swing.JToolBar

Since:

2.1

addSeparator

public void addSeparator()

Overrides:

addSeparator in class javax.swing.JToolBar

addSeparator

public void addSeparator(int gap)

addSeparator

public void addSeparator(java.awt.Dimension d)

Overrides:

addSeparator in class javax.swing.JToolBar

addSeparator

public void addSeparator(java.awt.Dimension d,
                         int gap)

addSeparator

public void addSeparator(java.awt.Insets insets)

getButtonContainer

public java.awt.Container getButtonContainer()

Since:

2.1

getComponentIndex

public int getComponentIndex(java.awt.Component component)

Overrides:

getComponentIndex in class javax.swing.JToolBar

Since:

2.1

getComponentAtIndex

public java.awt.Component getComponentAtIndex(int index)

Overrides:

getComponentAtIndex in class javax.swing.JToolBar

Since:

2.1

initializeToolBar

protected void initializeToolBar()

Sets toolBar margins, changes layout to BorderLayout to accomodate left and right scrolling buttons, and adds ComponnentListener to dynamically add and remove scrolling buttons as necessary.

Since:

2.1

setLayout

public void setLayout(java.awt.LayoutManager layout)

Overrides:

setLayout in class javax.swing.JToolBar

Since:

2.1

unregisterButtonForAction

protected void unregisterButtonForAction(javax.swing.JButton item)

updateScrollButtons

protected void updateScrollButtons()

Since:

2.1

updateUI

public void updateUI()

Overrides:

updateUI in class javax.swing.JToolBar

Since:

2.1

remove

public void remove(java.awt.Component comp)

Overrides:

remove in class java.awt.Container

See Also:

Container.remove(Component)

remove

public void remove(int index)

Overrides:

remove in class java.awt.Container

See Also:

Container.remove(int)

removeAll

public void removeAll()

Overrides:

removeAll in class java.awt.Container

See Also:

Container.removeAll()