com.ibm.xtools.uml.ui.diagram

Interface IUMLDiagramHelper

public interface IUMLDiagramHelper

This class provides API for manipulating UML diagrams.

Method Summary

Modifier and Type	Method and Description
boolean	canCreateViews(org.eclipse.gmf.runtime.notation.Diagram diagram, java.util.List<?> objects) Returns whether views can be created for the objects specified by objects in the diagram specified by diagram
org.eclipse.gmf.runtime.notation.Diagram	createDiagram(org.eclipse.uml2.uml.Namespace container, UMLDiagramKind kind) Creates a UML diagram with a given kind and inserts it into a given container
org.eclipse.gmf.runtime.notation.Diagram	createDiagram(org.eclipse.uml2.uml.Namespace container, UMLDiagramKind kind, org.eclipse.uml2.uml.Element context) Creates a UML diagram with a given context and kind and inserts it into a given container
org.eclipse.gmf.runtime.notation.Edge	createEdge(org.eclipse.gmf.runtime.notation.View source, org.eclipse.gmf.runtime.notation.View target, org.eclipse.uml2.uml.Element element) Creates an edge for a given element and connects it between a given source and a given target
org.eclipse.gmf.runtime.notation.Edge	createEdge(org.eclipse.gmf.runtime.notation.View source, org.eclipse.gmf.runtime.notation.View target, java.lang.String type) Creates an edge with a given type and connects it between a given source and a given target, basic edge types are "NoteAttachment"
java.util.List<org.eclipse.gmf.runtime.notation.Edge>	createEdges(org.eclipse.gmf.runtime.notation.Diagram diagram, org.eclipse.uml2.uml.Relationship element) Creates diagram edges between the related elements of a relationship
org.eclipse.gmf.runtime.notation.Node	createNode(org.eclipse.gmf.runtime.notation.View container, org.eclipse.uml2.uml.Element element) Creates a node for a given element and inserts it into a given container
org.eclipse.gmf.runtime.notation.Node	createNode(org.eclipse.gmf.runtime.notation.View container, java.lang.String type) Creates a node with a given type and inserts it into a given container basic types are "Note" "Text" "DiagramName" "DiagramLink"
java.util.List<org.eclipse.gmf.runtime.notation.View>	createViews(org.eclipse.gmf.runtime.notation.Diagram diagram, java.util.List<?> objects) Creates views for the objects specified by objects in the diagram specified by diagram.
void	destroyView(org.eclipse.gmf.runtime.notation.View view) Destroys a given view
org.eclipse.gmf.runtime.notation.Diagram	findDiagram(org.eclipse.uml2.uml.Element root, java.lang.String id, org.eclipse.core.runtime.IProgressMonitor monitor) Finds diagram whose ID matches exactly the specified id.
org.eclipse.gmf.runtime.notation.Diagram	findDiagramById(org.eclipse.uml2.uml.Model model, java.lang.String id, org.eclipse.core.runtime.IProgressMonitor monitor) Deprecated. Since 7.5, use the findDiagram(Element, String, IProgressMonitor) method, instead.
java.util.Set<org.eclipse.gmf.runtime.notation.Diagram>	findDiagramByName(org.eclipse.uml2.uml.Element container, java.lang.String name, org.eclipse.core.runtime.IProgressMonitor monitor) Finds the diagrams whose name and type match exactly the specified name and type respectively.
org.eclipse.gmf.runtime.notation.View	getChildView(org.eclipse.gmf.runtime.notation.View container, java.lang.String type) Gets the child view with a given type from a given view
java.util.List<org.eclipse.gmf.runtime.notation.Diagram>	getDiagrams(org.eclipse.uml2.uml.Namespace element) Gets a list of diagrams for a given element
java.util.List<org.eclipse.gmf.runtime.notation.Diagram>	getDiagrams(org.eclipse.uml2.uml.Namespace element, UMLDiagramKind kind) Gets a list of diagrams of a given kind for a given element
org.eclipse.gmf.runtime.diagram.ui.services.layout.ILayoutNode	getLayoutNode(org.eclipse.gmf.runtime.notation.Node node) getLayoutNode Gets the ILayoutNode in order to retrieve the actual size of the Node object irrespective of the autosize properties.
org.eclipse.gmf.runtime.notation.Diagram	getMainDiagram(org.eclipse.uml2.uml.Namespace element) Gets the main diagram of an element
UMLDiagramKind	getUmlDiagramKind(org.eclipse.gmf.runtime.notation.Diagram diagram) Retrieves the UMLDiagramKind of the specified diagram
void	layout(org.eclipse.gmf.runtime.notation.View view, java.lang.String hint) layout Utility method to layout the children of a view container.
void	layoutNodes(java.util.List<? extends org.eclipse.gmf.runtime.notation.Node> nodes, java.lang.String hint) layoutNodes Utility method to layout a list of Node children on a diagram.
void	openDiagramEditor(org.eclipse.gmf.runtime.notation.Diagram diagram) Opens an editor for a given diagram
java.awt.Image	renderToAWTImage(org.eclipse.gmf.runtime.notation.Diagram diagram) renderToAWTImage Utility api to generate an AWT based image representation of the diagram contents.
void	renderToImageFile(org.eclipse.gmf.runtime.notation.Diagram diagram, java.lang.String file, org.eclipse.gmf.runtime.diagram.ui.image.ImageFileFormat format) renderToImageFile Utility api to render the diagram to a specified image formatation of the diagram contents.
org.eclipse.swt.graphics.Image	renderToSWTImage(org.eclipse.gmf.runtime.notation.Diagram diagram) renderToSWTImage Utility api to generate an SWT based image representation of the diagram contents.
void	setMainDiagram(org.eclipse.uml2.uml.Namespace element, org.eclipse.gmf.runtime.notation.Diagram diagram) Sets the main diagram of an element

