Package com.vividsolutions.jump.workbench.ui

Class WorkbenchToolBar

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JToolBar

com.vividsolutions.jump.workbench.ui.EnableableToolBar

com.vividsolutions.jump.workbench.ui.WorkbenchToolBar

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, SwingConstants

public class WorkbenchToolBar
extends EnableableToolBar

Makes it easy to add CursorTools and PlugIns as toolbar buttons. An "EnableCheck" is used to specify whether to enable or disable the CursorTool buttons. Moreover, CursorTools are added as mutually exclusive toggle buttons (that is, JToggleButtons in a ButtonGroup). When a CursorTool button is pressed, the current CursorTool is unregistered and the new one is registered with the LayerViewPanel.

Set the cursor-tool-enable-check to use context-sensitive enabling of toolbar buttons.

Set the task-monitor-manager to report the progress of threaded plug-ins.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WorkbenchToolBar.ToolConfig

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 inherited from class com.vividsolutions.jump.workbench.ui.EnableableToolBar

buttonToEnableCheckMap, buttonToNameMap

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, CENTER, 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
WorkbenchToolBar(LayerViewPanelProxy layerViewPanelProxy)
WorkbenchToolBar(LayerViewPanelProxy layerViewPanelProxy, ButtonGroup cursorToolButtonGroup)

Method Summary

Modifier and Type	Method	Description
WorkbenchToolBar.ToolConfig	addCursorTool(CursorTool cursorTool)
WorkbenchToolBar.ToolConfig	addCursorTool(CursorTool cursorTool, JToggleButton button)	Add's a CursorTool with an own JToggleButton.
WorkbenchToolBar.ToolConfig	addCursorTool(String tooltip, CursorTool cursorTool)
JButton	addPlugIn(int index, PlugIn plugIn, Icon icon, EnableCheck enableCheck, WorkbenchContext workbenchContext)
JButton	addPlugIn(Icon icon, PlugIn plugIn, EnableCheck enableCheck, WorkbenchContext workbenchContext)
AbstractButton	getButton(Class<? extends CursorTool> cursorToolClass)
ButtonGroup	getButtonGroup()
Set<Class<? extends CursorTool>>	getCursorToolClasses()
JToggleButton	getSelectedCursorToolButton()
void	reClickSelectedCursorToolButton()
void	setCursorToolEnableCheck(EnableCheck cursorToolEnableCheck)
void	setTaskMonitorManager(TaskMonitorManager taskMonitorManager)

Methods inherited from class com.vividsolutions.jump.workbench.ui.EnableableToolBar

add, add, addSpacer, getEnableCheck, setEnableCheck, updateEnabledState

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

Constructor Detail

WorkbenchToolBar

public WorkbenchToolBar(LayerViewPanelProxy layerViewPanelProxy)

WorkbenchToolBar

public WorkbenchToolBar(LayerViewPanelProxy layerViewPanelProxy,
                        ButtonGroup cursorToolButtonGroup)

Method Detail

getButton

public AbstractButton getButton(Class<? extends CursorTool> cursorToolClass)

setCursorToolEnableCheck

public void setCursorToolEnableCheck(EnableCheck cursorToolEnableCheck)

setTaskMonitorManager

public void setTaskMonitorManager(TaskMonitorManager taskMonitorManager)

addCursorTool

public WorkbenchToolBar.ToolConfig addCursorTool(CursorTool cursorTool)

getCursorToolClasses

public Set<Class<? extends CursorTool>> getCursorToolClasses()

addCursorTool

public WorkbenchToolBar.ToolConfig addCursorTool(CursorTool cursorTool,
                                                 JToggleButton button)

Add's a CursorTool with an own JToggleButton. This is useful, if you want to add CursorTool with an own JToggleButton implementation, such a DropDownToggleButton.

addCursorTool

public WorkbenchToolBar.ToolConfig addCursorTool(String tooltip,
                                                 CursorTool cursorTool)

getButtonGroup

public ButtonGroup getButtonGroup()

getSelectedCursorToolButton

public JToggleButton getSelectedCursorToolButton()

reClickSelectedCursorToolButton

public void reClickSelectedCursorToolButton()

addPlugIn

public JButton addPlugIn(Icon icon,
                         PlugIn plugIn,
                         EnableCheck enableCheck,
                         WorkbenchContext workbenchContext)

addPlugIn

public JButton addPlugIn(int index,
                         PlugIn plugIn,
                         Icon icon,
                         EnableCheck enableCheck,
                         WorkbenchContext workbenchContext)