org.ginsim.gui.graph

Interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

Type Parameters:

V -

E -

All Superinterfaces:

SavingGUI

All Known Implementing Classes:

BaseGraphGUI, CanvasGraphGUIImpl

public interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>
extends SavingGUI

Deal with the GUI view of a graph: get a component, provide access to selected items and view options.

Author:

Aurelien Naldi

Method Summary

Modifier and Type	Method and Description
void	addGraphGUIListener(GraphGUIListener<G,V,E> listener) Register a GraphGUIListener
boolean	canBeSaved() Indicates if the type of graph associated to the GraphGUI can be saved or not
boolean	canCopyPaste() Does this graph type support copy/paste actions?
void	fireGraphClose() Warn the listeners that the graph will be closed
GUIEditor<E>	getEdgeEditionPanel()
EditActionManager	getEditActionManager()
String	getEditingTabLabel()
Graph<V,E>	getGraph()
Component	getGraphComponent()
JPanel	getInfoPanel()
GUIEditor<G>	getMainEditionPanel()
GUIEditor<V>	getNodeEditionPanel()
GraphSelection<V,E>	getSelection() Get an object to interact with the selection
JMenu	getViewMenu(JMenu layoutMenu) Fill the view menu with actions available on this graph GUI
double	getZoomLevel()
boolean	isEditAllowed()
boolean	isSaved() Returns true if this graph has not been modified since the last change
void	removeGraphGUIListener(GraphGUIListener<G,V,E> listener) Remove a listener.
void	repaint() Force a repaint (should be used only by layout actions)
boolean	saveAs() Pick a destination and save the graph.
void	selectionChanged() Update selection to reflect the internal selection object
void	setSaved(boolean isSaved) Set the graph has been saved or has not been modified since opened

Methods inherited from interface org.ginsim.commongui.SavingGUI

save

Method Detail

getGraph

Graph<V,E> getGraph()

Returns:

the underlying graph

getGraphComponent

Component getGraphComponent()

Returns:

the widget showing the graph

getViewMenu

JMenu getViewMenu(JMenu layoutMenu)

Fill the view menu with actions available on this graph GUI

getMainEditionPanel

GUIEditor<G> getMainEditionPanel()

getEditingTabLabel

String getEditingTabLabel()

getNodeEditionPanel

GUIEditor<V> getNodeEditionPanel()

getEdgeEditionPanel

GUIEditor<E> getEdgeEditionPanel()

getInfoPanel

JPanel getInfoPanel()

getEditActionManager

EditActionManager getEditActionManager()

canCopyPaste

boolean canCopyPaste()

Does this graph type support copy/paste actions?

Returns:

true if copy/paste is supported, false otherwise.

isSaved

boolean isSaved()

Returns true if this graph has not been modified since the last change

Returns:

true if this graph has not been modified since the last change

setSaved

void setSaved(boolean isSaved)

Set the graph has been saved or has not been modified since opened

Parameters:

isSaved -

canBeSaved

boolean canBeSaved()

Indicates if the type of graph associated to the GraphGUI can be saved or not

Returns:

true if the type of graph associated to the GraphGUI can be saved, false if not

saveAs

boolean saveAs()

Pick a destination and save the graph.

fireGraphClose

void fireGraphClose()

Warn the listeners that the graph will be closed

addGraphGUIListener

void addGraphGUIListener(GraphGUIListener<G,V,E> listener)

Register a GraphGUIListener

Parameters:

listener -

removeGraphGUIListener

void removeGraphGUIListener(GraphGUIListener<G,V,E> listener)

Remove a listener.

Parameters:

listener -

getSelection

GraphSelection<V,E> getSelection()

Get an object to interact with the selection

Returns:

isEditAllowed

boolean isEditAllowed()

selectionChanged

void selectionChanged()

Update selection to reflect the internal selection object

repaint

void repaint()

Force a repaint (should be used only by layout actions)

getZoomLevel

double getZoomLevel()