org.jgraph.plaf.basic
Class BasicGraphUI

java.lang.Object
  javax.swing.plaf.ComponentUI
      org.jgraph.plaf.GraphUI
          org.jgraph.plaf.basic.BasicGraphUI

All Implemented Interfaces:

Serializable

public class BasicGraphUI
extends GraphUI
implements Serializable

The basic L&F for a graph data structure.

Version:

1.0 1/1/02

Author:

Gaudenz Alder

See Also:

Serialized Form

Nested Class Summary

class	BasicGraphUI.CellEditorHandler Listener responsible for getting cell editing events and updating the graph accordingly.
class	BasicGraphUI.ComponentHandler Updates the preferred size when scrolling (if necessary).
class	BasicGraphUI.GraphDropTargetListener Graph Drop Target Listener
class	BasicGraphUI.GraphIncrementAction GraphIncrementAction is used to handle up/down actions.
class	BasicGraphUI.GraphModelHandler Listens for changes in the graph model and updates the view accordingly.
class	BasicGraphUI.GraphSelectionHandler Listens for changes in the selection model and updates the display accordingly.
class	BasicGraphUI.GraphTransferHandler
class	BasicGraphUI.GraphViewObserver Listens for changes in the graph view and updates the size accordingly.
class	BasicGraphUI.KeyHandler This is used to get mutliple key down events to appropriately generate events.
class	BasicGraphUI.MouseHandler TreeMouseListener is responsible for updating the selection based on mouse events.
class	BasicGraphUI.MouseInputHandler MouseInputHandler handles passing all mouse events, including mouse motion events, until the mouse is released to the destination it is constructed with.
class	BasicGraphUI.PropertyChangeHandler PropertyChangeListener for the graph.
class	BasicGraphUI.RootHandle

Field Summary

protected GraphCellEditor	cellEditor Current editor for the graph.
protected CellEditorListener	cellEditorListener Listens for CellEditor events.
protected ComponentListener	componentListener Listens for Component events.
protected BasicGraphUI.GraphDropTargetListener	defaultDropTargetListener The default DropTargetListener.
protected TransferHandler	defaultTransferHandler The default TransferHandler.
static boolean	DNDPREVIEW Controls live-preview in dragEnabled mode.
protected int	dropAction Needed to exchange information between DropTargetHandler and TransferHandler.
protected Object	editingCell Path that is being edited.
protected Component	editingComponent When editing, this will be the Component that is doing the actual editing.
protected boolean	editorHasDifferentSize Set to true if the editor has a different size than the renderer.
protected CellView	focus The focused cell under the mousepointer.
protected JGraph	graph Component that we're going to be drawing into.
protected GraphLayoutCache	graphLayoutCache Reference to the graph's view (geometric pattern).
protected GraphModel	graphModel Used to determine what to display.
protected GraphModelListener	graphModelListener Is responsible for updating the view based on model events.
protected GraphSelectionListener	graphSelectionListener Updates the display when the selection changes.
protected GraphSelectionModel	graphSelectionModel Model maintaining the selection.
protected Observer	graphViewObserver Updates the display when the view has changed.
protected CellHandle	handle Handle that we are going to use.
protected Point	insertionLocation Needed to exchange information between Transfer- and MouseListener.
protected KeyListener	keyListener Listens for KeyListener events.
protected BasicMarqueeHandler	marquee Marquee that we are going to use.
static int	MAXCELLS The maximum number of cells to paint when dragging.
static int	MAXCLIPCELLS Maximum number of cells to compute clipping bounds for.
static int	MAXHANDLES The maximum number of handles to paint individually.
protected MouseListener	mouseListener Listens for Mouse events.
protected Dimension	preferredMinSize Minimum preferred size.
protected Dimension	preferredSize Size needed to completely display all the cells.
protected PropertyChangeListener	propertyChangeListener Listens for JGraph property changes and updates display.
protected CellRendererPane	rendererPane Used to paint the CellRenderer.
static int	SCROLLBORDER Border in pixels to scroll if marquee or dragging are active.
static float	SCROLLSTEP Multiplicator for width and height when autoscrolling (=stepsize).
protected boolean	snapSelectedView If ture, a the view under mousepointer will be snapped to the grid lines during a drag operation.
protected boolean	stopEditingInCompleteEditing Set to false when editing and shouldSelectCell() returns true meaning the node should be selected before editing, used in completeEditing.
protected boolean	validCachedPreferredSize Is the preferredSize valid?