Method Detail

createDiagram

org.eclipse.gmf.runtime.notation.Diagram createDiagram(org.eclipse.uml2.uml.Namespace container,
                                                       UMLDiagramKind kind)

Creates a UML diagram with a given kind and inserts it into a given container

Parameters:

container - The container namespace for the diagram

kind - The UML diagram kind

Returns:

a newly created Diagram

createDiagram

org.eclipse.gmf.runtime.notation.Diagram createDiagram(org.eclipse.uml2.uml.Namespace container,
                                                       UMLDiagramKind kind,
                                                       org.eclipse.uml2.uml.Element context)

Creates a UML diagram with a given context and kind and inserts it into a given container

Parameters:

container - The container namespace for the diagram

context - The UML diagram element context

kind - The UML diagram kind

Returns:

A newly created Diagram

createNode

org.eclipse.gmf.runtime.notation.Node createNode(org.eclipse.gmf.runtime.notation.View container,
                                                 org.eclipse.uml2.uml.Element element)

Creates a node for a given element and inserts it into a given container

Parameters:

container - The node view container

element - The node view element context

Returns:

A newly created Node

createNode

org.eclipse.gmf.runtime.notation.Node createNode(org.eclipse.gmf.runtime.notation.View container,
                                                 java.lang.String type)

Creates a node with a given type and inserts it into a given container basic types are

• "Note"
• "Text"
• "DiagramName"
• "DiagramLink"

Parameters:

container - The node view container

type - The node view type

Returns:

A newly created Node

createEdge

org.eclipse.gmf.runtime.notation.Edge createEdge(org.eclipse.gmf.runtime.notation.View source,
                                                 org.eclipse.gmf.runtime.notation.View target,
                                                 org.eclipse.uml2.uml.Element element)

Creates an edge for a given element and connects it between a given source and a given target

Parameters:

source - The edge's source view

target - The edge's target view

element - The edge view element context

Returns:

A newly created Edge

createEdge

org.eclipse.gmf.runtime.notation.Edge createEdge(org.eclipse.gmf.runtime.notation.View source,
                                                 org.eclipse.gmf.runtime.notation.View target,
                                                 java.lang.String type)

Creates an edge with a given type and connects it between a given source and a given target, basic edge types are

• "NoteAttachment"

Parameters:

source - The edge's source view

target - The edge's target view

type - The edge view type

Returns:

A newly created Edge

destroyView

void destroyView(org.eclipse.gmf.runtime.notation.View view)

Destroys a given view

Parameters:

view - The view to be destroyed

openDiagramEditor

void openDiagramEditor(org.eclipse.gmf.runtime.notation.Diagram diagram)

Opens an editor for a given diagram

Parameters:

diagram - The diagram to be opened

getDiagrams

java.util.List<org.eclipse.gmf.runtime.notation.Diagram> getDiagrams(org.eclipse.uml2.uml.Namespace element)

Gets a list of diagrams for a given element

Parameters:

