energy.optionModel.gui.graph

Class StateGraphPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

energy.optionModel.gui.graph.StateGraphPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.Observer, javax.accessibility.Accessible

public class StateGraphPanel
extends javax.swing.JPanel
implements java.util.Observer

This class implements a GUI component for displaying visualizations for JUNG graphs.
This class also has a toolbar component which provides various features for editing, importing and interacting with the graph.

See Also:

StateGraphMousePlugin, Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.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

Constructor Summary

Constructors

Constructor and Description
StateGraphPanel(OptionModelController controller) This is the default constructor

Method Summary

Modifier and Type	Method and Description
State	addState(java.awt.geom.Point2D position) Adds a StateVisNode .
void	addStateTransition(StateTransition stateTransition, State sourceState) Adds a new edge between two operating state.
void	addStateTransition(StateVisNode sourceNode, StateVisNode destinNode) Adds a new StateVisTransition between a source and a destination StateVisNode.
void	clearGraph() Clears the graph.
void	exportAsImage() Export the current graph as image by using a file selection dialog.
java.awt.geom.Rectangle2D	getGraphSpreadDimension(java.util.Collection<StateVisNode> graphNodes) Gets the vertices spread dimension.
java.awt.geom.Rectangle2D	getGraphSpreadDimension(edu.uci.ics.jung.graph.Graph<StateVisNode,StateVisTransition> graph) Gets the graph spread as Rectangle.
java.util.Set<StateVisTransition>	getPickedEdges() Gets the Set of picked edges.
java.util.Set<StateVisNode>	getPickedNodes() Gets the Set of picked nodes.
StateVisTransition	getPickedSingleEdge() Returns the edge which is picked.
StateVisNode	getPickedSingleNode() Returns the node which is picked.
edu.uci.ics.jung.visualization.control.PluggableGraphMouse	getPluggableGraphMouse() Gets the PluggableGraphMouse.
State	getState(StateVisNode stateVisNode) Returns the state form the specified StateVisNode.
StateGraphTools	getStateGraphTools() Gets the StateGraphTools.
StateTransition	getStateTransition(StateVisTransition edge) Gets the StateTransition for the specified StateVisTransition.
java.util.HashMap<StateTransition,StateVisTransition>	getStateTransitionHash() Gets the transition state hash.
StateVisNode	getStateVisNode(State state) Returns the StateVisNode from the specified State.
StateGraphVisViewer<StateVisNode,StateVisTransition>	getVisView() Gets the VisualizationViewer
void	handleObjectDoubleClick(java.lang.Object pickedObject) Invoked when a graph node or edge is double clicked (left or right)
void	handleObjectLeftClick(java.lang.Object pickedObject) This method notifies the observers about a graph object selection
void	handleObjectRightClick(java.lang.Object pickedObject) Notifies the observers that this object is right clicked
void	setGraphMousePicking() Sets the graph mouse picking.
void	setGraphMouseTransforming() Sets the graph mouse transforming.
void	setPickedObjects(java.util.Vector<StateVisElement> objects) Marks a group of objects as picked
void	setStatePosition(StateVisNode stateVisNode, java.awt.geom.Point2D newPosition) Sets the state position in the graph.
void	setStateTransitionHash(java.util.HashMap<StateTransition,StateVisTransition> transitionStateHash) Sets the transition state hash.
void	update(java.util.Observable observable, java.lang.Object updateObject)
void	zoomFit2Window() Zoom - fits to window.
void	zoomIn() Zoom in.
void	zoomOneToOne() Zoom one to one and move the focus, so that the elements are visible.
void	zoomOut() Zoom out.

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, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StateGraphPanel

public StateGraphPanel(OptionModelController controller)

This is the default constructor

Parameters:

controller - The Graph Environment controller

Method Detail

getStateGraphTools

public StateGraphTools getStateGraphTools()

Gets the StateGraphTools.

Returns:

the state graph tools

getVisView

public StateGraphVisViewer<StateVisNode,StateVisTransition> getVisView()

Gets the VisualizationViewer

Returns:

The VisualizationViewer

getPluggableGraphMouse

public edu.uci.ics.jung.visualization.control.PluggableGraphMouse getPluggableGraphMouse()

Gets the PluggableGraphMouse.

Returns:

the pluggableGraphMouse

setGraphMousePicking

public void setGraphMousePicking()

Sets the graph mouse picking.

setGraphMouseTransforming

public void setGraphMouseTransforming()

Sets the graph mouse transforming.

handleObjectLeftClick

public void handleObjectLeftClick(java.lang.Object pickedObject)

This method notifies the observers about a graph object selection

Parameters:

pickedObject - The selected object

handleObjectRightClick

public void handleObjectRightClick(java.lang.Object pickedObject)

Notifies the observers that this object is right clicked

Parameters:

pickedObject - the selected object

handleObjectDoubleClick

public void handleObjectDoubleClick(java.lang.Object pickedObject)

Invoked when a graph node or edge is double clicked (left or right)

Parameters:

pickedObject -

setPickedObjects

public void setPickedObjects(java.util.Vector<StateVisElement> objects)

Marks a group of objects as picked

Parameters:

objects - The objects

getPickedSingleNode

public StateVisNode getPickedSingleNode()

Returns the node which is picked. If multiple nodes are picked, returns null.

Returns:

StateVisNode - the StateVisNode which is picked.

getPickedNodes

public java.util.Set<StateVisNode> getPickedNodes()

Gets the Set of picked nodes.

Returns:

the picked nodes

getPickedSingleEdge

public StateVisTransition getPickedSingleEdge()

Returns the edge which is picked. If multiple nodes are picked, returns null.

Returns:

GraphEdge - the StateVisNode which is picked.

getPickedEdges

public java.util.Set<StateVisTransition> getPickedEdges()

Gets the Set of picked edges.

Returns:

the picked edges

exportAsImage

public void exportAsImage()

Export the current graph as image by using a file selection dialog.

zoomIn

public void zoomIn()

Zoom in.

zoomOut

public void zoomOut()

Zoom out.

zoomOneToOne

public void zoomOneToOne()

Zoom one to one and move the focus, so that the elements are visible.

zoomFit2Window

public void zoomFit2Window()

Zoom - fits to window.

getGraphSpreadDimension

public java.awt.geom.Rectangle2D getGraphSpreadDimension(edu.uci.ics.jung.graph.Graph<StateVisNode,StateVisTransition> graph)

Gets the graph spread as Rectangle.

Parameters:

graph - the graph

Returns:

the graph spread

getGraphSpreadDimension

public java.awt.geom.Rectangle2D getGraphSpreadDimension(java.util.Collection<StateVisNode> graphNodes)

Gets the vertices spread dimension.

Parameters:

graphNodes - the graph nodes

Returns:

the vertices spread dimension

getStateVisNode

public StateVisNode getStateVisNode(State state)

Returns the StateVisNode from the specified State.

Parameters:

state - the state

Returns:

the StateVisNode

getState

public State getState(StateVisNode stateVisNode)

Returns the state form the specified StateVisNode.

Parameters:

stateVisNode - the state vis node

Returns:

the state

addState

public State addState(java.awt.geom.Point2D position)

Adds a StateVisNode .

Parameters:

position - the desired position for the StateVisNode

Returns:

the created State

setStatePosition

public void setStatePosition(StateVisNode stateVisNode,
                             java.awt.geom.Point2D newPosition)

Sets the state position in the graph.

Parameters:

stateVisNode - the StateVisNode

newPosition - the new position

addStateTransition

public void addStateTransition(StateVisNode sourceNode,
                               StateVisNode destinNode)

Adds a new StateVisTransition between a source and a destination StateVisNode.

Parameters:

sourceNode - the source StateVisNode

destinNode - the destination StateVisNode

addStateTransition

public void addStateTransition(StateTransition stateTransition,
                               State sourceState)

Adds a new edge between two operating state.

Parameters:

stateTransition - the state transition

sourceState - the source state

getStateTransition

public StateTransition getStateTransition(StateVisTransition edge)

Gets the StateTransition for the specified StateVisTransition.

Parameters:

edge - the StateVisTransition

Returns:

the StateTransition

clearGraph

public void clearGraph()

Clears the graph.

setStateTransitionHash

public void setStateTransitionHash(java.util.HashMap<StateTransition,StateVisTransition> transitionStateHash)

Sets the transition state hash.

Parameters:

transitionStateHash - the transition state hash

getStateTransitionHash

public java.util.HashMap<StateTransition,StateVisTransition> getStateTransitionHash()

Gets the transition state hash.

Returns:

the transition state hash

update

public void update(java.util.Observable observable,
                   java.lang.Object updateObject)

Specified by:

update in interface java.util.Observer