Constructor Summary

BasicGraphUI()

Method Summary

static void	autoscroll(JGraph graph, Point p) Scroll the graph for an event at p.
void	cancelEditing(JGraph graph) Cancels all current editing sessions.
protected void	completeEditing() Messages to stop the editing session.
protected void	completeEditing(boolean messageStop, boolean messageCancel, boolean messageGraph) Stops the editing session.
protected void	completeUIInstall() Invoked from installUI after all the defaults/listeners have been installed.
protected void	completeUIUninstall()
protected CellEditorListener	createCellEditorListener() Creates a listener to handle events from the current editor.
protected CellRendererPane	createCellRendererPane() Returns the renderer pane that renderer components are placed in.
protected ComponentListener	createComponentListener() Creates and returns a new ComponentHandler.
protected GraphContext	createContext(JGraph graph, Object[] cells)
protected GraphModelListener	createGraphModelListener() Returns a listener that can update the graph when the model changes.
protected GraphSelectionListener	createGraphSelectionListener() Creates the listener that updates the display based on selection change methods.
protected Observer	createGraphViewObserver() Returns a listener that can update the graph when the view changes.
CellHandle	createHandle(GraphContext context) Constructs the "root handle" for context.
protected KeyListener	createKeyListener() Creates the listener reponsible for getting key events from the graph.
protected MouseListener	createMouseListener() Creates the listener responsible for calling the correct handlers based on mouse events, and to select invidual cells.
protected PropertyChangeListener	createPropertyChangeListener() Creates a listener that is responsible to update the UI based on how the graph's bounds properties change.
protected TransferHandler	createTransferHandler() Creates an instance of TransferHandler.
static ComponentUI	createUI(JComponent x)
Object	getEditingCell(JGraph graph) Returns the element that is being edited.
protected Object	getFocusedCell() Returns the cell that has the focus.
CellHandle	getHandle(JGraph graph) Returns the handle that is currently active, or null, if no handle is currently active.
Point	getInsertionLocation() Returns the current location of the Drag-and-Drop activity.
Dimension	getMaximumSize(JComponent c) Returns the maximum size for this component, which will be the preferred size if the instance is currently in a JGraph, or 0, 0.
Dimension	getMinimumSize(JComponent c) Returns the minimum size for this component.
Dimension	getPreferredMinSize() Returns the minimum preferred size.
Dimension	getPreferredSize(JComponent c) Returns the preferred size to properly display the graph.
Dimension	getPreferredSize(JGraph graph, CellView view) Get the preferred Size for a cell view.
void	insertCells(Object[] cells, Map viewAttributeMap, ConnectionSet cs, ParentMap pm, boolean clone, int dx, int dy) Insert the specified cells into the model.
protected void	installComponents() Intalls the subcomponents of the graph, which is the renderer pane.
protected void	installDefaults() Invoked as part from the boilerplate install block.
protected void	installKeyboardActions() Invoked as part from the boilerplate install block.
protected void	installListeners() Invoked as part from the boilerplate install block.
void	installUI(JComponent c)
boolean	isAddToSelectionEvent(MouseEvent e) Returning true signifies that cells are added to the selection.
boolean	isConstrainedMoveEvent(MouseEvent event) Returning true signifies a move should only be applied to one direction.
boolean	isEditing(JGraph graph) Returns true if the graph is being edited.
boolean	isForceMarqueeEvent(MouseEvent event) Returning true signifies the marquee handler has precedence over other handlers, and is receiving subsequent mouse events.
boolean	isSnapSelectedView()
boolean	isToggleSelectionEvent(MouseEvent event) Returning true signifies a mouse event on the cell should toggle the selection of only the cell under mouse.
void	paint(Graphics g, JComponent c) Main painting routine.
protected void	paintBackground(Graphics g) Paint the background of this graph.
void	paintCell(Graphics g, CellView view, Rectangle bounds, boolean preview) Paints the renderer of view to g at bounds.
protected void	paintForeground(Graphics g) Paint the foreground of this graph.
protected void	paintGrid(int gs, Graphics g, Rectangle r) Paint the grid.
void	paintPorts(Graphics g, CellView[] ports) Paint ports.
protected void	prepareForUIInstall() Invoked after the graph instance variable has been set, but before any defaults/listeners have been installed.
void	selectCellForEvent(Object cell, MouseEvent event) Messaged to update the selection based on a MouseEvent over a particular cell.
void	selectCellsForEvent(JGraph graph, Object[] cells, MouseEvent event) From GraphUI interface.
void	selectCellsForEvent(Object[] cells, MouseEvent event) Messaged to update the selection based on a MouseEvent for a group of cells.
protected void	setGraphLayoutCache(GraphLayoutCache view) Sets the GraphLayoutCache (geometric pattern).
void	setInsertionLocation(Point p) Sets the current location for Drag-and-Drop activity.
protected void	setMarquee(BasicMarqueeHandler marqueeHandler) Sets the marquee handler.
protected void	setModel(GraphModel model) Sets the GraphModel.
void	setPreferredMinSize(Dimension newSize) Sets the preferred minimum size.
protected void	setSelectionModel(GraphSelectionModel newLSM) Resets the selection model.
void	setSnapSelectedView(boolean snapSelectedView) Sets the mode of the snapSelectedView drag operation.
protected boolean	startEditing(Object cell, MouseEvent event) Will start editing for cell if there is a cellEditor and shouldSelectCell returns true.
void	startEditingAtCell(JGraph graph, Object cell) Selects the cell and tries to edit it.
boolean	stopEditing(JGraph graph) Stops the current editing session.
protected void	toggleSelectionCellForEvent(Object cell, MouseEvent event) Messaged to update the selection based on a toggle selection event, which means the cell's selection state is inverted.
protected void	uninstallComponents() Uninstalls the renderer pane.
protected void	uninstallKeyboardActions()
protected void	uninstallListeners()
void	uninstallUI(JComponent c)
protected void	updateCachedPreferredSize() Updates the preferredSize instance variable, which is returned from getPreferredSize().
protected void	updateHandle() Update the handle using createHandle.
void	updateSize() Messages the Graph with graphDidChange.

