Class CommonToolBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JToolBar

cnuphys.splot.toolbar.CommonToolBar

All Implemented Interfaces:

ActionListener, ItemListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, SwingConstants

public class CommonToolBar
extends JToolBar
implements ActionListener, ItemListener

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BOXZOOM
static final String	CENTER
static final String	PNG
static final String	POINTER
static final String	PRINT
static final String	WORLD
static final String	ZOOMIN
static final String	ZOOMOUT

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

Fields inherited from interface javax.swing.SwingConstants

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

Constructor Summary

Constructors

Constructor	Description
CommonToolBar(int orientation)	Creates a new tool bar with a specified name and orientation.

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)
void	add(ToolBarButton button)	Add a regular button to the toolbar
void	add(JToggleButton toggleButton)	Add a toggle button to the toolbar.
void	add(JToggleButton toggleButton, boolean toGroup)	Add a toggle button to the toolbar.
void	addToolBarListener(IToolBarListener listener)	Add a toolBar listener
ToolBarToggleButton	getActiveButton()	Get which tool bar toggle button from the primary button group is active
String	getActiveCommand()	Get the command of the active toggle button
AbstractButton	getButton(String actionCommand)	Find a button from the action command
JToggleButton	getDefaultToggleButton()	Get the default toggle button.
ButtonGroup	getMainButtonGroup()	Get the primary button group so that we can add other buttons to the group
boolean	isButtonActivated(AbstractButton tbtb)	Check whether a given button is active
boolean	isDefaultActivated()	Check whether the default button is active
void	itemStateChanged(ItemEvent e)
void	remove(JToggleButton toggleButton)	remove a toggle button from the toolbar.
void	removeToolBarListener(IToolBarListener listener)	Remove a ToolBarListener.
void	resetDefaultSelection()	Reset the default toggle button selection
void	setButtonEnabled(String actionCommand, boolean enabled)	Set a button enabled by the action command
void	setDefaultToggleButton(ToolBarToggleButton defaultToggleButton)	Set the default toggle button.
void	setSelectedToggle(String s)	Set which toggle buttonis selected

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

ZOOMIN

public static final String ZOOMIN

See Also:

• Constant Field Values

ZOOMOUT

public static final String ZOOMOUT

See Also:

• Constant Field Values

POINTER

public static final String POINTER

See Also:

• Constant Field Values

PRINT

public static final String PRINT

See Also:

• Constant Field Values

BOXZOOM

public static final String BOXZOOM

See Also:

• Constant Field Values

CENTER

public static final String CENTER

See Also:

• Constant Field Values

WORLD

public static final String WORLD

See Also:

• Constant Field Values

PNG

public static final String PNG

See Also:

• Constant Field Values

Constructor Details

CommonToolBar

public CommonToolBar(int orientation)

Creates a new tool bar with a specified name and orientation. All other constructors call this constructor.

Parameters:

orientation - the initial orientation -- it must be either HORIZONTAL or VERTICAL

Method Details

setSelectedToggle

public void setSelectedToggle(String s)

Set which toggle buttonis selected

getMainButtonGroup

public ButtonGroup getMainButtonGroup()

Get the primary button group so that we can add other buttons to the group

Returns:

the primary button group so that we can add other buttons to the group

add

public void add(ToolBarButton button)

Add a regular button to the toolbar

Parameters:

button - the ToolBarButton to add.

add

public void add(JToggleButton toggleButton)

Add a toggle button to the toolbar.

Parameters:

toggleButton - the button to add.

add

public void add(JToggleButton toggleButton,
 boolean toGroup)

Add a toggle button to the toolbar.

Parameters:

toggleButton - the button to add.

toGroup - if true and to the primary button group

remove

public void remove(JToggleButton toggleButton)

remove a toggle button from the toolbar.

Parameters:

toggleButton - the button to remove.

getDefaultToggleButton

public JToggleButton getDefaultToggleButton()

Get the default toggle button. This will become active if you click an active toggle button to turn it off.

Returns:

the default toggle buton.

setDefaultToggleButton

public void setDefaultToggleButton(ToolBarToggleButton defaultToggleButton)

Set the default toggle button. This will become active if you click an active toggle button to turn it off.

Parameters:

defaultToggleButton - the default toggle button.

resetDefaultSelection

public void resetDefaultSelection()

Reset the default toggle button selection

getActiveCommand

public String getActiveCommand()

Get the command of the active toggle button

Returns:

the command of the active toggle button

getActiveButton

public ToolBarToggleButton getActiveButton()

Get which tool bar toggle button from the primary button group is active

Returns:

the active toolbar toggle button (from the primary button group), or null.

isDefaultActivated

public boolean isDefaultActivated()

Check whether the default button is active

Returns:

true if the default button is active.

isButtonActivated

public boolean isButtonActivated(AbstractButton tbtb)

Check whether a given button is active

Parameters:

tbtb - the button to test

Returns:

true if the default button is active.

addToolBarListener

public void addToolBarListener(IToolBarListener listener)

Add a toolBar listener

Parameters:

ToolBarListener - the listener to add

removeToolBarListener

public void removeToolBarListener(IToolBarListener listener)

Remove a ToolBarListener.

Parameters:

ToolBarListener - the ToolBarListener to remove.

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

itemStateChanged

public void itemStateChanged(ItemEvent e)

Specified by:

itemStateChanged in interface ItemListener

getButton

public AbstractButton getButton(String actionCommand)

Find a button from the action command

Parameters:

actionCommand - the action command to match

Returns:

the button or null if not found

setButtonEnabled

public void setButtonEnabled(String actionCommand,
 boolean enabled)

Set a button enabled by the action command

Parameters:

actionCommand - the action command

enabled - the flag