|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDiagramTypeProvider
The Interface IDiagramTypeProvider is the central interface from the Graphiti framework to the diagram type agent. Do not implement this class directly. Extend appropriate classes instead. This is the first revision of the diagram type interface.
Method Summary | |
---|---|
void |
dispose()
Dispose. |
IToolBehaviorProvider[] |
getAvailableToolBehaviorProviders()
Get the list of available tool behaviour providers. |
String |
getContextId()
Gets the context id. |
int |
getCurrentToolBehaviorIndex()
|
IToolBehaviorProvider |
getCurrentToolBehaviorProvider()
Gets the current tool behaviour provider. |
Diagram |
getDiagram()
Returns the diagram. |
IDiagramBehavior |
getDiagramBehavior()
Returns the current diagram behavior instance. |
IDiagramEditor |
getDiagramEditor()
Deprecated. Use getDiagramBehavior() instead |
String |
getDiagramTitle()
Returns the diagram title. |
IGraphicsAlgorithmRendererFactory |
getGraphicsAlgorithmRendererFactory()
Gets the graphics algorithm renderer factory. |
INotificationService |
getNotificationService()
Returns the notification service. |
Object[] |
getRelatedBusinessObjects(Object[] bos)
Gets the related business objects. |
void |
init(Diagram diagram,
IDiagramBehavior diagramBehavior)
Implement this method to initialize the diagram type provider. |
void |
init(Diagram diagram,
IDiagramEditor diagramEditor)
Deprecated. Use init(Diagram, IDiagramBehavior) instead |
boolean |
isAutoUpdateAtReset()
Returns the editor's update behaviour on reset. |
boolean |
isAutoUpdateAtRuntime()
Returns the editor's update behaviour. |
boolean |
isAutoUpdateAtRuntimeWhenEditorIsSaved()
Returns the editor's update behaviour when the editor is saved. |
boolean |
isAutoUpdateAtStartup()
Returns the editor's update behaviour at startup. |
void |
postInit()
This method will be called after this diagram type provider has been completely initialised. |
void |
resourceReloaded(Diagram diagram)
This method will be called if the underlying resource which contains the diagram has been reloaded. |
void |
resourcesSaved(Diagram diagram,
Resource[] savedResources)
This method will be called by the DiagramEditor when a diagram has been saved. |
void |
setContextId(String contextId)
Sets the context id. |
void |
setCurrentToolBehaviorIndex(int index)
|
Methods inherited from interface org.eclipse.graphiti.platform.IExtension |
---|
getProviderId, setProviderId |
Methods inherited from interface org.eclipse.graphiti.features.IFeatureProviderHolder |
---|
getFeatureProvider |
Method Detail |
---|
void init(Diagram diagram, IDiagramEditor diagramEditor)
init(Diagram, IDiagramBehavior)
instead
diagram
- the currently opened diagramdiagramEditor
- void init(Diagram diagram, IDiagramBehavior diagramBehavior)
diagram
- the currently opened diagramdiagramEditor
- Diagram getDiagram()
INotificationService getNotificationService()
IToolBehaviorProvider[] getAvailableToolBehaviorProviders()
IToolBehaviorProvider
IToolBehaviorProvider getCurrentToolBehaviorProvider()
IToolBehaviorProvider
String getDiagramTitle()
boolean isAutoUpdateAtStartup()
boolean isAutoUpdateAtRuntime()
update feature
of the PictogramElement
s changes are indicated
for.isAutoUpdateAtRuntimeWhenEditorIsSaved()
.
boolean isAutoUpdateAtRuntimeWhenEditorIsSaved()
isAutoUpdateAtRuntime()
returns
true
and the editor is not dirty. In case this method
returns true
the editor will do an update; this will usually
cause the editor to get dirty.
boolean isAutoUpdateAtReset()
IDiagramEditor getDiagramEditor()
getDiagramBehavior()
instead
IDiagramBehavior getDiagramBehavior()
IDiagramBehavior
void dispose()
Object[] getRelatedBusinessObjects(Object[] bos)
bos
- the business objects
IGraphicsAlgorithmRendererFactory getGraphicsAlgorithmRendererFactory()
void postInit()
int getCurrentToolBehaviorIndex()
void setCurrentToolBehaviorIndex(int index)
void resourceReloaded(Diagram diagram)
diagram
- void resourcesSaved(Diagram diagram, Resource[] savedResources)
diagram
- The diagram for which the editor has been savedsavedResources
- The resources that have been savedString getContextId()
void setContextId(String contextId)
contextId
- the new context id
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |