de.tesis.dynaware.grapheditor

Interface GraphEditor

public interface GraphEditor

Provides functionality for displaying and editing graph-like diagrams in JavaFX.

Example:

 GModel model = GraphFactory.eINSTANCE.createGModel();
 
 GraphEditor graphEditor = new DefaultGraphEditor();
 graphEditor.setModel(model);
 
 Region view = graphEditor.getView();
 

The view is a Region and can be added to the JavaFX scene graph in the usual way. For large graphs, the editor can be put inside a GraphEditorContainer instead.

The editor updates its underlying model via EMF commands. This means any user action should be undoable. Helper methods for common operations are provided in the Commands class, such as:

• Add Node
• Clear All
• Undo
• Redo

Look & feel can be customised by setting custom skin classes. The default skins can also be customised to some extent via CSS. See defaults.css in the core module for more information.

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<de.tesis.dynaware.grapheditor.model.GModel>	model The property containing the graph model being edited.

Method Summary

Modifier and Type	Method and Description
de.tesis.dynaware.grapheditor.model.GModel	getModel() Gets the graph model that is currently being edited.
GraphEditorProperties	getProperties() Gets the properties of the editor.
SelectionManager	getSelectionManager() Gets the selection manager.
SkinLookup	getSkinLookup() Gets the skin lookup.
javafx.scene.layout.Region	getView() Gets the view where the graph is displayed and edited.
javafx.beans.property.ObjectProperty<de.tesis.dynaware.grapheditor.model.GModel>	modelProperty() The property containing the graph model being edited.
void	reload() Reloads the graph model currently being edited.
void	setConnectionSkin(java.lang.String type, java.lang.Class<? extends GConnectionSkin> skin) Sets the custom connection skin for a particular connection type.
void	setConnectorSkin(java.lang.String type, java.lang.Class<? extends GConnectorSkin> skin) Sets the custom connector skin for a particular connector type.
void	setConnectorValidator(java.lang.Class<? extends GConnectorValidator> validator) Sets the custom connector validator class.
void	setJointSkin(java.lang.String type, java.lang.Class<? extends GJointSkin> skin) Sets the custom joint skin for a particular joint type.
void	setModel(de.tesis.dynaware.grapheditor.model.GModel model) Sets the graph model to be edited.
void	setNodeSkin(java.lang.String type, java.lang.Class<? extends GNodeSkin> skin) Sets the custom node skin for a particular node type.
void	setOnConnectionCreated(CommandAppender<de.tesis.dynaware.grapheditor.model.GConnection> appender) Sets a method to be called when a connection is created in the editor.
void	setOnConnectionRemoved(CommandAppender<de.tesis.dynaware.grapheditor.model.GConnection> appender) Sets a method to be called when a connection is removed in the editor.
void	setProperties(GraphEditorProperties properties) Sets the properties of the editor.
void	setTailSkin(java.lang.String type, java.lang.Class<? extends GTailSkin> skin) Sets the custom tail skin for a particular connector type.

Property Detail

model

javafx.beans.property.ObjectProperty<de.tesis.dynaware.grapheditor.model.GModel> modelProperty

The property containing the graph model being edited.

See Also:

getModel(), setModel(GModel)

Method Detail

setNodeSkin

void setNodeSkin(java.lang.String type,
                 java.lang.Class<? extends GNodeSkin> skin)

Sets the custom node skin for a particular node type.

All GNode model elements that have a 'Type' attribute equal to type set here will be rendered using this skin.

Parameters:

type - the GNode type for which this skin should be used

skin - a custom skin class that extends GNodeSkin

setConnectorSkin

void setConnectorSkin(java.lang.String type,
                      java.lang.Class<? extends GConnectorSkin> skin)

Sets the custom connector skin for a particular connector type.

All GConnector model elements that have a 'Type' attribute equal to type set here will be rendered using this skin.

Parameters:

type - the GConnector type for which this skin should be used

