org.ginsim.gui.graph

Class BaseGraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

java.lang.Object

org.ginsim.gui.graph.BaseGraphGUI<G,V,E>

Type Parameters:

G -

V -

E -

All Implemented Interfaces:

SavingGUI, GraphListener<G>, GraphViewListener, GraphGUI<G,V,E>

Direct Known Subclasses:

CanvasGraphGUIImpl

public abstract class BaseGraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>
extends Object
implements GraphGUI<G,V,E>, GraphViewListener, GraphListener<G>

Abstract class providing generic parts of a Graph GUI.

Author:

Aurelien Naldi

Field Summary

Fields

Modifier and Type	Field and Description
protected G	graph
protected GraphSelection<V,E>	selection

Constructor Summary

Constructors

Constructor and Description
BaseGraphGUI(G g, GraphGUIHelper<G,V,E> helper, boolean can_be_saved)

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
protected void	fireSelectionChange()
GUIEditor<E>	getEdgeEditionPanel()
EditActionManager	getEditActionManager()
String	getEditingTabLabel()
Graph<V,E>	getGraph()
JPanel	getInfoPanel()
GUIEditor<G>	getMainEditionPanel()
GUIEditor<V>	getNodeEditionPanel()
GraphSelection<V,E>	getSelection() Get an object to interact with the selection
JMenu	getViewMenu(JMenu layout) Fill the view menu with actions available on this graph GUI
protected Action	getZoomAction(BaseGraphGUI<?,?,?> gui, ZoomEffect effect)
GraphEventCascade	graphChanged(G g, GraphChangeType type, Object data)
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.
boolean	save()
boolean	saveAs() Pick a destination and save the graph.
void	setSaved(boolean isSaved) Set the graph has been saved or has not been modified since opened
protected abstract void	setZoomLevel(ZoomEffect effect)
protected void	updateSelection(List<V> nodes, List<E> edges)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ginsim.gui.graph.GraphGUI

getGraphComponent, getZoomLevel, repaint, selectionChanged

Methods inherited from interface org.ginsim.core.graph.GraphViewListener

refresh, repaint

Field Detail

graph

protected final G extends Graph<V,E> graph

selection

protected final GraphSelection<V,E extends Edge<V>> selection

Constructor Detail

BaseGraphGUI

public BaseGraphGUI(G g,
                    GraphGUIHelper<G,V,E> helper,
                    boolean can_be_saved)

Method Detail

getGraph

public Graph<V,E> getGraph()

Specified by:

getGraph in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

Returns:

the underlying graph

getMainEditionPanel

public GUIEditor<G> getMainEditionPanel()

Specified by:

getMainEditionPanel in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

getEditingTabLabel

public String getEditingTabLabel()

Specified by:

getEditingTabLabel in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

getNodeEditionPanel

public GUIEditor<V> getNodeEditionPanel()

Specified by:

getNodeEditionPanel in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

getEdgeEditionPanel

public GUIEditor<E> getEdgeEditionPanel()

Specified by:

getEdgeEditionPanel in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

getInfoPanel

public JPanel getInfoPanel()

Specified by:

getInfoPanel in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

getEditActionManager

public EditActionManager getEditActionManager()

Specified by:

getEditActionManager in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

getViewMenu

public JMenu getViewMenu(JMenu layout)

Description copied from interface: GraphGUI

Fill the view menu with actions available on this graph GUI

Specified by:

getViewMenu in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

isSaved

public boolean isSaved()

Description copied from interface: GraphGUI

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

Specified by:

isSaved in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

Returns:

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

canBeSaved

public boolean canBeSaved()

Description copied from interface: GraphGUI

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

Specified by:

canBeSaved in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

Returns:

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

setSaved

public void setSaved(boolean isSaved)

Description copied from interface: GraphGUI

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

Specified by:

setSaved in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

save

public boolean save()

Specified by:

save in interface SavingGUI

saveAs

public boolean saveAs()

Description copied from interface: GraphGUI

Pick a destination and save the graph.

Specified by:

saveAs in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

fireGraphClose

public void fireGraphClose()

Description copied from interface: GraphGUI

Warn the listeners that the graph will be closed

Specified by:

fireGraphClose in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

addGraphGUIListener

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

Description copied from interface: GraphGUI

Register a GraphGUIListener

Specified by:

addGraphGUIListener in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

removeGraphGUIListener

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

Description copied from interface: GraphGUI

Remove a listener.

Specified by:

removeGraphGUIListener in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

isEditAllowed

public boolean isEditAllowed()

Specified by:

isEditAllowed in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

canCopyPaste

public boolean canCopyPaste()

Description copied from interface: GraphGUI

Does this graph type support copy/paste actions?

Specified by:

canCopyPaste in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

Returns:

true if copy/paste is supported, false otherwise.

getSelection

public GraphSelection<V,E> getSelection()

Description copied from interface: GraphGUI

Get an object to interact with the selection

Specified by:

getSelection in interface GraphGUI<G extends Graph<V,E>,V,E extends Edge<V>>

Returns:

updateSelection

protected void updateSelection(List<V> nodes,
                               List<E> edges)

fireSelectionChange

protected void fireSelectionChange()

graphChanged

public GraphEventCascade graphChanged(G g,
                                      GraphChangeType type,
                                      Object data)

Specified by:

graphChanged in interface GraphListener<G extends Graph<V,E>>

setZoomLevel

protected abstract void setZoomLevel(ZoomEffect effect)

getZoomAction

protected Action getZoomAction(BaseGraphGUI<?,?,?> gui,
                               ZoomEffect effect)