org.crosswire.common.swing.desktop
Class ToolBar

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JToolBar
                  org.crosswire.common.swing.desktop.ToolBar

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants

public class ToolBar
extends JToolBar

This toolbar allows for manipulating how it looks. That is it allows for:

• showing/hiding labels
• small/large icons
• showing/hiding toolbar

Author:

DM Smith [ dmsmith555 at yahoo dot com]

See Also:

for license details. The copyright to this program is held by it's authors., Serialized Form

Nested Class Summary

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

JToolBar.AccessibleJToolBar, JToolBar.Separator

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.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

private ActionFactory	actions
private JFrame	frame The frame in which the toolbar is shown.
private static long	serialVersionUID Serialization ID
private static String	TOOLBAR_LARGE
private static String	TOOLBAR_TEXT
private static String	TOOLBAR_TOGGLE

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(JFrame frame)
ToolBar constructor.

Method Summary

void	doToolBarLarge(ActionEvent ev) Show large or small tool bar icons.
void	doToolBarText(ActionEvent ev) Show or hide the tool bar text.
void	doToolBarToggle(ActionEvent ev) Show or hide the tool bar.
JMenuItem	getIconSizeToggle() Build a menu item that an end user can use to toggle the size of the icons
JMenuItem	getShowToggle() Build a menu item that an end user can use to toggle visibility of the toolbar
JMenuItem	getTextToggle() Build a menu item that an end user can use to toggle the text
void	showLargeIcons(boolean large) Sets the size of the tool bar button images.
void	showText(boolean show) Set the tool tip text for the buttons on the tool bar.
void	showToolBar(boolean show) Show or hide the tool bar.

Methods inherited from class javax.swing.JToolBar

add, addImpl, addSeparator, addSeparator, createActionChangeListener, createActionComponent, getAccessibleContext, getComponentAtIndex, getComponentIndex, getMargin, getOrientation, getUI, getUIClassID, isBorderPainted, isFloatable, isRollover, paintBorder, paramString, setBorderPainted, setFloatable, setLayout, setMargin, setOrientation, setRollover, 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, 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, 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, remove, remove, removeAll, 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

Field Detail

TOOLBAR_TOGGLE

private static final String TOOLBAR_TOGGLE

See Also:

Constant Field Values

TOOLBAR_TEXT

private static final String TOOLBAR_TEXT

See Also:

Constant Field Values

TOOLBAR_LARGE

private static final String TOOLBAR_LARGE

See Also:

Constant Field Values

frame

private JFrame frame

The frame in which the toolbar is shown. It must be border layout with the only other component being centered.

actions

private transient ActionFactory actions

serialVersionUID

private static final long serialVersionUID

Serialization ID

See Also:

Constant Field Values

Constructor Detail

ToolBar

public ToolBar(JFrame frame)

ToolBar constructor.

Method Detail

showToolBar

public void showToolBar(boolean show)

Show or hide the tool bar.

Parameters:

show - indicates whether the toolbar is visible

showText

public void showText(boolean show)

Set the tool tip text for the buttons on the tool bar.

Parameters:

show - indicates whether the buttons should be labelled

showLargeIcons

public void showLargeIcons(boolean large)

Sets the size of the tool bar button images.

Parameters:

large - indicates whether large buttons should be used

getShowToggle

public JMenuItem getShowToggle()

Build a menu item that an end user can use to toggle visibility of the toolbar

Returns:

a check box that can be used to toggle the visibility of the toolbar

getTextToggle

public JMenuItem getTextToggle()

Build a menu item that an end user can use to toggle the text

Returns:

a check box that can be used to toggle the text

getIconSizeToggle

public JMenuItem getIconSizeToggle()

Build a menu item that an end user can use to toggle the size of the icons

Returns:

a check box that can be used to toggle the size of the icons

doToolBarToggle

public void doToolBarToggle(ActionEvent ev)

Show or hide the tool bar.

doToolBarText

public void doToolBarText(ActionEvent ev)

Show or hide the tool bar text.

doToolBarLarge

public void doToolBarLarge(ActionEvent ev)

Show large or small tool bar icons.