org.eclipse.gmf.runtime.diagram.core.providers
Interface IViewProvider

All Superinterfaces:

IProvider

All Known Implementing Classes:

AbstractViewProvider, ViewService

public interface IViewProvider

extends IProvider

Method Summary

Diagram	createDiagram(IAdaptable semanticAdapter, java.lang.String diagramKind, PreferencesHint preferencesHint) create an Diagram element.
Edge	createEdge(IAdaptable semanticAdapter, View containerView, java.lang.String semanticHint, int index, boolean persisted, PreferencesHint preferencesHint) create an Edge element.
Node	createNode(IAdaptable semanticAdapter, View containerView, java.lang.String semanticHint, int index, boolean persisted, PreferencesHint preferencesHint) create a Node.

Methods inherited from interface org.eclipse.gmf.runtime.common.core.service.IProvider

addProviderChangeListener, provides, removeProviderChangeListener

Method Detail

createDiagram

public Diagram createDiagram(IAdaptable semanticAdapter,
                             java.lang.String diagramKind,
                             PreferencesHint preferencesHint)

create an Diagram element.

Parameters:

diagramKind - indicates the diagram type

preferencesHint - The preference hint that is to be used to find the appropriate preference store from which to retrieve diagram preference values. The preference hint is mapped to a preference store in the preference registry <@link DiagramPreferencesRegistry>.

Returns:

the created Diagram

createEdge

public Edge createEdge(IAdaptable semanticAdapter,
                       View containerView,
                       java.lang.String semanticHint,
                       int index,
                       boolean persisted,
                       PreferencesHint preferencesHint)

create an Edge element.

Parameters:

containerView - the container view that will contain the created view.

index - position in the container view's list of children views.

persisted - indicates if the created edge will be persisted or not

preferencesHint - The preference hint that is to be used to find the appropriate preference store from which to retrieve diagram preference values. The preference hint is mapped to a preference store in the preference registry <@link DiagramPreferencesRegistry>.

Returns:

the created Edge

createNode

public Node createNode(IAdaptable semanticAdapter,
                       View containerView,
                       java.lang.String semanticHint,
                       int index,
                       boolean persisted,
                       PreferencesHint preferencesHint)

create a Node.

Parameters:

containerView - the container view that will contain the created view.

index - position in the container view's list of children views.

persisted - indicates if the created view will be persisted or not

preferencesHint - The preference hint that is to be used to find the appropriate preference store from which to retrieve diagram preference values. The preference hint is mapped to a preference store in the preference registry <@link DiagramPreferencesRegistry>.

Returns:

the created Node