element - The namespace element

Returns:

A list of Diagram s

getDiagrams

java.util.List<org.eclipse.gmf.runtime.notation.Diagram> getDiagrams(org.eclipse.uml2.uml.Namespace element,
                                                                     UMLDiagramKind kind)

Gets a list of diagrams of a given kind for a given element

Parameters:

element - The namespace element

kind - The diagram kind

Returns:

A list of Diagram s

getMainDiagram

org.eclipse.gmf.runtime.notation.Diagram getMainDiagram(org.eclipse.uml2.uml.Namespace element)

Gets the main diagram of an element

Parameters:

element - The namespace element

Returns:

The main Diagram

setMainDiagram

void setMainDiagram(org.eclipse.uml2.uml.Namespace element,
                    org.eclipse.gmf.runtime.notation.Diagram diagram)

Sets the main diagram of an element

Parameters:

element - The namespace element

diagram - The main diagram

getChildView

org.eclipse.gmf.runtime.notation.View getChildView(org.eclipse.gmf.runtime.notation.View container,
                                                   java.lang.String type)

Gets the child view with a given type from a given view

Parameters:

container - The container view

type - The type of the child view

Returns:

a child View

getUmlDiagramKind

UMLDiagramKind getUmlDiagramKind(org.eclipse.gmf.runtime.notation.Diagram diagram)

Retrieves the UMLDiagramKind of the specified diagram

Parameters:

diagram - The diagram to retrieve the UMLDiagramKind for

Returns:

The UMLDiagramKind

renderToImageFile

void renderToImageFile(org.eclipse.gmf.runtime.notation.Diagram diagram,
                       java.lang.String file,
                       org.eclipse.gmf.runtime.diagram.ui.image.ImageFileFormat format)

renderToImageFile Utility api to render the diagram to a specified image formatation of the diagram contents.

Parameters:

diagram - The Diagram to render the image from.

file - String that is the image file path to write to.

format - ImageFileFormat enumeration of valid file formats

Throws:

java.lang.NullPointerException - diagram is null

java.lang.NullPointerException - file is null

java.lang.NullPointerException - format is null

java.lang.IllegalArgumentException - file is an empty string

java.lang.UnsupportedOperationException - Unable to render diagram to format

renderToAWTImage

java.awt.Image renderToAWTImage(org.eclipse.gmf.runtime.notation.Diagram diagram)

renderToAWTImage Utility api to generate an AWT based image representation of the diagram contents.

Parameters:

diagram - The Diagram to render the image from.

Returns:

java.awt.Image that is the bitmap representation of the diagram contents.

Throws:

java.lang.NullPointerException - diagram is null

renderToSWTImage

org.eclipse.swt.graphics.Image renderToSWTImage(org.eclipse.gmf.runtime.notation.Diagram diagram)

renderToSWTImage Utility api to generate an SWT based image representation of the diagram contents.

Parameters:

diagram - The Diagram to render the image from.

Returns:

org.eclipse.swt.graphics.Image that is the bitmap representation of the diagram contents. Caller is responsible for calling dispose() on the return image.

Throws:

java.lang.NullPointerException - diagram is null

getLayoutNode

org.eclipse.gmf.runtime.diagram.ui.services.layout.ILayoutNode getLayoutNode(org.eclipse.gmf.runtime.notation.Node node)

getLayoutNode Gets the ILayoutNode in order to retrieve the actual size of the Node object irrespective of the autosize properties.

Parameters:

node - Node to get the layout node equivalent from

Returns:

ILayoutNode object

Throws:

java.lang.NullPointerException - node is null

layout

void layout(org.eclipse.gmf.runtime.notation.View view,
            java.lang.String hint)

layout Utility method to layout the children of a view container.

Parameters:

view - View object that is the container whose children will be laid out. Typically this would be the Diagram notation element.

hint - String representing a hint for what kind of layout will be applied. Value can be one of

Throws:

java.lang.NullPointerException - view is null

java.lang.NullPointerException - hint is null

See Also:

LayoutType.DEFAULT, Other values would have to understand by custom providers., ILayoutNodeProvider

layoutNodes

void layoutNodes(java.util.List<? extends org.eclipse.gmf.runtime.notation.Node> nodes,
                 java.lang.String hint)

layoutNodes Utility method to layout a list of Node children on a diagram.

Parameters:

nodes - List of Node objects

hint - String representing a hint for what kind of layout will be applied. Value can be one of