skin - a custom skin class that extends GConnectorSkin

setConnectionSkin

void setConnectionSkin(java.lang.String type,
                       java.lang.Class<? extends GConnectionSkin> skin)

Sets the custom connection skin for a particular connection type.

All GConnection model elements that have a 'Type' attribute equal to type set here will be rendered using this skin.

Parameters:

type - the GConnection type for which this skin should be used

skin - a custom skin class that extends GConnectionSkin

setJointSkin

void setJointSkin(java.lang.String type,
                  java.lang.Class<? extends GJointSkin> skin)

Sets the custom joint skin for a particular joint type.

All GJoint model elements that have a 'Type' attribute equal to type set here will be rendered using this skin.

Parameters:

type - the GJoint type for which this skin should be used

skin - a custom skin class that extends GJointSkin

setTailSkin

void setTailSkin(java.lang.String type,
                 java.lang.Class<? extends GTailSkin> skin)

Sets the custom tail skin for a particular connector type.

All GConnector model elements that have a 'Type' attribute equal to type set here will have their tails rendered using this skin.

Parameters:

type - the GConnector type for which this skin should be used

skin - a custom skin class that extends GTailSkin

setConnectorValidator

void setConnectorValidator(java.lang.Class<? extends GConnectorValidator> validator)

Sets the custom connector validator class.

This will be used to decide which connections are allowed / forbidden during drag & drop events in the editor.

Parameters:

validator - a custom validator class that implements GConnectorValidator

setModel

void setModel(de.tesis.dynaware.grapheditor.model.GModel model)

Sets the graph model to be edited.

Parameters:

model - the GModel to be edited

getModel

de.tesis.dynaware.grapheditor.model.GModel getModel()

Gets the graph model that is currently being edited.

Returns:

the GModel being edited, or null if no model was ever set

reload

void reload()

Reloads the graph model currently being edited.

Note:
If the model is updated via EMF commands, as is recommended, it should rarely be necessary to call this method. The model will be reloaded automatically via a command-stack listener.

modelProperty

javafx.beans.property.ObjectProperty<de.tesis.dynaware.grapheditor.model.GModel> modelProperty()

The property containing the graph model being edited.

See Also:

getModel(), setModel(GModel)

getView

javafx.scene.layout.Region getView()

Gets the view where the graph is displayed and edited.

The view is a JavaFX Region. It should be added to the scene graph in the usual way.

Returns:

the Region where the graph is displayed and edited

getProperties

GraphEditorProperties getProperties()

Gets the properties of the editor.

This provides access to global properties such as:

• Show/hide alignment grid.
• Toggle snap-to-grid on/off.
• Toggle editor bounds on/off.

Returns:

an GraphEditorProperties instance containing the properties of the editor

setProperties

void setProperties(GraphEditorProperties properties)

Sets the properties of the editor.

Parameters:

properties - an GraphEditorProperties instance specifying a set of properties for the editor

getSkinLookup

SkinLookup getSkinLookup()

Gets the skin lookup.

The skin lookup is used to get any skin instance associated to a model element instance.

Returns:

a SkinLookup used to lookup skins

getSelectionManager

SelectionManager getSelectionManager()

Gets the selection manager.

This provides access to actions like 'select all', 'delete selection', cut, copy, paste, and so on.

setOnConnectionCreated

void setOnConnectionCreated(CommandAppender<de.tesis.dynaware.grapheditor.model.GConnection> appender)

Sets a method to be called when a connection is created in the editor.

This can be used to append additional commands to the one that created the connection.

Parameters:

appender - the CommandAppender to be called

setOnConnectionRemoved

void setOnConnectionRemoved(CommandAppender<de.tesis.dynaware.grapheditor.model.GConnection> appender)

Sets a method to be called when a connection is removed in the editor.

This can be used to append additional commands to the one that removed the connection.

Parameters:

appender - the CommandAppender to be called