info.textgrid.lab.ui.core

Interface IOpenHandler

All Known Implementing Classes:

AbstractOpenHandler, DefaultOpenHandler

public interface IOpenHandler

Interface for custom open handlers in TextGridLab.

If you need special behaviour aside from opening an editor and switching perspectives, implement this interface and specify your implementation in the handler field of your contribution to the extension point info.textgrid.lab.ui.core.openObject.

Your class is instantiated with its default constructor and then initialized with the corresponding contribution by a call to setContribution(OpenHandlerContribution). You may inherit your implementation from AbstractOpenHandler. If you do not specify an implementation, DefaultOpenHandler is used.

Method Summary

Modifier and Type	Method and Description
void	open(TextGridObject textGridObject)
void	setContribution(OpenHandlerContribution contribution) Inform the open handler about the contribution it is used for.

Method Detail

setContribution

void setContribution(OpenHandlerContribution contribution)

Inform the open handler about the contribution it is used for. Implementations might want to save the contribution (the AbstractOpenHandler does so) and extract fields like the target perspective from it.

The framework guarantees that this method is called with a valid contribution before any calls to the open(TextGridObject) method.

Parameters:

contribution - The contribution for which this handler has been instantiated.

open

void open(TextGridObject textGridObject)
   throws CoreException

Throws:

CoreException