Methods inherited from class javax.swing.plaf.ComponentUI

contains, getAccessibleChild, getAccessibleChildrenCount, update

Methods inherited from class java.lang.Object

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

Field Detail

DNDPREVIEW

public static final boolean DNDPREVIEW

Controls live-preview in dragEnabled mode. This is used to disable live-preview in dragEnabled mode on Java 1.4.1 to workaround a bug that cause the VM to hang during concurrent DnD and repaints.

SCROLLBORDER

public static int SCROLLBORDER

Border in pixels to scroll if marquee or dragging are active.

SCROLLSTEP

public static float SCROLLSTEP

Multiplicator for width and height when autoscrolling (=stepsize).

MAXCELLS

public static int MAXCELLS

The maximum number of cells to paint when dragging.

MAXHANDLES

public static int MAXHANDLES

The maximum number of handles to paint individually.

MAXCLIPCELLS

public static int MAXCLIPCELLS

Maximum number of cells to compute clipping bounds for.

preferredMinSize

protected Dimension preferredMinSize

Minimum preferred size.

graph

protected JGraph graph

Component that we're going to be drawing into.

graphLayoutCache

protected GraphLayoutCache graphLayoutCache

Reference to the graph's view (geometric pattern).

cellEditor

protected GraphCellEditor cellEditor

Current editor for the graph.

stopEditingInCompleteEditing

protected boolean stopEditingInCompleteEditing

Set to false when editing and shouldSelectCell() returns true meaning the node should be selected before editing, used in completeEditing.

rendererPane

protected CellRendererPane rendererPane

Used to paint the CellRenderer.

preferredSize

protected Dimension preferredSize

Size needed to completely display all the cells.

validCachedPreferredSize

protected boolean validCachedPreferredSize

Is the preferredSize valid?

graphModel

protected GraphModel graphModel

Used to determine what to display.

graphSelectionModel

protected GraphSelectionModel graphSelectionModel

Model maintaining the selection.

handle

protected CellHandle handle

Handle that we are going to use.

marquee

