com.ibm.xtools.mmi.ui.services

Interface IMMIUIProvider

All Superinterfaces:

org.eclipse.gmf.runtime.common.core.service.IProvider

All Known Subinterfaces:

IMMIUIService

public interface IMMIUIProvider
extends org.eclipse.gmf.runtime.common.core.service.IProvider

Interface to be implemented by all platform specific adapters, that provide standard MMI UI usecases in Aurora platform.

Standard MMI UI usecases are Drag and Drop any adaptable object on to a MMI diagram using MMIDragDropTargetListener, provide standard MMI UI menu actions like AddToNewClassDiagramAction, AddToNewDeploymentDiagramAction, ShowRelatedElements, Show/Hide Relationships.

The implementor of this interface must register the implementation with com.ibm.xtools.mmi.ui.MMIUIProviders extension point.

Method Summary

Modifier and Type	Method and Description
IStructuredReferenceOpenHandler	getStructuredReferenceOpenHandler(java.lang.String providerId) Retrieve a IStructuredReferenceOpenHandler given a handler id of the StructuredReference.
IMMIUIHandler	getUIHandler(java.lang.Object uiObject, IUIContext uiContext) Retrieve a IMMIUIHandler given a UI object and a diagram kind.

Methods inherited from interface org.eclipse.gmf.runtime.common.core.service.IProvider

addProviderChangeListener, provides, removeProviderChangeListener

Method Detail

getUIHandler

IMMIUIHandler getUIHandler(java.lang.Object uiObject,
                           IUIContext uiContext)

Retrieve a IMMIUIHandler given a UI object and a diagram kind.

Parameters:

uiObject - UI Object for which handler is requested.

uiContext - target context for which handler is requested. Constants are defined in IUIContextConstants.

Returns:

IMMIUIHandler if a registered provider supports IMMIUIHandler for uiObject and diagramKind else null.

getStructuredReferenceOpenHandler

IStructuredReferenceOpenHandler getStructuredReferenceOpenHandler(java.lang.String providerId)

Retrieve a IStructuredReferenceOpenHandler given a handler id of the StructuredReference.

Parameters:

providerId - Provider id of the StructuredReference

Returns:

IStructuredReferenceOpenHandler if a registered provider supports IStructuredReferenceOpenHandler for providerId else null.