com.ibm.xtools.mmi.ui.services

Interface IStructuredReferenceOpenHandler

public interface IStructuredReferenceOpenHandler

An interface to support opening of structured references.

Specific MMI UI adapters should implement this interface to support opening Editors/Views on domain elements when user double clicks on domain elements represented on a diagram. OpenMMIElementEditPolicy requests the selected IStructuredReferenceOpenHandler to open the editor/view on the selected element.

Method Summary

Modifier and Type	Method and Description
boolean	canOpenStructuredReference(java.lang.Object referencedContext, StructuredReference sRef) Returns true if this handler can open a given vr.
void	openStructuredReference(java.lang.Object referencedContext, StructuredReference sRef, org.eclipse.core.runtime.IProgressMonitor monitor) Opens the StructuredReference in platform specific editor/view.

Method Detail

canOpenStructuredReference

boolean canOpenStructuredReference(java.lang.Object referencedContext,
                                   StructuredReference sRef)

Returns true if this handler can open a given vr.

Parameters:

sRef - StructuredReference to be tested.

Returns:

true if this handler can open the given StructuredReference, else false.

openStructuredReference

void openStructuredReference(java.lang.Object referencedContext,
                             StructuredReference sRef,
                             org.eclipse.core.runtime.IProgressMonitor monitor)

Opens the StructuredReference in platform specific editor/view.

Parameters:

sRef - StructuredReference to open.

monitor - IProgressMonitor that can be used to display the progress.