protected BasicMarqueeHandler marquee

Marquee that we are going to use.

editingComponent

protected Component editingComponent

When editing, this will be the Component that is doing the actual editing.

focus

protected CellView focus

The focused cell under the mousepointer.

editingCell

protected Object editingCell

Path that is being edited.

editorHasDifferentSize

protected boolean editorHasDifferentSize

Set to true if the editor has a different size than the renderer.

insertionLocation

protected Point insertionLocation

Needed to exchange information between Transfer- and MouseListener.

dropAction

protected int dropAction

Needed to exchange information between DropTargetHandler and TransferHandler.

snapSelectedView

protected boolean snapSelectedView

If ture, a the view under mousepointer will be snapped to the grid lines during a drag operation. If snap-to-grid mode is disabled, views are moved by a snap increment.

propertyChangeListener

protected PropertyChangeListener propertyChangeListener

Listens for JGraph property changes and updates display.

mouseListener

protected MouseListener mouseListener

Listens for Mouse events.

keyListener

protected KeyListener keyListener

Listens for KeyListener events.

componentListener

protected ComponentListener componentListener

Listens for Component events.

cellEditorListener

protected CellEditorListener cellEditorListener

Listens for CellEditor events.

graphSelectionListener

protected GraphSelectionListener graphSelectionListener

Updates the display when the selection changes.

graphModelListener

protected GraphModelListener graphModelListener

Is responsible for updating the view based on model events.

graphViewObserver

protected Observer graphViewObserver

Updates the display when the view has changed.

defaultTransferHandler

protected TransferHandler defaultTransferHandler

The default TransferHandler.

defaultDropTargetListener

protected BasicGraphUI.GraphDropTargetListener defaultDropTargetListener

The default DropTargetListener.

Constructor Detail

BasicGraphUI

public BasicGraphUI()

Method Detail

createUI

public static ComponentUI createUI(JComponent x)

setModel

protected void setModel(GraphModel model)

Sets the GraphModel. This invokes updateSize.

setGraphLayoutCache

protected void setGraphLayoutCache(GraphLayoutCache view)

Sets the GraphLayoutCache (geometric pattern). This invokes updateSize.

setMarquee

protected void setMarquee(BasicMarqueeHandler marqueeHandler)

Sets the marquee handler.

setSelectionModel

protected void setSelectionModel(GraphSelectionModel newLSM)

Resets the selection model. The appropriate listeners are installed on the model.

getHandle

public CellHandle getHandle(JGraph graph)

Returns the handle that is currently active, or null, if no handle is currently active. Typically, the returned objects are instances of the RootHandle inner class.

Specified by:

getHandle in class GraphUI

getFocusedCell

protected Object getFocusedCell()

Returns the cell that has the focus.

getPreferredSize

public Dimension getPreferredSize(JGraph graph,
                                  CellView view)

Get the preferred Size for a cell view.

Specified by:

getPreferredSize in class GraphUI

getInsertionLocation

public Point getInsertionLocation()

Returns the current location of the Drag-and-Drop activity.

setInsertionLocation

public void setInsertionLocation(Point p)

Sets the current location for Drag-and-Drop activity. Should be set to null after a drop. Used from within DropTargetListener.

selectCellsForEvent

public void selectCellsForEvent(JGraph graph,
                                Object[] cells,
                                MouseEvent event)

From GraphUI interface.

Specified by:

selectCellsForEvent in class GraphUI

selectCellsForEvent

public void selectCellsForEvent(Object[] cells,
                                MouseEvent event)

Messaged to update the selection based on a MouseEvent for a group of cells. If the event is a toggle selection event, the cells are either selected, or deselected. Otherwise the cells are selected.

selectCellForEvent

public void selectCellForEvent(Object cell,
                               MouseEvent event)

Messaged to update the selection based on a MouseEvent over a particular cell. If the event is a toggle selection event, the cell is either selected, or deselected. Otherwise the cell is selected.

toggleSelectionCellForEvent

protected void toggleSelectionCellForEvent(Object cell,
                                           MouseEvent event)

Messaged to update the selection based on a toggle selection event, which means the cell's selection state is inverted.

isAddToSelectionEvent

public boolean isAddToSelectionEvent(MouseEvent e)

Returning true signifies that cells are added to the selection.

isToggleSelectionEvent

public boolean isToggleSelectionEvent(MouseEvent event)

Returning true signifies a mouse event on the cell should toggle the selection of only the cell under mouse.

isForceMarqueeEvent

public boolean isForceMarqueeEvent(MouseEvent event)

Returning true signifies the marquee handler has precedence over other handlers, and is receiving subsequent mouse events.

isConstrainedMoveEvent

public boolean isConstrainedMoveEvent(MouseEvent event)

Returning true signifies a move should only be applied to one direction.

isEditing

public boolean isEditing(JGraph graph)

Returns true if the graph is being edited. The item that is being edited can be returned by getEditingPath().

Specified by:

isEditing in class GraphUI

stopEditing

public boolean stopEditing(JGraph graph)

Stops the current editing session. This has no effect if the graph isn't being edited. Returns true if the editor allows the editing session to stop.

Specified by:

stopEditing in class GraphUI

cancelEditing

public void cancelEditing(JGraph graph)

Cancels all current editing sessions.

Specified by:

cancelEditing in class GraphUI

startEditingAtCell

public void startEditingAtCell(JGraph graph,
                               Object cell)

Selects the cell and tries to edit it. Editing will fail if the CellEditor won't allow it for the selected item.

Specified by:

startEditingAtCell in class GraphUI

getEditingCell

public Object getEditingCell(JGraph graph)

Returns the element that is being edited.

Specified by:

getEditingCell in class GraphUI

installUI

public void installUI(JComponent c)

Overrides:

installUI in class ComponentUI

prepareForUIInstall

protected void prepareForUIInstall()

Invoked after the graph instance variable has been set, but before any defaults/listeners have been installed.

completeUIInstall

protected void completeUIInstall()

Invoked from installUI after all the defaults/listeners have been installed.

installDefaults

protected void installDefaults()

Invoked as part from the boilerplate install block. This sets the look and feel specific variables in JGraph.

installListeners

protected void installListeners()

Invoked as part from the boilerplate install block. This installs the listeners from BasicGraphUI in the graph.

installKeyboardActions

protected void installKeyboardActions()

Invoked as part from the boilerplate install block.

installComponents

protected void installComponents()

Intalls the subcomponents of the graph, which is the renderer pane.

createTransferHandler

protected TransferHandler createTransferHandler()

Creates an instance of TransferHandler. Used for subclassers to provide different TransferHandler.

createPropertyChangeListener

protected PropertyChangeListener createPropertyChangeListener()

Creates a listener that is responsible to update the UI based on how the graph's bounds properties change.

createMouseListener

protected MouseListener createMouseListener()

Creates the listener responsible for calling the correct handlers based on mouse events, and to select invidual cells.

createKeyListener

protected KeyListener createKeyListener()

Creates the listener reponsible for getting key events from the graph.

createGraphSelectionListener

protected GraphSelectionListener createGraphSelectionListener()

Creates the listener that updates the display based on selection change methods.

createCellEditorListener

protected CellEditorListener createCellEditorListener()

Creates a listener to handle events from the current editor.

createComponentListener

protected ComponentListener createComponentListener()

Creates and returns a new ComponentHandler.

createCellRendererPane

protected CellRendererPane createCellRendererPane()

Returns the renderer pane that renderer components are placed in.

createGraphViewObserver

protected Observer createGraphViewObserver()

Returns a listener that can update the graph when the view changes.

createGraphModelListener

protected GraphModelListener createGraphModelListener()

Returns a listener that can update the graph when the model changes.

uninstallUI

public void uninstallUI(JComponent c)

Overrides:

uninstallUI in class ComponentUI

completeUIUninstall

protected void completeUIUninstall()

uninstallListeners

protected void uninstallListeners()

uninstallKeyboardActions

protected void uninstallKeyboardActions()

uninstallComponents

protected void uninstallComponents()

Uninstalls the renderer pane.

paint

public void paint(Graphics g,
                  JComponent c)

Main painting routine.

Overrides:

paint in class ComponentUI

paintCell

public void paintCell(Graphics g,
                      CellView view,
                      Rectangle bounds,
                      boolean preview)

Paints the renderer of view to g at bounds. Recursive implementation that paints the children first.

