com.jgraph.editor.factory
Class JGraphEditorToolbox

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JToolBar
                  com.jgraph.editor.factory.JGraphEditorToolbox

All Implemented Interfaces:

Accessible, ImageObserver, MenuContainer, Serializable, SwingConstants

public class JGraphEditorToolbox

extends JToolBar

A toolbox that contains a set of tools to be installed as marquee handlers in a graph. Toolboxes are created using the built-in JGraphEditorFactory.createToolbox(Node).

See Also:

Serialized Form

Nested Class Summary

class

JGraphEditorToolbox.MarqueeRedirector A class that redirects marquee events to the marquee handler it replaces or to the selection tool of the enclosing toolbox depending on the return value of BasicMarqueeHandler.isForceMarqueeEvent(MouseEvent) of the previousMarqueeHandler.

Nested classes inherited from class javax.swing.JToolBar

JToolBar.AccessibleJToolBar, JToolBar.Separator

Nested classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected AbstractButton	defaultButton References the default tool button which is activated after the use of any other tool.
protected org.jgraph.JGraph	graph References the graph that is currently installed, ie the graph that is used to interact with the selection tool.
protected org.jgraph.graph.BasicMarqueeHandler	previousMarqueeHandler References the previous marquee handler.
protected org.jgraph.graph.BasicMarqueeHandler	redirector Holds the marquee redirector.
protected JGraphEditorTool	selectionTool References the tool that is currently selected, ie the tool that is used to interact with the graph.
static boolean	SWITCH_BACK Specifies whether the toolbox should select the default button after a gesture with another tool if the default button exists.

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

JGraphEditorToolbox()
Constructs a new toolbox.

Method Summary

org.jgraph.JGraph	getGraph() Returns the installed graph.
JGraphEditorTool	getSelectionTool() Returns the selected tool.
void	setDefaultButton(AbstractButton defaultButton) Sets the default tool, which is activated after single use of any other tool.
void	setGraph(org.jgraph.JGraph newGraph) Sets the installed graph and restores the marquee handler on the previously installed graph.
void	setSelectionTool(JGraphEditorTool selectionTool) Sets the selected tool.

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, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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

SWITCH_BACK

public static boolean SWITCH_BACK

Specifies whether the toolbox should select the default button after a gesture with another tool if the default button exists. By default, the default button is assigned to be the first inserted button (see JGraphEditorFactory.configureToolbox) and the default for this value is false.

redirector

protected org.jgraph.graph.BasicMarqueeHandler redirector

Holds the marquee redirector.

previousMarqueeHandler

protected org.jgraph.graph.BasicMarqueeHandler previousMarqueeHandler

References the previous marquee handler.

selectionTool

protected JGraphEditorTool selectionTool

References the tool that is currently selected, ie the tool that is used to interact with the graph.

defaultButton

protected AbstractButton defaultButton

References the default tool button which is activated after the use of any other tool.

graph

protected org.jgraph.JGraph graph

References the graph that is currently installed, ie the graph that is used to interact with the selection tool.

Constructor Detail

JGraphEditorToolbox

public JGraphEditorToolbox()

Constructs a new toolbox.

Method Detail

getGraph

public org.jgraph.JGraph getGraph()

Returns the installed graph.

Returns:

Returns the installed graph.

setGraph

public void setGraph(org.jgraph.JGraph newGraph)

Sets the installed graph and restores the marquee handler on the previously installed graph.

Parameters:

newGraph - The graph to be installed.

setDefaultButton

public void setDefaultButton(AbstractButton defaultButton)

Sets the default tool, which is activated after single use of any other tool.

getSelectionTool

public JGraphEditorTool getSelectionTool()

Returns the selected tool.

Returns:

Returns the selected tool.

setSelectionTool

public void setSelectionTool(JGraphEditorTool selectionTool)

Sets the selected tool.

Parameters:

selectionTool - The tool to be selected.