salvo.jesus.graph.visual

Class GraphPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

salvo.jesus.graph.visual.GraphPanel

All Implemented Interfaces:

KeyListener, MouseListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

public class GraphPanel
extends JPanel
implements MouseListener, MouseMotionListener, KeyListener

GraphPanel encapsulates the visual representation of a graph (VisualGraph) into a panel. The panel is automatically resized depending on the location of the vertices. Therefore, if the user drags the mouse outside of the existing size of the panel, the panel is automaticall resized. However, the panel will not be smaller than the viewport of the GraphScrollPane.

Author:

Jesus M. Salvo Jr.

See Also:

GraphScrollPane, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class 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

Method Summary

Modifier and Type	Method and Description
protected void	finalize() Just make sure that we remove GraphPanelSizeable from vgraph's container list.
VisualGraph	getVisualGraph() Returns the VisualGraph that this class encapsulates.
void	keyPressed(KeyEvent e)
void	keyReleased(KeyEvent e)
void	keyTyped(KeyEvent e)
void	mouseClicked(MouseEvent e) Automatically called when the mouse is clicked on the GraphPanel.
void	mouseDragged(MouseEvent e) Automatically called when the mouse is dragged.
void	mouseEntered(MouseEvent e) Automatically called when the mouse enters the GraphPanel.
void	mouseExited(MouseEvent e) Automatically called when the mouse leaves the GraphPanel.
void	mouseMoved(MouseEvent e) Automatically called when the mouse is moved over the GraphPanel.
void	mousePressed(MouseEvent e) Automatically called when the mouse is pressed.
void	mouseReleased(MouseEvent e) Automatically called when the mouse is released.
void	paintComponent(Graphics g) Override of JPanel's paint() method.
GraphPanelState	processChangeStateEvent(ChangeStateEvent cse) Processes the ChangeStateEvent by delegating the event to the recommendState() method of the current state, possibly returning a new state.
void	setEdgeMode() Sets the mode of operation to EDGE_MODE
void	setGraph(Graph g, GraphScrollPane gp) Sets the Graph that this class encapsulates.
void	setGraphLayoutManager(GraphLayoutManager layoutmanager) Sets the layout manager to use to layout the vertices of the graph.
void	setNormalMode() Sets the mode of operation to NORMAL_MODE
void	setVertexMode() Sets the mode of operation to VERTEX_MODE
void	setVisualGraph(VisualGraph vg, GraphScrollPane gp) Sets the VisualGraph that this class encapsulates.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, 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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Method Detail

setVisualGraph

public void setVisualGraph(VisualGraph vg,
                           GraphScrollPane gp)

Sets the VisualGraph that this class encapsulates. This will automatically redraw the contents of the pane, thereby drawing the vertices and edges of VisualGraph.

Parameters:

vg - The visual graph to be encapsulated and drawn.

gp - The container that will contain this class. This is later on used to determine if we should resize GraphPanelSizeable

setGraph

public void setGraph(Graph g,
                     GraphScrollPane gp)

Sets the Graph that this class encapsulates. This will automatically redraw the contents of the pane, thereby drawing the vertices and edges of Graph.

Parameters:

g - The graph to be encapsulated and drawn.

gp - The container that will contain this class. This is later on used to determine if we should resize GraphPanelSizeable

getVisualGraph

public VisualGraph getVisualGraph()

Returns the VisualGraph that this class encapsulates.

Returns:

The VisualGraph that is encapsulated within this class.

setNormalMode

public void setNormalMode()

Sets the mode of operation to NORMAL_MODE

setVertexMode

public void setVertexMode()

Sets the mode of operation to VERTEX_MODE

setEdgeMode

public void setEdgeMode()

Sets the mode of operation to EDGE_MODE

setGraphLayoutManager

public void setGraphLayoutManager(GraphLayoutManager layoutmanager)

Sets the layout manager to use to layout the vertices of the graph.

Parameters:

layoutmanager - An object implementing the GraphLayoutManager interface.

paintComponent

public void paintComponent(Graphics g)

Override of JPanel's paint() method. Before the superclass' paint method is called, it compares the size (the maximum coordinates of the visual vertices) of vgraph with that of gpcontainer. If any coordinates (x or y) of vgraph is greater than the coordinates (size) of gpcontainer, GraphPanelSizeable's size is adjusted to that of vgraph. Doing this will have the effect of automatically adjusting the scrollbars of gpcontainer.

Overrides:

paintComponent in class JComponent

Parameters:

g - Graphics context that will be used to draw.

mouseDragged

public void mouseDragged(MouseEvent e)

Automatically called when the mouse is dragged. The result of this method call depends on the current mode or state of the GraphPanel, as determined by the internal GraphPanelState variable by passing the method call to the internal GraphPanelState object.

Specified by:

mouseDragged in interface MouseMotionListener

mousePressed

public void mousePressed(MouseEvent e)

Automatically called when the mouse is pressed. The result of this method call depends on the current mode or state of the GraphPanel, as determined by the internal GraphPanelState variable by passing the method call to the internal GraphPanelState object.

Specified by:

mousePressed in interface MouseListener

mouseReleased

public void mouseReleased(MouseEvent e)

Automatically called when the mouse is released. The result of this method call depends on the current mode or state of the GraphPanel, as determined by the internal GraphPanelState variable by passing the method call to the internal GraphPanelState object.

Specified by:

mouseReleased in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Automatically called when the mouse enters the GraphPanel. The result of this method call depends on the current mode or state of the GraphPanel, as determined by the internal GraphPanelState variable by passing the method call to the internal GraphPanelState object.

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Automatically called when the mouse leaves the GraphPanel. The result of this method call depends on the current mode or state of the GraphPanel, as determined by the internal GraphPanelState variable by passing the method call to the internal GraphPanelState object.

Specified by:

mouseExited in interface MouseListener

mouseClicked

public void mouseClicked(MouseEvent e)

Automatically called when the mouse is clicked on the GraphPanel. The result of this method call depends on the current mode or state of the GraphPanel, as determined by the internal GraphPanelState variable by passing the method call to the internal GraphPanelState object.

Specified by:

mouseClicked in interface MouseListener

mouseMoved

public void mouseMoved(MouseEvent e)

Automatically called when the mouse is moved over the GraphPanel. The result of this method call depends on the current mode or state of the GraphPanel, as determined by the internal GraphPanelState variable by passing the method call to the internal GraphPanelState object.

Specified by:

mouseMoved in interface MouseMotionListener

keyPressed

public void keyPressed(KeyEvent e)

Specified by:

keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent e)

Specified by:

keyReleased in interface KeyListener

keyTyped

public void keyTyped(KeyEvent e)

Specified by:

keyTyped in interface KeyListener

finalize

protected void finalize()

Just make sure that we remove GraphPanelSizeable from vgraph's container list.

Overrides:

finalize in class Object

processChangeStateEvent

public GraphPanelState processChangeStateEvent(ChangeStateEvent cse)

Processes the ChangeStateEvent by delegating the event to the recommendState() method of the current state, possibly returning a new state.

Returns:

the resulting state. Can be the previous state or a new state, depending on the current state's decision.