Throws:

java.lang.NullPointerException - nodes is null

java.lang.IllegalArgumentException - nodes is an empty list

java.lang.NullPointerException - hint is null

java.lang.IllegalArgumentException - Argument nodes contains objects which aren't of type Node

java.lang.IllegalArgumentException - Argument nodes contains objects which have a different parent containment

See Also:

LayoutType.DEFAULT, Other values would have to understand by custom providers., ILayoutNodeProvider

createViews

java.util.List<org.eclipse.gmf.runtime.notation.View> createViews(org.eclipse.gmf.runtime.notation.Diagram diagram,
                                                                  java.util.List<?> objects)

Creates views for the objects specified by objects in the diagram specified by diagram.

Parameters:

diagram - The diagram where to add views to

objects - The objects to add views for

Returns:

The notation elements added to the diagram

Throws:

java.lang.NullPointerException - diagram or object is null

java.lang.IllegalArgumentException - diagram has no associated edit part (internal error)

canCreateViews

boolean canCreateViews(org.eclipse.gmf.runtime.notation.Diagram diagram,
                       java.util.List<?> objects)

Returns whether views can be created for the objects specified by objects in the diagram specified by diagram

Parameters:

diagram - The diagram where to add a views to

objects - The objects to add views for

Returns:

true if at least one object can be viewed in the specified diagram

Throws:

java.lang.NullPointerException - diagram or objects is null

findDiagramById

@Deprecated
org.eclipse.gmf.runtime.notation.Diagram findDiagramById(org.eclipse.uml2.uml.Model model,
                                                                      java.lang.String id,
                                                                      org.eclipse.core.runtime.IProgressMonitor monitor)
                                                               throws java.lang.InterruptedException

Deprecated. Since 7.5, use the findDiagram(Element, String, IProgressMonitor) method, instead.

Finds diagram whose ID matches exactly the specified id. The search is performed in the model specified by model

Parameters:

model - The UML model where to perform the search

id - The ID of the diagram to match

Returns:

The diagram with the specified id, null if not found

Throws:

java.lang.InterruptedException - The query operation was interrupted

java.lang.IllegalArgumentException - is is an empty string

java.lang.ClassCastException - is if the element associated with the specified id is not a diagram

See Also:

com.ibm.xtools.emf.index.search.IIndexSearchManager

findDiagram

org.eclipse.gmf.runtime.notation.Diagram findDiagram(org.eclipse.uml2.uml.Element root,
                                                     java.lang.String id,
                                                     org.eclipse.core.runtime.IProgressMonitor monitor)
                                              throws java.lang.InterruptedException

Finds diagram whose ID matches exactly the specified id. The search is performed in the model specified by model

Parameters:

root - The root element of the UML model where to perform the search

id - The ID of the diagram to match

Returns:

The diagram with the specified id, null if not found

Throws:

java.lang.InterruptedException - The query operation was interrupted

java.lang.IllegalArgumentException - is is an empty string

java.lang.ClassCastException - is if the element associated with the specified id is not a diagram

Since:

7.5

See Also:

com.ibm.xtools.emf.index.search.IIndexSearchManager

findDiagramByName

java.util.Set<org.eclipse.gmf.runtime.notation.Diagram> findDiagramByName(org.eclipse.uml2.uml.Element container,
                                                                          java.lang.String name,
                                                                          org.eclipse.core.runtime.IProgressMonitor monitor)
                                                                   throws java.lang.InterruptedException

Finds the diagrams whose name and type match exactly the specified name and type respectively. The search begins at the element specified by container and recurses within its owned elements

Parameters:

container - The root Element where to perform the search

name - The name of the Diagram to match

monitor - The monitor to use to display progress and/or cancel operation

Returns:

The set of Diagrams matching the specified criteria

Throws:

java.lang.InterruptedException - The query operation was interrupted

java.lang.IllegalArgumentException - name is an empty string

java.lang.NullPointerException - One of the passed parameters was null

See Also:

com.ibm.xtools.emf.index.search.IIndexSearchManager

createEdges

java.util.List<org.eclipse.gmf.runtime.notation.Edge> createEdges(org.eclipse.gmf.runtime.notation.Diagram diagram,
                                                                  org.eclipse.uml2.uml.Relationship element)

Creates diagram edges between the related elements of a relationship

Parameters:

diagram - The diagram to created edges in

element - The relationship element

Returns:

The list of created Edge s