The reciever should NOT modify clipBounds, or insets. The preview flag is passed to the renderer, and is not used here.

Specified by:

paintCell in class GraphUI

paintBackground

protected void paintBackground(Graphics g)

Paint the background of this graph. Calls paintGrid.

paintGrid

protected void paintGrid(int gs,
                         Graphics g,
                         Rectangle r)

Paint the grid.

paintForeground

protected void paintForeground(Graphics g)

Paint the foreground of this graph. Calls paintPorts.

paintPorts

public void paintPorts(Graphics g,
                       CellView[] ports)

Paint ports.

Specified by:

paintPorts in class GraphUI

updateHandle

protected void updateHandle()

Update the handle using createHandle.

createContext

protected GraphContext createContext(JGraph graph,
                                     Object[] cells)

createHandle

public CellHandle createHandle(GraphContext context)

Constructs the "root handle" for context.

Parameters:

context - reference to the context of the current selection.

updateSize

public void updateSize()

Messages the Graph with graphDidChange.

updateCachedPreferredSize

protected void updateCachedPreferredSize()

Updates the preferredSize instance variable, which is returned from getPreferredSize().

setPreferredMinSize

public void setPreferredMinSize(Dimension newSize)

Sets the preferred minimum size.

getPreferredMinSize

public Dimension getPreferredMinSize()

Returns the minimum preferred size.

getPreferredSize

public Dimension getPreferredSize(JComponent c)

Returns the preferred size to properly display the graph.

Overrides:

getPreferredSize in class ComponentUI

getMinimumSize

public Dimension getMinimumSize(JComponent c)

Returns the minimum size for this component. Which will be the min preferred size or 0, 0.

Overrides:

getMinimumSize in class ComponentUI

getMaximumSize

public Dimension getMaximumSize(JComponent c)

Returns the maximum size for this component, which will be the preferred size if the instance is currently in a JGraph, or 0, 0.

Overrides:

getMaximumSize in class ComponentUI

completeEditing

protected void completeEditing()

Messages to stop the editing session. If the UI the receiver is providing the look and feel for returns true from getInvokesStopCellEditing, stopCellEditing will invoked on the current editor. Then completeEditing will be messaged with false, true, false to cancel any lingering editing.

completeEditing

protected void completeEditing(boolean messageStop,
                               boolean messageCancel,
                               boolean messageGraph)

Stops the editing session. If messageStop is true the editor is messaged with stopEditing, if messageCancel is true the editor is messaged with cancelEditing. If messageGraph is true the graphModel is messaged with valueForCellChanged.

startEditing

protected boolean startEditing(Object cell,
                               MouseEvent event)

Will start editing for cell if there is a cellEditor and shouldSelectCell returns true.

This assumes that cell is valid and visible.

autoscroll

public static void autoscroll(JGraph graph,
                              Point p)

Scroll the graph for an event at p.

insertCells

public void insertCells(Object[] cells,
                        Map viewAttributeMap,
                        ConnectionSet cs,
                        ParentMap pm,
                        boolean clone,
                        int dx,
                        int dy)

Insert the specified cells into the model. If clone is true, the cells are cloned an all datastructures are updated to reference these clones. Clones are created using the GraphModel.clone(Object)-method. If cells are cloned, they are translated using the given amount.

isSnapSelectedView

public boolean isSnapSelectedView()

Returns:

true if snapSelectedView mode is enabled during the drag operation. If it is enabled, the view, that is returned by the findViewForPoint(Point pt), will be snapped to the grid lines.
By default, findViewForPoint() returns the first view from the GraphContext whose bounds intersect with snap proximity of a mouse pointer. If snap-to-grid mode is disabled, views are moved by a snap increment.

setSnapSelectedView

public void setSnapSelectedView(boolean snapSelectedView)

Sets the mode of the snapSelectedView drag operation.

Parameters:

snapSelectedView - specifies if the snap-to-grid mode should be applied during a drag operation. If it is enabled, the view, that is returned by the findViewForPoint(Point pt), will be snapped to the grid lines.
By default, findViewForPoint() returns the first view from the GraphContext whose bounds intersect with snap proximity of a mouse pointer. If snap-to-grid mode is disabled, views are moved by a snap increment.