com.ibm.xtools.mmi.ui.services

Interface IMMIUIHandler

public interface IMMIUIHandler

The following interface may be implemented by any Reflection adapter that supports standard UI for mapped models.

Method Summary

Modifier and Type	Method and Description
org.eclipse.core.runtime.IPath	getDefaultDiagramPath(java.lang.Object uiObject, IUIContext uiContext) Gets the directory path where the Diagram can be created for the uiObject.
java.util.List	getSourceElements(java.lang.Object referencedContext, java.lang.Object uiObject, IUIContext uiContext) Extracts all domain objects from a given UI Object.
org.eclipse.emf.ecore.EClass	getTargetEClass(java.lang.Object referencedContext, java.lang.Object source, IUIContext uiContext) Returns the target EClass for a source element when dropped on a certain UI context, such as the diagram kind.

Method Detail

getDefaultDiagramPath

org.eclipse.core.runtime.IPath getDefaultDiagramPath(java.lang.Object uiObject,
                                                     IUIContext uiContext)

Gets the directory path where the Diagram can be created for the uiObject. This API is used by AddToNew*Diagram action on a UI Object.

Parameters:

uiObject - selected Object for which diagram is to be created.

uiContext - context for the ui. Handlers can determine what type of diagram path will be returned based on the uiContext.

Returns:

IPath default diagram path

getSourceElements

java.util.List getSourceElements(java.lang.Object referencedContext,
                                 java.lang.Object uiObject,
                                 IUIContext uiContext)

Extracts all domain objects from a given UI Object. UI object is any object available through UI but not directly supported by MMIUIService. eg. ICompilationUnit can have many IType, so when a ICompilationUnit is involved in a MMI UI Operation, all ITypes should participate in that operation.

Parameters:

referencedContext - context such as a editing domain

uiObject - selected Object that is involved in MMI UI usecase.

uiContext - IUIContext.

Returns:

List of domain elements from the UI object

getTargetEClass

org.eclipse.emf.ecore.EClass getTargetEClass(java.lang.Object referencedContext,
                                             java.lang.Object source,
                                             IUIContext uiContext)

Returns the target EClass for a source element when dropped on a certain UI context, such as the diagram kind.

Parameters:

source - domain Object like IType

uiContext - IUIContext recommended to include a diagram kind for easily determining what the target eclass for the domain object would be.