com.ibm.xtools.uml.ui

Interface IUMLUIHelper

public interface IUMLUIHelper

Utilities to retrieve UML and notation elements from selection

Method Summary

Modifier and Type	Method and Description
java.util.List<org.eclipse.emf.ecore.EObject>	getSelectedElements() Gets the UML and/or Notation elements that can be inferred from the selection in the active workbench window, editor or view
java.util.List<org.eclipse.emf.ecore.EObject>	getSelectedElements(org.eclipse.gmf.runtime.notation.Diagram diagram) Returns the list of views selected in the specified diagram.
java.util.List<org.eclipse.emf.ecore.EObject>	getSelectedElements(java.lang.String viewId) Gets the UML and/or Notation elements that can be inferred from the selection in the view with having the ID specified by viewId
void	setSelectedElements(org.eclipse.gmf.runtime.notation.Diagram diagram, java.util.List<? extends org.eclipse.emf.ecore.EObject> elements) Selects a list of edit parts corresponding to a list of elements in a given diagram in the currently active workbench window
void	setSelectedElements(java.util.List<? extends org.eclipse.gmf.runtime.notation.View> views) Selects a list of edit parts corresponding to a list of views in the currently active workbench window
void	setSelectedElements(java.lang.String viewId, java.util.List<? extends org.eclipse.emf.ecore.EObject> elements) Selects the specified UML and/or notation elements in a given view

Method Detail

getSelectedElements

java.util.List<org.eclipse.emf.ecore.EObject> getSelectedElements()

Gets the UML and/or Notation elements that can be inferred from the selection in the active workbench window, editor or view

Returns:

The selected UML and/or Notation elements

getSelectedElements

java.util.List<org.eclipse.emf.ecore.EObject> getSelectedElements(java.lang.String viewId)

Gets the UML and/or Notation elements that can be inferred from the selection in the view with having the ID specified by viewId

Parameters:

viewId - The ID of the view to retrieve selection from

Returns:

The selected UML and/or Notation elements

Throws:

java.lang.IllegalArgumentException - viewId is an empty string

java.lang.NullPointerException - viewId is null

getSelectedElements

java.util.List<org.eclipse.emf.ecore.EObject> getSelectedElements(org.eclipse.gmf.runtime.notation.Diagram diagram)

Returns the list of views selected in the specified diagram.

Parameters:

diagram - The diagram to get the selection for

Returns:

The list of selected UML and/or Notation elements

setSelectedElements

void setSelectedElements(java.lang.String viewId,
                         java.util.List<? extends org.eclipse.emf.ecore.EObject> elements)

Selects the specified UML and/or notation elements in a given view

Parameters:

viewId - The ID of the view to set selection to

elements - The UML and/or Notation elements to select in the specified view

Throws:

java.lang.IllegalArgumentException - viewId is an empty string

java.lang.NullPointerException - viewId is null elements is null

setSelectedElements

void setSelectedElements(java.util.List<? extends org.eclipse.gmf.runtime.notation.View> views)

Selects a list of edit parts corresponding to a list of views in the currently active workbench window

Parameters:

views - A list of views to select

setSelectedElements

void setSelectedElements(org.eclipse.gmf.runtime.notation.Diagram diagram,
                         java.util.List<? extends org.eclipse.emf.ecore.EObject> elements)

Selects a list of edit parts corresponding to a list of elements in a given diagram in the currently active workbench window

Parameters:

diagram - The diagram to set the selection to

elements - The UML and/or Notation elements to select in the specified diagram