org.ginsim.gui.graph

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

Type Parameters:

G -

V -

E -

All Known Implementing Classes:

DynamicGraphGUIHelper, HierarchicalTransitionGraphGUIHelper, ReducedGraphGUIHelper, RegulatoryGraphGUIHelper, TrapSpaceTreeGUIHelper, TreeGUIHelper

public interface GraphGUIHelper<G extends Graph<V,E>,V,E extends Edge<V>>

GUI-side helper for a graph type. A helper is a singleton dedicated to a specific graph type. It provides GUI components required to visualize and edit a graph. Implementors must be called with the same pattern: 'GUIHelper.java' in order to have the GraphGUIHelperFactory able to create their instances through introspective access Implementations must be annotated "@MetaInfServices( GraphGUIHelper.class)" to be discovered at runtime

Author:

Aurelien Naldi

Method Summary

Modifier and Type	Method and Description
boolean	canCopyPaste(G graph) Does this graph type support copy/paste actions?
GUIEditor<E>	getEdgeEditionPanel(G graph) Create an edition panel for edges.
List<EditAction>	getEditActions(G graph)
String	getEditingTabLabel(G graph) Retrieve the Title used for the selection edition tab
FileFilter	getFileFilter() Provide the file filter to apply to a file chooser
Class<G>	getGraphClass() Get the graph class the helper helps to manage
JPanel	getInfoPanel(G graph) Create an Information Panel
GUIEditor<G>	getMainEditionPanel(G graph) Create an edition panel for the graph itself.
GUIEditor<V>	getNodeEditionPanel(G graph) Create an edition panel for nodes.
JPanel	getSaveOptionPanel(G graph) Create a panel containing the option for graph saving

Method Detail

getMainEditionPanel

GUIEditor<G> getMainEditionPanel(G graph)

Create an edition panel for the graph itself.

Parameters:

graph - the graph requiring the panel

Returns:

getEditingTabLabel

String getEditingTabLabel(G graph)

Retrieve the Title used for the selection edition tab

Parameters:

graph - the graph requiring the panel

Returns:

getNodeEditionPanel

GUIEditor<V> getNodeEditionPanel(G graph)

Create an edition panel for nodes.

Parameters:

graph - the graph requiring the panel

Returns:

getEdgeEditionPanel

GUIEditor<E> getEdgeEditionPanel(G graph)

Create an edition panel for edges.

Parameters:

graph - the graph requiring the panel

Returns:

getInfoPanel

JPanel getInfoPanel(G graph)

Create an Information Panel

Parameters:

graph - the graph requiring the panel

Returns:

an Information Panel

getGraphClass

Class<G> getGraphClass()

Get the graph class the helper helps to manage

Returns:

the graph class the helper helps to manage

getEditActions

List<EditAction> getEditActions(G graph)

Parameters:

graph - the edited graph

Returns:

the list of actions or null if none are available

getFileFilter

FileFilter getFileFilter()

Provide the file filter to apply to a file chooser

Returns:

the file filter to apply to a file chooser

getSaveOptionPanel

JPanel getSaveOptionPanel(G graph)

Create a panel containing the option for graph saving

Parameters:

graph - the edited graph

canCopyPaste

boolean canCopyPaste(G graph)

Does this graph type support copy/paste actions?

Parameters:

graph -

Returns:

true if copy/paste is supported, false otherwise.