Class JGraph
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,Accessible
,Scrollable
A JGraph object doesn't actually contain your data; it simply provides a view of the data. Like any non-trivial Swing component, the graph gets data by querying its data model.
JGraph displays its data by drawing individual elements. Each element displayed by the graph contains exactly one item of data, which is called a cell. A cell may either be a vertex or an edge. Vertices may have neighbours or not, and edges may have source and target vertices or not, depending on whether they are connected.
Creating a Graph
The following code creates a JGraph object:
JGraph graph = new JGraph();
...
JScrollPane graphLayoutCache = new JScrollPane(graph)
The code creates an instance of JGraph and puts it in a scroll pane. JGraphs constructor is called with no arguments in this example, which causes the constructor to create a sample model.
Editing
Outmoved, cloned, resized, and shaped, or connected/disconnected to or from other cells.
Keyboard Bindings
JGraph defines the following set of keyboard bindings:
- Alt-Click forces marquee selection if over a cell.
- Shift- or Ctrl-Select extends or toggles the selection.
- Shift-Drag constrains the offset to one direction.
- Ctrl-Drag clones the selection.
- Doubleclick/F2 starts editing a cell.
Customization
There are a number of additional methods that customize JGraph. For example, setMinimumMove() defines the minimum amount of pixels before a move operation is initiated. setSnapSize() defines the maximum distance for a cell to be selected. setFloatEnabled() enables/disables port floating.
With setDisconnectOnMove() you can indicate if the selected subgraph should be disconnected from the unselected rest when a move operation is initiated. setDragEnabled() enables/disables the use of Drag And Drop, and setDropEnabled() sets if the graph accepts Drops from external sources.
Customizing a graphs display
JGraph performs some look-and-feel specific painting. You can customize this painting in a limited way. For example, you can modify the grid using setGridColor() and setGridSize(), and you can change the handle colors using setHandleColor() and setLockedHandleColor().
If you want finer control over the rendering, you can subclass one of the default renderers, and extend its paint()-method. A renderer is a Component-extension that paints a cell based on its attributes. Thus, neither the JGraph nor its look-and-feel-specific implementation actually contain the code that paints the cell. Instead, the graph uses the cell renderers painting code.
Selection
Apart from the single-cell and marquee-selection, JGraphs selection model also allows to "step-into" groups, and select children. This feature can be disabled using the setAllowsChildSelection() method of the selection model instance.
If you are interested in knowing when the selection changes implement the
GraphSelectionListener
interface and add the instance using
the method addGraphSelectionListener
.
valueChanged
will be invoked when the selection changes, that
is if the user clicks twice on the same vertex valueChanged
will only be invoked once.
Change Notification
For detection of double-clicks or when a user clicks on a cell, regardless of
whether or not it was selected, I recommend you implement a MouseListener and
use getFirstCellForLocation
.
Undo Support
To enable Undo-Support, a GraphUndoManager
must be added using
addGraphSelectionListener
. The GraphUndoManager is an
extension of Swing's GraphUndoManager
that maintains a command
history in the context of multiple views. In this setup, a cell may have a
set of attributes in each view attached to the model.
For example, consider a position that is stored separately in each view. If a node is inserted, the change will be visible in all attached views, resulting in a new node that pops-up at the initial position. If the node is subsequently moved, say, in view1, this does not constitute a change in view2. If view2 does an "undo", the move and the insertion must be undone, whereas an "undo" in view1 will only undo the previous move operation.
Like all JComponent
classes, you can use
InputMap
and ActionMap
to associate
an Action
object with a KeyStroke
and
execute the action under specified conditions.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
EmptySelectionModel
is aGraphSelectionModel
that does not allow anything to be selected.protected class
Handles creating a newGraphSelectionEvent
with theJGraph
as the source and passing it off to all the listeners.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
FieldsModifier and TypeFieldDescriptionprotected boolean
True if the graph is anti-aliased.static final String
Bound property name forantiAliased
.protected boolean
True if the graph should be auto resized when cells are moved below the bottom right corner.protected Component
A Component responsible for drawing the background image, if anyprotected ImageIcon
Holds the background image.protected boolean
Whether or not the background image is scaled on zoomingprotected boolean
True if the graph allows points to be modified/added/removed.protected boolean
True if the graph allows "ctrl-drag" operations.protected boolean
True if the graph allows new connections to be established.static final int
protected boolean
True if the graph allows existing connections to be removed.protected boolean
True if selected edges are disconnected from unselected vertices on move.static final int
protected boolean
True if Drag-and-Drop should be used for move operations.protected boolean
True if the graph accepts transfers from other components (graphs).protected boolean
True if the labels on edges may be moved.protected boolean
True if the graph allows editing the value of a cell.static final String
Bound property name foreditable
.protected int
Number of clicks for editing to start.protected boolean
True if the graph allows interactions.static final String
Bound property name forgraphModel
.static final String
Bound property name forgraphModel
.protected GraphLayoutCache
The view that defines the display properties of the model.protected GraphModel
The model that defines the graph displayed by this object.static final String
Bound property name forgridColor
.static final String
Bound property name forgridSize
.static final String
Bound property name forgridVisible
.protected Color
The color of the grid.protected boolean
True if the snap method should be active (snap to grid).protected int
The style of the grid.protected double
The size of the grid in points.protected boolean
True if the grid is visible.protected boolean
True if the graph allows editing of non-leaf cells.static final String
Bound property name forgridColor
.static final String
Bound property name forgridColor
.protected Color
Color of the handles and locked handles.protected int
Size of a handle.protected Color
Highlight Color.static final String
Bound property name formessagesStopCellEditing
.protected boolean
If true, when editing is to be stopped by way of selection changing, data in graph changing or other meansstopCellEditing
is invoked, and changes are saved.static boolean
protected boolean
True if getPortViewAt should return the default port if no other port is found.protected boolean
Specifies if cells should be added to a group when moved over the group's area.protected boolean
Specifies if cells should be removed from groups when removed from the group area.protected boolean
Stores whether the last double buffer allocation worked or notstatic final int
static final String
Bound property name forgridColor
.protected Color
Color of the handles and locked handles.protected BasicMarqueeHandler
Handler for marquee selection.static final String
Bound property name forgraphModel
.protected Color
Color of the marquee.protected int
Minimum amount of pixels to start a move transaction.protected boolean
True if the graph allows move operations.protected boolean
True if the graph allows to move cells below zero.protected boolean
True if the graph allows to move cells beyond the graph boundsprotected Graphics
Graphics object of off screen imageprotected Image
Off screen image for double bufferingprotected Rectangle2D
The bounds of the offscreen bufferprotected int
The buffer around the offscreen graphics object that provides the specified distance of scrolling before the buffer has to be recreated.protected Rectangle2D
Whether or not the current background image is correctprotected Point2D
The offset of the offscreen bufferstatic final String
Bound property name forportsScaled
.static final String
Bound property name forgridVisible
.protected boolean
True if port are painted above all other cells.protected boolean
True if the ports are scaled.protected boolean
True if the ports are visible.protected boolean
True if the graph allows invalid null ports during previews (aka flip back edges).static final String
Bound property name forbackgroundImage
.protected double
Scale of the graph.static final String
Bound property name forscale
.static final String
Bound property name forselectionModel
.protected boolean
True if the graph allows selection of cells.static final String
Bound property name forselectionEnabled
.protected GraphSelectionModel
Models the set of selected objects in this graph.protected JGraph.GraphSelectionRedirector
Creates a new event and passes it off theselectionListeners
.protected boolean
True if the graph allows cells to be resized.protected int
Maximum distance between a cell and the mousepointer.static final String
protected boolean
Whether or not to try to use a volatile offscreen buffer for double buffering.protected boolean
protected double
protected boolean
True if the graph accepts transfers from other components (graphs).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
-
Constructor Summary
ConstructorsConstructorDescriptionJGraph()
Returns aJGraph
with a sample model.JGraph
(GraphLayoutCache cache) Returns an instance ofJGraph
which displays the data model using the specified view.JGraph
(GraphModel model) Returns an instance ofJGraph
which displays the the specified data model.JGraph
(GraphModel model, BasicMarqueeHandler mh) Returns an instance ofJGraph
which displays the specified data model and assigns the specified marquee handlerJGraph
(GraphModel model, GraphLayoutCache cache) Returns an instance ofJGraph
which displays the specified data model using the specified view.JGraph
(GraphModel model, GraphLayoutCache layoutCache, BasicMarqueeHandler mh) Returns an instance ofJGraph
which displays the specified data model using the specified view and assigns the specified marquee handler -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a listener forGraphSelection
events.void
addOffscreenDirty
(Rectangle2D offscreenDirty) Adds the specified area to the region deemed dirty for the next double buffered redrawstatic void
addSampleData
(GraphModel model) Creates and returns a sampleGraphModel
.void
addSelectionCell
(Object cell) Adds the cell identified by the specifiedObject
to the current selection.void
addSelectionCells
(Object[] cells) Adds each cell in the array of cells to the current selection.void
Cancels the current editing session.void
Invalidate the offscreen region, do not just delete it, since if the new region is smaller than the old you may not wish to re-create the buffervoid
Clears the region deemed dirty for the next double buffered redrawvoid
Clears the selection.cloneCells
(Object[] cells) Returns a map of (cell, clone)-pairs for allcells
and their children.convertValueToString
(Object value) Converts the specified value to string.static Map
createBounds
(AttributeMap map, int x, int y, Color c) Returns an attributeMap for the specified position and color.protected void
createBufferedImage
(int width, int height) Utility method to create a standard buffered imageboolean
drawImage
(int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2) Utility method to draw the off screen bufferboolean
protected void
Notifies all listeners that have registered interest for notification on this event type.Downscale the given point in place, using the given instance.fromScreen
(Rectangle2D rect) Downscale the given rectangle in place, using the given instance.getAttributes
(Object cell) Returns the attributes for the specified cell.Returns the background image.getCellBounds
(Object cell) Returns the bounding rectangle of the specified cell.getCellBounds
(Object[] cells) Returns the bounding rectangle of the specified cells.Returns the center of the component relative to the parent viewport's position.Calculates the clipgetDefaultPortForCell
(Object cell) Returns the default portview for the specified cell.Object[]
getDescendants
(Object[] cells) Returns allcells
including all descendants in the passed in order of cells.boolean
Returns true if edge labels may be dragged and dropped.int
Returns the number of clicks for editing to start.Returns the cell that is currently being edited.getFirstCellForLocation
(double x, double y) Returns the topmost cell at the specified location.Returns theGraphLayoutCache
that is providing the view-data.Returns the current grid color.int
Returns the current grid view mode.double
Returns the size of the grid in pixels.Returns the current handle color.int
Returns the size of the handles.Returns the current highlight color.Returns aBufferedImage
for the graph using inset as an empty border around the cells of the graph.boolean
Returns the indicator that tells what happens when editing is interrupted.getLeafViewAt
(double x, double y) Returns the next view at the specified location wrt.Returns the current second handle color.Returns the current marquee color.Returns theMarqueeHandler
that will handle marquee selection.int
Returns the miminum amount of pixels for a move operation.getModel()
Returns theGraphModel
that is providing the data.getNextCellForLocation
(Object current, double x, double y) Returns the cell at the specified location that is "behind" thecurrent
cell.getNextSelectableViewAt
(CellView current, double x, double y) Note: Arguments are not expected to be scaled (they are scaled in here).getNextViewAt
(CellView[] cells, CellView c, double x, double y) Returns the next view at the specified location wrt.getNextViewAt
(CellView[] cells, CellView c, double x, double y, boolean leafsOnly) Returns the next view at the specified location wrt.getNextViewAt
(CellView current, double x, double y) Returns the next view at the specified location wrt.getNextViewAt
(CellView current, double x, double y, boolean leafsOnly) Returns the next view at the specified location wrt.Returns the current double buffering graphics object.Returns the area that is deemed dirty for the next double buffered redrawgetPortForLocation
(double x, double y) Convenience method to return the port at the specified location.getPortViewAt
(double x, double y) Returns the portview at the specified location.getPortViewAt
(double x, double y, int tolerance) Returns the portview at the specified location.Returns the preferred display size of aJGraph
.Object[]
getRoots()
Returns all root cells (cells that have no parent) that the model contains.Object[]
Returns all cells that intersect the given rectangle.double
getScale()
Returns the current scale.int
getScrollableBlockIncrement
(Rectangle visibleRect, int orientation, int direction) Returns the amount for a block increment, which is the height or width ofvisibleRect
, based onorientation
.boolean
Returns false to indicate that the height of the viewport does not determine the height of the graph, unless the preferred height of the graph is smaller than the viewports height.boolean
Returns false to indicate that the width of the viewport does not determine the width of the graph, unless the preferred width of the graph is smaller than the viewports width.int
getScrollableUnitIncrement
(Rectangle visibleRect, int orientation, int direction) Returns the amount to increment when scrolling.Returns the first selected cell.Returns the selection cell at the specified location.Object[]
Returns all selected cells.Object[]
getSelectionCells
(Object[] cells) Returns all selected cells incells
.int
Returns the number of cells selected.Returns the model for selections.int
Returns the maximum distance between the mousepointer and a cell to be selected.OverridesJComponent
'sgetToolTipText
method in order to allow the graph to create a tooltip for the topmost cell under the mousepointer.getTopmostViewAt
(double x, double y, boolean reverse, boolean leafsOnly) Returns the topmost cell view at the specified location using the view's bounds on non-leafs to check for containment.getUI()
Returns the Linvalid input: '&F' object that renders this component.Returns the name of the Linvalid input: '&F' class that renders this component.Return the bounds of the parent viewport, if one exists.void
Messaged when the graph has changed enough that we need to resize the bounds, but not enough that we need to remove the cells (e.g cells were inserted into the graph).boolean
Returns true if the graph will be anti aliased.boolean
Returns true if the graph should be automatically resized when cells are being moved below the bottom right corner.boolean
boolean
Returns true if the graph allows adding/removing/modifying points.boolean
isCellEditable
(Object cell) Returnstrue
if the graph and the cell are editable.boolean
isCellSelected
(Object cell) Returns true if the cell is currently selected.boolean
Returns true if cells are cloned on CTRL-Drag operations.boolean
Returns true if the graph allows new connections to be established.boolean
Returns true if the graph allows existing connections to be removed.boolean
Returns true if selected edges should be disconnected from unselected vertices when they are moved.boolean
Returns true if the graph uses Drag-and-Drop to move cells.boolean
Returns true if the graph accepts drops/pastes from external sources.boolean
Returns true if the graph is editable (if it allows cells to be edited).boolean
Returns true if the graph is being edited.boolean
Returns true if the grid is active.boolean
Returns true if the grid will be visible.boolean
boolean
Returns true if getPortViewAt should return the default port if no other port is found.boolean
boolean
Returns true if the graph allows to move cells below zero.boolean
boolean
Returns true if cells should be added to groups when moved over the group's area.boolean
Returns true if cells should be removed from groups when removed from the group's area.boolean
boolean
Returns true if the ports will be scaled.boolean
Returns true if the ports will be visible.boolean
Returns true if graph allows invalid null ports during previewsboolean
Returns true if the selection is currently empty.boolean
Returns true if the cell selection is enabledboolean
Returns true if the graph allows cells to be resized.boolean
boolean
Returns true if the graph accepts drops/pastes from external sources.static void
Object[]
Returns allcells
including all descendants ordered using the current layering data stored by the model.protected String
Returns a string representation of thisJGraph
.void
refresh()
Repaints the entire graph, regardless of what is marked dirtyvoid
Schedules the offscreen resources taken by the offscreen buffer to be reclaimed.void
Removes aGraphSelection
listener.void
removeSelectionCell
(Object cell) Removes the cell identified by the specified Object from the current selection.void
scrollCellToVisible
(Object cell) Scrolls to the specified cell.void
Makes sure the specified point is visible.void
setAntiAliased
(boolean newValue) Sets antialiasing on or off based on the boolean value.void
setAutoResizeGraph
(boolean autoResizeGraph) Sets whether or not the graph should be automatically resize when cells are being moved below the bottom right cornervoid
setBackground
(Color bg) Override parent to clear offscreen double buffervoid
setBackgroundComponent
(Component backgroundComponent) void
setBackgroundImage
(ImageIcon backgroundImage) Sets the background image.void
setBackgroundScaled
(boolean backgroundScaled) void
setBendable
(boolean flag) Sets if the graph allows adding/removing/modifying points.void
setCloneable
(boolean flag) Sets if cells are cloned on CTRL-Drag operations.void
setConnectable
(boolean flag) Setse if the graph allows new connections to be established.void
setDisconnectable
(boolean flag) Sets if the graph allows existing connections to be removed.void
setDisconnectOnMove
(boolean flag) Sets if selected edges should be disconnected from unselected vertices when they are moved.void
setDragEnabled
(boolean flag) Sets if the graph uses Drag-and-Drop to move cells.void
setDropEnabled
(boolean flag) Sets if the graph accepts drops/pastes from external sources.void
setEdgeLabelsMovable
(boolean edgeLabelsMovable) Set if edge labels may be moved with the mouse or not.void
setEditable
(boolean flag) Determines whether the graph is editable.void
setEditClickCount
(int count) Sets the number of clicks for editing to start.void
setGraphLayoutCache
(GraphLayoutCache newLayoutCache) Sets theGraphLayoutCache
that will provide the view-data.void
setGridColor
(Color newColor) Sets the current grid color.void
setGridEnabled
(boolean flag) If set to true, the grid will be active.void
setGridMode
(int mode) Sets the current grid view mode.void
setGridSize
(double newSize) Sets the size of the grid.void
setGridVisible
(boolean flag) If set to true, the grid will be visible.void
setGroupsEditable
(boolean groupsEditable) void
setHandleColor
(Color newColor) Sets the current handle color.void
setHandleSize
(int size) Sets the size of the handles.void
setHighlightColor
(Color newColor) Sets the current selection highlight color.void
setInvokesStopCellEditing
(boolean newValue) Determines what happens when editing is interrupted by selecting another cell in the graph, a change in the graph's data, or by some other means.void
setJumpToDefaultPort
(boolean flag) Sets if getPortViewAt should return the default port if no other port is found.void
setLockedHandleColor
(Color newColor) Sets the current second handle color.void
setMarqueeColor
(Color newColor) Sets the current marquee color.void
setMarqueeHandler
(BasicMarqueeHandler newMarquee) Sets theMarqueeHandler
that will handle marquee selection.void
setMinimumMove
(int pixels) Sets the miminum amount of pixels for a move operation.void
setModel
(GraphModel newModel) Sets theGraphModel
that will provide the data.void
setMoveable
(boolean flag) Sets if the graph allows movement of cells.void
setMoveBelowZero
(boolean moveBelowZero) Sets if the graph should auto resize when cells are being moved below the bottom right corner.void
setMoveBeyondGraphBounds
(boolean moveBeyondGraphBounds) void
setMoveIntoGroups
(boolean flag) Specifies if cells should be added to groups when moved over the group's area.void
setMoveOutOfGroups
(boolean flag) Specifies if cells should be removed from groups when removed from the group's area.void
setOffscreenOffset
(Point2D offscreenOffset) void
setOpaque
(boolean opaque) void
setPortsOnTop
(boolean portsOnTop) void
setPortsScaled
(boolean flag) If set to true, the ports will be scaled.void
setPortsVisible
(boolean flag) If set to true, the ports will be visible.void
setPreviewInvalidNullPorts
(boolean flag) Determines whether the graph allows invalid null ports during previewsvoid
setScale
(double newValue) Sets the current scale.void
Sets the current scale and centers the graph to the specified pointvoid
setSelectionCell
(Object cell) Selects the specified cell.void
setSelectionCells
(Object[] cells) Selects the specified cells.void
setSelectionEnabled
(boolean flag) Determines whether cell selection is enabled.void
setSelectionModel
(GraphSelectionModel selectionModel) Sets the graph's selection model.void
setSizeable
(boolean flag) Sets if the graph allows cells to be resized.void
setTolerance
(int size) Sets the maximum distance between the mousepointer and a cell to be selected.void
Sets the Linvalid input: '&F' object that renders this component.protected void
setupOffScreen
(int x, int y, int width, int height, Rectangle2D newOffscreenBuffer) Utility method that initialises the offscreen graphics areavoid
setVolatileOffscreen
(boolean volatileOffscreen) void
setXorEnabled
(boolean flag) Sets if the graph accepts drops/pastes from external sources.snap
(Dimension2D d) Returns the given dimension applied to the grid.Returns the given point applied to the grid.snap
(Rectangle2D r) Returns the given rectangle applied to the grid.void
startEditingAtCell
(Object cell) Selects the specified cell and initiates editing.boolean
Ends the current editing session.Upscale the given point in place, using the given instance.toScreen
(Rectangle2D rect) Upscale the given rectangle in place, using the given instance.void
updateAutoSize
(CellView view) Computes and updates the size forview
.void
updateUI()
Notification from theUIManager
that the Linvalid input: '&F' has changed.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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, 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, setLayout, 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, getAccessibleContext, 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
Methods inherited from interface javax.accessibility.Accessible
getAccessibleContext
-
Field Details
-
VERSION
- See Also:
-
DOT_GRID_MODE
public static final int DOT_GRID_MODE- See Also:
-
CROSS_GRID_MODE
public static final int CROSS_GRID_MODE- See Also:
-
LINE_GRID_MODE
public static final int LINE_GRID_MODE- See Also:
-
IS_MAC
public static boolean IS_MAC -
selectionRedirector
Creates a new event and passes it off theselectionListeners
. -
graphModel
The model that defines the graph displayed by this object. Bound property. -
graphLayoutCache
The view that defines the display properties of the model. Bound property. -
selectionModel
Models the set of selected objects in this graph. Bound property. -
marquee
Handler for marquee selection. -
offscreen
Off screen image for double buffering -
offscreenBounds
The bounds of the offscreen buffer -
offscreenOffset
The offset of the offscreen buffer -
offgraphics
Graphics object of off screen image -
offscreenDirty
Whether or not the current background image is correct -
wholeOffscreenDirty
protected transient boolean wholeOffscreenDirty -
wholeOffscreenDirtyProportion
protected transient double wholeOffscreenDirtyProportion -
offscreenBuffer
protected transient int offscreenBufferThe buffer around the offscreen graphics object that provides the specified distance of scrolling before the buffer has to be recreated. Increasing the value means fewer buffer allocations but more memory usage for the current buffer -
volatileOffscreen
protected boolean volatileOffscreenWhether or not to try to use a volatile offscreen buffer for double buffering. Volatile -
lastBufferAllocated
protected boolean lastBufferAllocatedStores whether the last double buffer allocation worked or not -
backgroundImage
Holds the background image. -
backgroundComponent
A Component responsible for drawing the background image, if any -
backgroundScaled
protected boolean backgroundScaledWhether or not the background image is scaled on zooming -
scale
protected double scaleScale of the graph. Default is 1. Bound property. -
antiAliased
protected boolean antiAliasedTrue if the graph is anti-aliased. Default is false. Bound property. -
editable
protected boolean editableTrue if the graph allows editing the value of a cell. Bound property. -
groupsEditable
protected boolean groupsEditableTrue if the graph allows editing of non-leaf cells. Bound property. -
selectionEnabled
protected boolean selectionEnabledTrue if the graph allows selection of cells. Note: You must also disable selectNewCells if you disable this. Bound property. -
previewInvalidNullPorts
protected boolean previewInvalidNullPortsTrue if the graph allows invalid null ports during previews (aka flip back edges). Default is true. -
gridVisible
protected boolean gridVisibleTrue if the grid is visible. Bound property. -
gridSize
protected double gridSizeThe size of the grid in points. Default is 10. Bound property. -
gridMode
protected int gridModeThe style of the grid. Use one of the _GRID_MODE constants. -
portsVisible
protected boolean portsVisibleTrue if the ports are visible. Bound property. -
portsScaled
protected boolean portsScaledTrue if the ports are scaled. Bound property. -
portsOnTop
protected boolean portsOnTopTrue if port are painted above all other cells. -
moveBelowZero
protected boolean moveBelowZeroTrue if the graph allows to move cells below zero. -
moveBeyondGraphBounds
protected boolean moveBeyondGraphBoundsTrue if the graph allows to move cells beyond the graph bounds -
edgeLabelsMovable
protected boolean edgeLabelsMovableTrue if the labels on edges may be moved. -
autoResizeGraph
protected boolean autoResizeGraphTrue if the graph should be auto resized when cells are moved below the bottom right corner. Default is true. -
highlightColor
Highlight Color. This color is used to draw the selection border of unfocused cells. Changes when the Look-and-Feel changes. -
handleColor
Color of the handles and locked handles. Changes when the Look-and-Feel changes. This color is also used to draw the selection border of focused cells. -
lockedHandleColor
Color of the handles and locked handles. Changes when the Look-and-Feel changes. This color is also used to draw the selection border of focused cells. -
marqueeColor
Color of the marquee. Changes when the Look-and-Feel changes. -
gridColor
The color of the grid. This color is used to draw the selection border for cells with selected children. Changes when the Look-and-Feel changes. -
dragEnabled
protected boolean dragEnabledTrue if Drag-and-Drop should be used for move operations. Default is false due to a JDK bug. -
dropEnabled
protected boolean dropEnabledTrue if the graph accepts transfers from other components (graphs). This also affects the clipboard. Default is true. -
xorEnabled
protected boolean xorEnabledTrue if the graph accepts transfers from other components (graphs). This also affects the clipboard. Default is true. -
editClickCount
protected int editClickCountNumber of clicks for editing to start. Default is 2 clicks. -
enabled
protected boolean enabledTrue if the graph allows interactions. Default is true. -
gridEnabled
protected boolean gridEnabledTrue if the snap method should be active (snap to grid). -
handleSize
protected int handleSizeSize of a handle. Default is 3 pixels. -
tolerance
protected int toleranceMaximum distance between a cell and the mousepointer. Default is 4. -
minimumMove
protected int minimumMoveMinimum amount of pixels to start a move transaction. Default is 5. -
isJumpToDefaultPort
protected boolean isJumpToDefaultPortTrue if getPortViewAt should return the default port if no other port is found. Default is false. -
isMoveIntoGroups
protected boolean isMoveIntoGroupsSpecifies if cells should be added to a group when moved over the group's area. Default is false. -
isMoveOutOfGroups
protected boolean isMoveOutOfGroupsSpecifies if cells should be removed from groups when removed from the group area. Default is false. -
disconnectOnMove
protected boolean disconnectOnMoveTrue if selected edges are disconnected from unselected vertices on move. Default is false. -
moveable
protected boolean moveableTrue if the graph allows move operations. Default is true. -
cloneable
protected boolean cloneableTrue if the graph allows "ctrl-drag" operations. Default is false. -
sizeable
protected boolean sizeableTrue if the graph allows cells to be resized. Default is true. -
bendable
protected boolean bendableTrue if the graph allows points to be modified/added/removed. Default is true. -
connectable
protected boolean connectableTrue if the graph allows new connections to be established. Default is true. -
disconnectable
protected boolean disconnectableTrue if the graph allows existing connections to be removed. Default is true. -
invokesStopCellEditing
protected boolean invokesStopCellEditingIf true, when editing is to be stopped by way of selection changing, data in graph changing or other meansstopCellEditing
is invoked, and changes are saved. If false,cancelCellEditing
is invoked, and changes are discarded. -
GRAPH_MODEL_PROPERTY
Bound property name forgraphModel
.- See Also:
-
GRAPH_LAYOUT_CACHE_PROPERTY
Bound property name forgraphModel
.- See Also:
-
MARQUEE_HANDLER_PROPERTY
Bound property name forgraphModel
.- See Also:
-
EDITABLE_PROPERTY
Bound property name foreditable
.- See Also:
-
SELECTIONENABLED_PROPERTY
Bound property name forselectionEnabled
.- See Also:
-
SCALE_PROPERTY
Bound property name forscale
.- See Also:
-
ANTIALIASED_PROPERTY
Bound property name forantiAliased
.- See Also:
-
GRID_SIZE_PROPERTY
Bound property name forgridSize
.- See Also:
-
GRID_VISIBLE_PROPERTY
Bound property name forgridVisible
.- See Also:
-
GRID_COLOR_PROPERTY
Bound property name forgridColor
.- See Also:
-
HANDLE_COLOR_PROPERTY
Bound property name forgridColor
.- See Also:
-
HANDLE_SIZE_PROPERTY
Bound property name forgridColor
.- See Also:
-
LOCKED_HANDLE_COLOR_PROPERTY
Bound property name forgridColor
.- See Also:
-
PORTS_VISIBLE_PROPERTY
Bound property name forgridVisible
.- See Also:
-
PORTS_SCALED_PROPERTY
Bound property name forportsScaled
.- See Also:
-
SELECTION_MODEL_PROPERTY
Bound property name forselectionModel
.- See Also:
-
INVOKES_STOP_CELL_EDITING_PROPERTY
Bound property name formessagesStopCellEditing
.- See Also:
-
PROPERTY_BACKGROUNDIMAGE
Bound property name forbackgroundImage
.- See Also:
-
-
Constructor Details
-
JGraph
public JGraph()Returns aJGraph
with a sample model. -
JGraph
Returns an instance ofJGraph
which displays the the specified data model.- Parameters:
model
- theGraphModel
to use as the data model
-
JGraph
Returns an instance ofJGraph
which displays the data model using the specified view.- Parameters:
cache
- theGraphLayoutCache
to use as the view
-
JGraph
Returns an instance ofJGraph
which displays the specified data model using the specified view.- Parameters:
model
- theGraphModel
to use as the data modelcache
- theGraphLayoutCache
to use as the cache
-
JGraph
Returns an instance ofJGraph
which displays the specified data model and assigns the specified marquee handler- Parameters:
model
- theGraphModel
to use as the data modelmh
- theBasicMarqueeHandler
to use as the marquee handler
-
JGraph
Returns an instance ofJGraph
which displays the specified data model using the specified view and assigns the specified marquee handler- Parameters:
model
- theGraphModel
to use as the data modellayoutCache
- theGraphLayoutCache
to use as the cachemh
- theBasicMarqueeHandler
to use as the marquee handler
-
-
Method Details
-
addSampleData
Creates and returns a sampleGraphModel
. Used primarily for beanbuilders to show something interesting. -
createBounds
Returns an attributeMap for the specified position and color. -
getUI
Returns the Linvalid input: '&F' object that renders this component.- Overrides:
getUI
in classJComponent
- Returns:
- the GraphUI object that renders this component
-
setUI
Sets the Linvalid input: '&F' object that renders this component.- Parameters:
ui
- the GraphUI Linvalid input: '&F' object- See Also:
-
updateUI
public void updateUI()Notification from theUIManager
that the Linvalid input: '&F' has changed. Replaces the current UI object with the latest version from theUIManager
. Subclassers can override this to support different GraphUIs.- Overrides:
updateUI
in classJComponent
- See Also:
-
getUIClassID
Returns the name of the Linvalid input: '&F' class that renders this component.- Overrides:
getUIClassID
in classJComponent
- Returns:
- the string "GraphUI"
- See Also:
-
getRoots
Returns all root cells (cells that have no parent) that the model contains. -
getRoots
Returns all cells that intersect the given rectangle. -
getDescendants
Returns allcells
including all descendants in the passed in order of cells. -
order
Returns allcells
including all descendants ordered using the current layering data stored by the model. -
cloneCells
Returns a map of (cell, clone)-pairs for allcells
and their children. Special care is taken to replace the anchor references between ports. (Iterative implementation.) -
getTopmostViewAt
Returns the topmost cell view at the specified location using the view's bounds on non-leafs to check for containment. If reverse is true this will return the innermost view. -
getFirstCellForLocation
Returns the topmost cell at the specified location.- Parameters:
x
- an integer giving the number of pixels horizontally from the left edge of the display area, minus any left marginy
- an integer giving the number of pixels vertically from the top of the display area, minus any top margin- Returns:
- the topmost cell at the specified location
-
getNextCellForLocation
Returns the cell at the specified location that is "behind" thecurrent
cell. Returns the topmost cell if there are no more cells behindcurrent
. Note: This does only return visible cells. -
getCellBounds
Returns the bounding rectangle of the specified cell. -
getCellBounds
Returns the bounding rectangle of the specified cells. -
getNextViewAt
Returns the next view at the specified location wrt.current
. This is used to iterate overlapping cells, and cells that are grouped. The current selection affects this method.
Note: This returns the next selectable view.
Note: Arguments are not expected to be scaled (they are scaled in here). -
getNextViewAt
Returns the next view at the specified location wrt.current
. This is used to iterate overlapping cells, and cells that are grouped. The current selection affects this method.
Note: This returns the next selectable view.
Note: Arguments are not expected to be scaled (they are scaled in here). -
getNextSelectableViewAt
Note: Arguments are not expected to be scaled (they are scaled in here). -
getNextViewAt
Returns the next view at the specified location wrt.c
in the specified array of views. The views must be in order, as returned, for example, by GraphLayoutCache.order(Object[]). -
getNextViewAt
Returns the next view at the specified location wrt.c
in the specified array of views. The views must be in order, as returned, for example, by GraphLayoutCache.order(Object[]). -
getLeafViewAt
Returns the next view at the specified location wrt.c
in the specified array of views. The views must be in order, as returned, for example, by GraphLayoutCache.order(Object[]). -
getPortForLocation
Convenience method to return the port at the specified location. -
getPortViewAt
Returns the portview at the specified location.
Note: Arguments are not expected to be scaled (they are scaled in here). -
getPortViewAt
Returns the portview at the specified location.
Note: Arguments are not expected to be scaled (they are scaled in here). -
getDefaultPortForCell
Returns the default portview for the specified cell. The default implementation returns the first floating port (ie. the first port that does not define an offset) or the port, if there is only one port.- Parameters:
cell
- the cell whose port is to be obtained- Returns:
- the port view of the specified cell
-
convertValueToString
Converts the specified value to string. If the value is an instance of CellView then the corresponding value or cell is used. -
snap
Returns the given point applied to the grid.- Parameters:
p
- a point in screen coordinates.- Returns:
- the same point applied to the grid.
-
snap
Returns the given rectangle applied to the grid.- Parameters:
r
- a rectangle in screen coordinates.- Returns:
- the same rectangle applied to the grid.
-
snap
Returns the given dimension applied to the grid.- Parameters:
d
- a dimension in screen coordinates to snap to.- Returns:
- the same dimension applied to the grid.
-
toScreen
Upscale the given point in place, using the given instance.- Parameters:
p
- the point to be upscaled- Returns:
- the upscaled point instance
-
fromScreen
Downscale the given point in place, using the given instance.- Parameters:
p
- the point to be downscaled- Returns:
- the downscaled point instance
-
toScreen
Upscale the given rectangle in place, using the given instance.- Parameters:
rect
- the rectangle to be upscaled- Returns:
- the upscaled rectangle instance
-
fromScreen
Downscale the given rectangle in place, using the given instance.- Parameters:
rect
- the rectangle to be downscaled- Returns:
- the down-scaled rectangle instance
-
updateAutoSize
Computes and updates the size forview
. -
getAttributes
Returns the attributes for the specified cell. If the layout cache returns a view for the cell then this method returns allAttributes, otherwise the method returns model.getAttributes(cell). -
getEditClickCount
public int getEditClickCount()Returns the number of clicks for editing to start. -
setEditClickCount
public void setEditClickCount(int count) Sets the number of clicks for editing to start. -
isDropEnabled
public boolean isDropEnabled()Returns true if the graph accepts drops/pastes from external sources. -
setDropEnabled
public void setDropEnabled(boolean flag) Sets if the graph accepts drops/pastes from external sources. -
isXorEnabled
public boolean isXorEnabled()Returns true if the graph accepts drops/pastes from external sources. -
setXorEnabled
public void setXorEnabled(boolean flag) Sets if the graph accepts drops/pastes from external sources. -
isDragEnabled
public boolean isDragEnabled()Returns true if the graph uses Drag-and-Drop to move cells. -
setDragEnabled
public void setDragEnabled(boolean flag) Sets if the graph uses Drag-and-Drop to move cells. -
isMoveable
public boolean isMoveable() -
setMoveable
public void setMoveable(boolean flag) Sets if the graph allows movement of cells. -
isBendable
public boolean isBendable()Returns true if the graph allows adding/removing/modifying points. -
setBendable
public void setBendable(boolean flag) Sets if the graph allows adding/removing/modifying points. -
isConnectable
public boolean isConnectable()Returns true if the graph allows new connections to be established. -
setConnectable
public void setConnectable(boolean flag) Setse if the graph allows new connections to be established. -
isDisconnectable
public boolean isDisconnectable()Returns true if the graph allows existing connections to be removed. -
setDisconnectable
public void setDisconnectable(boolean flag) Sets if the graph allows existing connections to be removed. -
isCloneable
public boolean isCloneable()Returns true if cells are cloned on CTRL-Drag operations. -
setCloneable
public void setCloneable(boolean flag) Sets if cells are cloned on CTRL-Drag operations. -
isSizeable
public boolean isSizeable()Returns true if the graph allows cells to be resized. -
setSizeable
public void setSizeable(boolean flag) Sets if the graph allows cells to be resized. -
setDisconnectOnMove
public void setDisconnectOnMove(boolean flag) Sets if selected edges should be disconnected from unselected vertices when they are moved. -
isDisconnectOnMove
public boolean isDisconnectOnMove()Returns true if selected edges should be disconnected from unselected vertices when they are moved. -
setJumpToDefaultPort
public void setJumpToDefaultPort(boolean flag) Sets if getPortViewAt should return the default port if no other port is found. -
isJumpToDefaultPort
public boolean isJumpToDefaultPort()Returns true if getPortViewAt should return the default port if no other port is found. -
setMoveIntoGroups
public void setMoveIntoGroups(boolean flag) Specifies if cells should be added to groups when moved over the group's area. -
isMoveIntoGroups
public boolean isMoveIntoGroups()Returns true if cells should be added to groups when moved over the group's area. -
setMoveOutOfGroups
public void setMoveOutOfGroups(boolean flag) Specifies if cells should be removed from groups when removed from the group's area. -
isMoveOutOfGroups
public boolean isMoveOutOfGroups()Returns true if cells should be removed from groups when removed from the group's area. -
isGridEnabled
public boolean isGridEnabled()Returns true if the grid is active.- See Also:
-
setGridEnabled
public void setGridEnabled(boolean flag) If set to true, the grid will be active.- See Also:
-
isMoveBelowZero
public boolean isMoveBelowZero()Returns true if the graph allows to move cells below zero. -
setMoveBelowZero
public void setMoveBelowZero(boolean moveBelowZero) Sets if the graph should auto resize when cells are being moved below the bottom right corner. -
isMoveBeyondGraphBounds
public boolean isMoveBeyondGraphBounds()- Returns:
- the moveBeyondGraphBounds
-
setMoveBeyondGraphBounds
public void setMoveBeyondGraphBounds(boolean moveBeyondGraphBounds) - Parameters:
moveBeyondGraphBounds
- the moveBeyondGraphBounds to set
-
getEdgeLabelsMovable
public boolean getEdgeLabelsMovable()Returns true if edge labels may be dragged and dropped.- Returns:
- whether edge labels may be dragged and dropped
-
setEdgeLabelsMovable
public void setEdgeLabelsMovable(boolean edgeLabelsMovable) Set if edge labels may be moved with the mouse or not.- Parameters:
edgeLabelsMovable
- true if edge labels may be dragged
-
isAutoResizeGraph
public boolean isAutoResizeGraph()Returns true if the graph should be automatically resized when cells are being moved below the bottom right corner. Note if the value ofmoveBeyondGraphBounds
iffalse
auto resizing is automatically disabled -
setAutoResizeGraph
public void setAutoResizeGraph(boolean autoResizeGraph) Sets whether or not the graph should be automatically resize when cells are being moved below the bottom right corner -
getTolerance
public int getTolerance()Returns the maximum distance between the mousepointer and a cell to be selected. -
setTolerance
public void setTolerance(int size) Sets the maximum distance between the mousepointer and a cell to be selected. -
getHandleSize
public int getHandleSize()Returns the size of the handles. -
setHandleSize
public void setHandleSize(int size) Sets the size of the handles. -
getMinimumMove
public int getMinimumMove()Returns the miminum amount of pixels for a move operation. -
setMinimumMove
public void setMinimumMove(int pixels) Sets the miminum amount of pixels for a move operation. -
getGridColor
Returns the current grid color. -
setGridColor
Sets the current grid color. -
getHandleColor
Returns the current handle color. -
setHandleColor
Sets the current handle color. -
getLockedHandleColor
Returns the current second handle color. -
setLockedHandleColor
Sets the current second handle color. -
getMarqueeColor
Returns the current marquee color. -
setMarqueeColor
Sets the current marquee color. -
getHighlightColor
Returns the current highlight color. -
setHighlightColor
Sets the current selection highlight color. -
getScale
public double getScale()Returns the current scale.- Returns:
- the current scale as a double
-
setScale
public void setScale(double newValue) Sets the current scale.Fires a property change for the SCALE_PROPERTY.
- Parameters:
newValue
- the new scale
-
setScale
Sets the current scale and centers the graph to the specified point- Parameters:
newValue
- the new scalecenter
- the center of the graph
-
clearOffscreen
public void clearOffscreen()Invalidate the offscreen region, do not just delete it, since if the new region is smaller than the old you may not wish to re-create the buffer -
getCenterPoint
Returns the center of the component relative to the parent viewport's position. -
getViewPortBounds
Return the bounds of the parent viewport, if one exists. If one does not exist, null is returned- Returns:
- the bounds of the parent viewport
-
getGridSize
public double getGridSize()Returns the size of the grid in pixels.- Returns:
- the size of the grid as an int
-
getGridMode
public int getGridMode()Returns the current grid view mode. -
setGridSize
public void setGridSize(double newSize) Sets the size of the grid.Fires a property change for the GRID_SIZE_PROPERTY.
- Parameters:
newSize
- the new size of the grid in pixels
-
setGridMode
public void setGridMode(int mode) Sets the current grid view mode.- Parameters:
mode
- The current grid view mode. Valid values areDOT_GRID_MODE
,CROSS_GRID_MODE
, andLINE_GRID_MODE
.
-
isGridVisible
public boolean isGridVisible()Returns true if the grid will be visible.- Returns:
- true if the grid is visible
-
setGridVisible
public void setGridVisible(boolean flag) If set to true, the grid will be visible.Fires a property change for the GRID_VISIBLE_PROPERTY.
-
isPortsVisible
public boolean isPortsVisible()Returns true if the ports will be visible.- Returns:
- true if the ports are visible
-
setPortsVisible
public void setPortsVisible(boolean flag) If set to true, the ports will be visible.Fires a property change for the PORTS_VISIBLE_PROPERTY.
-
isPortsScaled
public boolean isPortsScaled()Returns true if the ports will be scaled.- Returns:
- true if the ports are visible
-
setPortsScaled
public void setPortsScaled(boolean flag) If set to true, the ports will be scaled.Fires a property change for the PORTS_SCALED_PROPERTY.
-
isPortsOnTop
public boolean isPortsOnTop() -
setPortsOnTop
public void setPortsOnTop(boolean portsOnTop) -
isAntiAliased
public boolean isAntiAliased()Returns true if the graph will be anti aliased.- Returns:
- true if the graph is anti aliased
-
setAntiAliased
public void setAntiAliased(boolean newValue) Sets antialiasing on or off based on the boolean value.Fires a property change for the ANTIALIASED_PROPERTY.
- Parameters:
newValue
- whether to turn antialiasing on or off
-
isEditable
public boolean isEditable()Returns true if the graph is editable (if it allows cells to be edited).- Returns:
- true if the graph is editable
-
setEditable
public void setEditable(boolean flag) Determines whether the graph is editable. Fires a property change event if the new setting is different from the existing setting.Note: Editable determines whether the graph allows editing. This is not to be confused with enabled, which allows the graph to handle mouse events (including editing).
- Parameters:
flag
- a boolean value, true if the graph is editable
-
isGroupsEditable
public boolean isGroupsEditable()- Returns:
- the groupsEditable
-
setGroupsEditable
public void setGroupsEditable(boolean groupsEditable) - Parameters:
groupsEditable
- the groupsEditable to set
-
isSelectionEnabled
public boolean isSelectionEnabled()Returns true if the cell selection is enabled- Returns:
- true if the cell selection is enabled
-
setSelectionEnabled
public void setSelectionEnabled(boolean flag) Determines whether cell selection is enabled. Fires a property change event if the new setting is different from the existing setting.- Parameters:
flag
- a boolean value, true if cell selection is enabled
-
isPreviewInvalidNullPorts
public boolean isPreviewInvalidNullPorts()Returns true if graph allows invalid null ports during previews- Returns:
- true if the graph allows invalid null ports during previews
-
setPreviewInvalidNullPorts
public void setPreviewInvalidNullPorts(boolean flag) Determines whether the graph allows invalid null ports during previews- Parameters:
flag
- a boolean value, true if the graph allows invalid null ports during previews
-
getOffgraphics
Returns the current double buffering graphics object. Checks to see if the graph bounds has changed since the last time the off screen image was created and if so, creates a new image.- Returns:
- the off screen graphics
-
createBufferedImage
protected void createBufferedImage(int width, int height) Utility method to create a standard buffered image- Parameters:
width
-height
-
-
setupOffScreen
Utility method that initialises the offscreen graphics area- Parameters:
x
-y
-width
-height
-newOffscreenBuffer
-
-
getOffscreen
- Returns:
- the offscreen
-
getOffscreenDirty
Returns the area that is deemed dirty for the next double buffered redraw- Returns:
- the area that is deemed dirty for the next double buffered redraw
-
addOffscreenDirty
Adds the specified area to the region deemed dirty for the next double buffered redraw- Parameters:
offscreenDirty
- the region to add
-
clearOffscreenDirty
public void clearOffscreenDirty()Clears the region deemed dirty for the next double buffered redraw -
releaseOffscreenResources
public void releaseOffscreenResources()Schedules the offscreen resources taken by the offscreen buffer to be reclaimed. Note that this does not force garbage collection -
drawImage
public boolean drawImage(int dx1, int dy1, int dx2, int dy2, int sx1, int sy1, int sx2, int sy2) Utility method to draw the off screen buffer- Parameters:
dx1
- the x coordinate of the first corner of the destination rectangle.dy1
- the y coordinate of the first corner of the destination rectangle.dx2
- the x coordinate of the second corner of the destination rectangle.dy2
- the y coordinate of the second corner of the destination rectangle.sx1
- the x coordinate of the first corner of the source rectangle.sy1
- the y coordinate of the first corner of the source rectangle.sx2
- the x coordinate of the second corner of the source rectangle.sy2
- the y coordinate of the second corner of the source rectangle.- Returns:
true
if the current output representation is complete;false
otherwise.
-
drawImage
-
getBackgroundImage
Returns the background image.- Returns:
- Returns the backgroundImage.
-
setBackgroundImage
Sets the background image. Fires a property change event forPROPERTY_BACKGROUNDIMAGE
.- Parameters:
backgroundImage
- The backgroundImage to set.
-
setBackground
Override parent to clear offscreen double buffer- Overrides:
setBackground
in classJComponent
-
isBackgroundScaled
public boolean isBackgroundScaled()- Returns:
- the backgroundScaled
-
getOffscreenOffset
- Returns:
- the offscreenOffset
-
setOffscreenOffset
- Parameters:
offscreenOffset
- the offscreenOffset to set
-
isVolatileOffscreen
public boolean isVolatileOffscreen()- Returns:
- the volatileOffscreen
-
setVolatileOffscreen
public void setVolatileOffscreen(boolean volatileOffscreen) - Parameters:
volatileOffscreen
- the volatileOffscreen to set
-
setBackgroundScaled
public void setBackgroundScaled(boolean backgroundScaled) - Parameters:
backgroundScaled
- the backgroundScaled to set
-
getBackgroundComponent
- Returns:
- the backgroundComponent
-
setBackgroundComponent
- Parameters:
backgroundComponent
- the backgroundComponent to set
-
setOpaque
public void setOpaque(boolean opaque) - Overrides:
setOpaque
in classJComponent
-
getModel
Returns theGraphModel
that is providing the data.- Returns:
- the model that is providing the data
-
setModel
Sets theGraphModel
that will provide the data. Note: Updates the current GraphLayoutCache's model using setModel if the GraphLayoutCache points to a different model.Fires a property change for the GRAPH_MODEL_PROPERTY.
- Parameters:
newModel
- theGraphModel
that is to provide the data
-
getGraphLayoutCache
Returns theGraphLayoutCache
that is providing the view-data.- Returns:
- the view that is providing the view-data
-
setGraphLayoutCache
Sets theGraphLayoutCache
that will provide the view-data.Note: Updates the graphs's model using using the model from the layout cache.
Fires a property change for the GRAPH_LAYOUT_CACHE_PROPERTY.
- Parameters:
newLayoutCache
- theGraphLayoutCache
that is to provide the view-data
-
getMarqueeHandler
Returns theMarqueeHandler
that will handle marquee selection. -
setMarqueeHandler
Sets theMarqueeHandler
that will handle marquee selection.- Parameters:
newMarquee
- theBasicMarqueeHandler
that is to provide marquee handling
-
setInvokesStopCellEditing
public void setInvokesStopCellEditing(boolean newValue) Determines what happens when editing is interrupted by selecting another cell in the graph, a change in the graph's data, or by some other means. Setting this property totrue
causes the changes to be automatically saved when editing is interrupted.Fires a property change for the INVOKES_STOP_CELL_EDITING_PROPERTY.
- Parameters:
newValue
- true means thatstopCellEditing
is invoked when editing is interruped, and data is saved; false means thatcancelCellEditing
is invoked, and changes are lost
-
getInvokesStopCellEditing
public boolean getInvokesStopCellEditing()Returns the indicator that tells what happens when editing is interrupted.- Returns:
- the indicator that tells what happens when editing is interrupted
- See Also:
-
isCellEditable
Returnstrue
if the graph and the cell are editable. This is invoked from the UI before editing begins to ensure that the given cell can be edited.- Returns:
- true if the specified cell is editable
- See Also:
-
getToolTipText
OverridesJComponent
'sgetToolTipText
method in order to allow the graph to create a tooltip for the topmost cell under the mousepointer. This differs from JTree where the renderers tooltip is used.NOTE: For
JGraph
to properly display tooltips of its renderers,JGraph
must be a registered component with theToolTipManager
. This can be done by invokingToolTipManager.sharedInstance().registerComponent(graph)
. This is not done automatically!- Overrides:
getToolTipText
in classJComponent
- Parameters:
e
- theMouseEvent
that initiated theToolTip
display- Returns:
- a string containing the tooltip or
null
ifevent
is null
-
setSelectionModel
Sets the graph's selection model. When anull
value is specified an emtpyselectionModel
is used, which does not allow selections.- Parameters:
selectionModel
- theGraphSelectionModel
to use, ornull
to disable selections- See Also:
-
getSelectionModel
Returns the model for selections. This should always return a non-null
value. If you don't want to allow anything to be selected set the selection model tonull
, which forces an empty selection model to be used.- Returns:
- the current selection model
- See Also:
-
clearSelection
public void clearSelection()Clears the selection. -
isSelectionEmpty
public boolean isSelectionEmpty()Returns true if the selection is currently empty.- Returns:
- true if the selection is currently empty
-
addGraphSelectionListener
Adds a listener forGraphSelection
events.- Parameters:
tsl
- theGraphSelectionListener
that will be notified when a cell is selected or deselected (a "negative selection")
-
removeGraphSelectionListener
Removes aGraphSelection
listener.- Parameters:
tsl
- theGraphSelectionListener
to remove
-
fireValueChanged
Notifies all listeners that have registered interest for notification on this event type. The event instance is lazily created using the parameters passed into the fire method.- Parameters:
e
- theGraphSelectionEvent
generated by theGraphSelectionModel
when a cell is selected or deselected- See Also:
-
setSelectionCell
Selects the specified cell.- Parameters:
cell
- theObject
specifying the cell to select
-
setSelectionCells
Selects the specified cells.- Parameters:
cells
- an array of objects that specifies the cells to select
-
addSelectionCell
Adds the cell identified by the specifiedObject
to the current selection.- Parameters:
cell
- the cell to be added to the selection
-
addSelectionCells
Adds each cell in the array of cells to the current selection.- Parameters:
cells
- an array of objects that specifies the cells to add
-
removeSelectionCell
Removes the cell identified by the specified Object from the current selection.- Parameters:
cell
- the cell to be removed from the selection
-
getSelectionCell
Returns the first selected cell.- Returns:
- the
Object
for the first selected cell, ornull
if nothing is currently selected
-
getSelectionCells
Returns all selected cells.- Returns:
- an array of objects representing the selected cells, or
null
if nothing is currently selected
-
getSelectionCells
Returns all selected cells incells
. -
getSelectionCellAt
Returns the selection cell at the specified location.- Returns:
- Returns the selection cell for
pt
.
-
getSelectionCount
public int getSelectionCount()Returns the number of cells selected.- Returns:
- the number of cells selected
-
isCellSelected
Returns true if the cell is currently selected.- Parameters:
cell
- an object identifying a cell- Returns:
- true if the cell is selected
-
scrollCellToVisible
Scrolls to the specified cell. Only works when thisJGraph
is contained in aJScrollPane
.- Parameters:
cell
- the object identifying the cell to bring into view
-
scrollPointToVisible
Makes sure the specified point is visible.- Parameters:
p
- the point that should be visible
-
isEditing
public boolean isEditing()Returns true if the graph is being edited. The item that is being edited can be obtained usinggetEditingCell
.- Returns:
- true if the user is currently editing a cell
- See Also:
-
stopEditing
public boolean stopEditing()Ends the current editing session. (TheDefaultGraphCellEditor
object saves any edits that are currently in progress on a cell. Other implementations may operate differently.) Has no effect if the tree isn't being edited.Note:
To make edit-saves automatic whenever the user changes their position in the graph, usesetInvokesStopCellEditing(boolean)
.- Returns:
- true if editing was in progress and is now stopped, false if editing was not in progress
-
cancelEditing
public void cancelEditing()Cancels the current editing session. Has no effect if the graph isn't being edited. -
startEditingAtCell
Selects the specified cell and initiates editing. The edit-attempt fails if theCellEditor
does not allow editing for the specified item. -
getEditingCell
Returns the cell that is currently being edited.- Returns:
- the cell being edited
-
graphDidChange
public void graphDidChange()Messaged when the graph has changed enough that we need to resize the bounds, but not enough that we need to remove the cells (e.g cells were inserted into the graph). You should never have to invoke this, the UI will invoke this as it needs to. (Note: This is invoked by GraphUI, eg. after moving.) -
refresh
public void refresh()Repaints the entire graph, regardless of what is marked dirty -
getImage
Returns aBufferedImage
for the graph using inset as an empty border around the cells of the graph. If bg is null then a transparent background is applied to the image, else the background is filled with the bg color. Therefore, one should only use a null background if the fileformat support transparency, eg. GIF and PNG. For JPG, you can useColor.WHITE
for example.- Returns:
- Returns an image of the graph.
-
getClipRectangle
Calculates the clip- Parameters:
change
-- Returns:
- the total region dirty as a result of this change
-
getPreferredScrollableViewportSize
Returns the preferred display size of aJGraph
. The height is determined fromgetPreferredWidth
.- Specified by:
getPreferredScrollableViewportSize
in interfaceScrollable
- Returns:
- the graph's preferred size
-
getScrollableUnitIncrement
Returns the amount to increment when scrolling. The amount is 4.- Specified by:
getScrollableUnitIncrement
in interfaceScrollable
- Parameters:
visibleRect
- the view area visible within the viewportorientation
- eitherSwingConstants.VERTICAL
orSwingConstants.HORIZONTAL
direction
- less than zero to scroll up/left, greater than zero for down/right- Returns:
- the "unit" increment for scrolling in the specified direction
- See Also:
-
getScrollableBlockIncrement
Returns the amount for a block increment, which is the height or width ofvisibleRect
, based onorientation
.- Specified by:
getScrollableBlockIncrement
in interfaceScrollable
- Parameters:
visibleRect
- the view area visible within the viewportorientation
- eitherSwingConstants.VERTICAL
orSwingConstants.HORIZONTAL
direction
- less than zero to scroll up/left, greater than zero for down/right.- Returns:
- the "block" increment for scrolling in the specified direction
- See Also:
-
getScrollableTracksViewportWidth
public boolean getScrollableTracksViewportWidth()Returns false to indicate that the width of the viewport does not determine the width of the graph, unless the preferred width of the graph is smaller than the viewports width. In other words: ensure that the graph is never smaller than its viewport.- Specified by:
getScrollableTracksViewportWidth
in interfaceScrollable
- Returns:
- false
- See Also:
-
getScrollableTracksViewportHeight
public boolean getScrollableTracksViewportHeight()Returns false to indicate that the height of the viewport does not determine the height of the graph, unless the preferred height of the graph is smaller than the viewports height. In other words: ensure that the graph is never smaller than its viewport.- Specified by:
getScrollableTracksViewportHeight
in interfaceScrollable
- Returns:
- false
- See Also:
-
paramString
Returns a string representation of thisJGraph
. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not benull
.- Overrides:
paramString
in classJComponent
- Returns:
- a string representation of this
JGraph
.
-
main
-