|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.gmf.runtime.common.core.service.AbstractProvider
org.eclipse.gmf.runtime.common.core.service.Service
org.eclipse.gmf.runtime.diagram.core.services.ViewService
public final class ViewService
A service for manipulating the notational models
Nested Class Summary | |
---|---|
protected static class |
ViewService.ProviderDescriptor
A descriptor for ISemanticProvider defined
by a configuration element. |
Field Summary |
---|
Fields inherited from class org.eclipse.gmf.runtime.common.core.service.Service |
---|
INVALID_ELEMENT_MESSAGE_PATTERN |
Constructor Summary | |
---|---|
protected |
ViewService()
creates an instance |
Method Summary | |
---|---|
static Diagram |
createDiagram(org.eclipse.emf.ecore.EObject context,
java.lang.String kind,
PreferencesHint preferencesHint)
Creates a diagram with the given context and kind |
Diagram |
createDiagram(IAdaptable semanticAdapter,
java.lang.String diagramKindType,
PreferencesHint preferencesHint)
create an Diagram element. |
static Diagram |
createDiagram(java.lang.String kind,
PreferencesHint preferencesHint)
Creates a diagram with a kind |
Edge |
createEdge(IAdaptable semanticAdapter,
View containerView,
java.lang.String semanticHint,
int index,
boolean persisted,
PreferencesHint preferencesHint)
create an Edge element. |
View |
createEdge(IAdaptable semanticAdapter,
View containerView,
java.lang.String semanticHint,
int index,
PreferencesHint preferencesHint)
|
static Edge |
createEdge(View source,
View target,
org.eclipse.emf.ecore.EObject eObject,
java.lang.String type,
PreferencesHint preferencesHint)
Creates an edge for a given eObject and with a given type and connects it between a given source and a given target |
static Edge |
createEdge(View source,
View target,
java.lang.String type,
PreferencesHint preferencesHint)
Creates an edge with a given type and connects it between the given source and target |
Node |
createNode(IAdaptable semanticAdapter,
View containerView,
java.lang.String semanticHint,
int index,
boolean persisted,
PreferencesHint preferencesHint)
creates a Node |
Node |
createNode(IAdaptable semanticElement,
View containerView,
java.lang.String semanticHint,
int index,
PreferencesHint preferencesHint)
creates a persisted Node |
static Node |
createNode(View container,
org.eclipse.emf.ecore.EObject eObject,
java.lang.String type,
PreferencesHint preferencesHint)
Creates a node for a given eObject and with a given type and inserts it into a given container |
static Node |
createNode(View container,
java.lang.String type,
PreferencesHint preferencesHint)
Creates a node for a with a given type and inserts it thegiven container |
protected java.util.Map |
createPriorityCache()
Creates a map for caching service providers keyed by the values returned in Service.getCachingKey(IOperation) . |
View |
createView(java.lang.Class viewKind,
IAdaptable semanticAdapter,
View containerView,
java.lang.String semanticHint,
int index,
boolean persisted,
PreferencesHint preferencesHint)
A convenience method to create a view with the given parameters |
protected java.lang.Object |
getCachingKey(IOperation operation)
Gets the key used to cache service providers that provide for operation in the map created by
Service.createPriorityCache() . |
static ViewService |
getInstance()
Retrieves the singleton instance of the notation service. |
protected Service.ProviderDescriptor |
newProviderDescriptor(IConfigurationElement element)
Creates a new provider descriptor for the specified configuration element . |
boolean |
provides(java.lang.Class viewKind,
IAdaptable semanticAdapter,
View containerView,
java.lang.String semanticHint,
int index,
boolean persisted,
PreferencesHint preferencesHint)
A convenience method to determine whether there is a provider that can create a view with the given parameters |
Methods inherited from class org.eclipse.gmf.runtime.common.core.service.Service |
---|
addProvider, clearCache, configureProviders, configureProviders, execute, executeUnique, getAllProviders, getPriority, getProviders, isOptimistic, isOptimized, providerChanged, provides, provides, removeProvider |
Methods inherited from class org.eclipse.gmf.runtime.common.core.service.AbstractProvider |
---|
addProviderChangeListener, fireProviderChange, removeProviderChangeListener |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.gmf.runtime.common.core.service.IProvider |
---|
addProviderChangeListener, provides, removeProviderChangeListener |
Constructor Detail |
---|
protected ViewService()
Method Detail |
---|
public static ViewService getInstance()
protected Service.ProviderDescriptor newProviderDescriptor(IConfigurationElement element)
Service
element
.
newProviderDescriptor
in class Service
element
- The configuration element from which to create the descriptor.
Service.newProviderDescriptor(org.eclipse.core.runtime.IConfigurationElement)
protected java.util.Map createPriorityCache()
Service
Service.getCachingKey(IOperation)
.
createPriorityCache
in class Service
Service.createPriorityCache()
protected java.lang.Object getCachingKey(IOperation operation)
Service
operation
in the map created by
Service.createPriorityCache()
.
getCachingKey
in class Service
operation
- IOperation
for which the key will be retrieved
org.eclipse.gmf.runtime.common.core.service.Service#getCacheKey(org.eclipse.gmf.runtime.common.core.service.IOperation)
public final boolean provides(java.lang.Class viewKind, IAdaptable semanticAdapter, View containerView, java.lang.String semanticHint, int index, boolean persisted, PreferencesHint preferencesHint)
viewKind
- semanticAdapter
- adapts to either Integer or IReference
containerView
- semanticHint
- index
- 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:
- boolean
public final View createView(java.lang.Class viewKind, IAdaptable semanticAdapter, View containerView, java.lang.String semanticHint, int index, boolean persisted, PreferencesHint preferencesHint)
viewKind
- semanticAdapter
- adapts to IReferencecontainerView
- semanticHint
- index
- 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:
- IView
public final Diagram createDiagram(IAdaptable semanticAdapter, java.lang.String diagramKindType, PreferencesHint preferencesHint)
IViewProvider
Diagram
element.
createDiagram
in interface IViewProvider
diagramKindType
- indicates the diagram typepreferencesHint
- 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>.
Diagram
public static Diagram createDiagram(org.eclipse.emf.ecore.EObject context, java.lang.String kind, PreferencesHint preferencesHint)
context
- The diagram element contextkind
- diagram kind, check ViewType
for predefined valuespreferencesHint
- 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>.
Diagram
public static Diagram createDiagram(java.lang.String kind, PreferencesHint preferencesHint)
kind
- diagram kind, check ViewType
for predefined valuespreferencesHint
- 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>.
Diagram
public static Node createNode(View container, org.eclipse.emf.ecore.EObject eObject, java.lang.String type, PreferencesHint preferencesHint)
container
- The node view containereObject
- The node view object contexttype
- The node view type, check ViewType
for predefined
valuespreferencesHint
- 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>.
Node
public static Node createNode(View container, java.lang.String type, PreferencesHint preferencesHint)
container
- The node view containertype
- The node view type, check ViewType
for predefined
valuespreferencesHint
- 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>.
Node
public static Edge createEdge(View source, View target, org.eclipse.emf.ecore.EObject eObject, java.lang.String type, PreferencesHint preferencesHint)
source
- The edge's source viewtarget
- The edge's target vieweObject
- The edge view object contexttype
- The edge view type, check ViewType
for predefined
valuespreferencesHint
- 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>.
Edge
public static Edge createEdge(View source, View target, java.lang.String type, PreferencesHint preferencesHint)
source
- The edge's source viewtarget
- The edge's target viewtype
- The edge view type, check ViewType
for predefined
valuespreferencesHint
- 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>.
Edge
public final Edge createEdge(IAdaptable semanticAdapter, View containerView, java.lang.String semanticHint, int index, boolean persisted, PreferencesHint preferencesHint)
IViewProvider
Edge
element.
createEdge
in interface IViewProvider
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 notpreferencesHint
- 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>.
Edge
public final View createEdge(IAdaptable semanticAdapter, View containerView, java.lang.String semanticHint, int index, PreferencesHint preferencesHint)
semanticAdapter
- containerView
- semanticHint
- index
- 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>.
public final Node createNode(IAdaptable semanticElement, View containerView, java.lang.String semanticHint, int index, PreferencesHint preferencesHint)
semanticElement
- containerView
- semanticHint
- index
- 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>.
public Node createNode(IAdaptable semanticAdapter, View containerView, java.lang.String semanticHint, int index, boolean persisted, PreferencesHint preferencesHint)
createNode
in interface IViewProvider
semanticElement
- containerView
- semanticHint
- persisted
- index
- 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>.
|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.