| package org.eclipse.ui.navigator; |
| |
| import org.eclipse.core.runtime.IAdaptable; |
| import org.eclipse.jface.viewers.ILabelProvider; |
| import org.eclipse.jface.viewers.ITreeContentProvider; |
| |
| /** |
| * The content extension represents the components of a <b>navigatorContent</b> |
| * extension. These handles are managed by a content service |
| * {@link INavigatorContentService}. |
| * |
| * <p> |
| * There is one {@link INavigatorContentExtension} for each content service. |
| * There is only one {@link INavigatorContentDescriptor} for each extension. |
| * </p> |
| * |
| * |
| * <p> |
| * <strong>EXPERIMENTAL</strong>. This class or interface has been added as |
| * part of a work in progress. There is a guarantee neither that this API will |
| * work nor that it will remain the same. Please do not use this API without |
| * consulting with the Platform/UI team. |
| * </p> |
| * |
| * @since 3.2 |
| * |
| */ |
| public interface INavigatorContentExtension extends IAdaptable { |
| |
| /** |
| * |
| * @return The id attribute of the navigatorContent extension. |
| */ |
| String getId(); |
| |
| /** |
| * There is one descriptor for all instances of a |
| * INavigatorContentExtension. |
| * |
| * |
| * @return A handle to the descriptor used to manage this extension. |
| */ |
| INavigatorContentDescriptor getDescriptor(); |
| |
| /** |
| * Clients may choose to implement {@link ICommonContentProvider}, but are |
| * only required to supply an implementation of {@link ITreeContentProvider}. |
| * |
| * @return The content provider defined by the <b>navigatorContent</b> |
| * extension. |
| * @see ICommonContentProvider |
| * @see ITreeContentProvider |
| */ |
| ITreeContentProvider getContentProvider(); |
| |
| /** |
| * The real underlying implementation may only support the |
| * {@link ILabelProvider} interface, but a simple delegate is used when this |
| * is the case to ensure that clients may anticpate an |
| * {@link ICommonLabelProvider} interface. |
| * |
| * @return The content provider defined by the <b>navigatorContent</b> |
| * extension. |
| * @see ICommonLabelProvider |
| * @see ILabelProvider |
| */ |
| ICommonLabelProvider getLabelProvider(); |
| // Considering removing |
| // /** |
| // * @param theActionService |
| // * An action service is required to initialize the action |
| // * provider. Clients should only use one action service. Never |
| // * call this method with different action services. |
| // * |
| // * |
| // * @return The action provider defined by <b>navigatorContent</b> |
| // * extension, if any. A singleton no-op action provider may be |
| // * returned if the extension does not define an action provider. |
| // * @see ICommonActionProvider |
| // * @see ICommonActionConstants |
| // */ |
| // ICommonActionProvider getActionProvider( |
| // INavigatorActionService theActionService); |
| |
| /** |
| * |
| * @return True if any class has been instantiated by this extension. |
| */ |
| boolean isLoaded(); |
| |
| /** |
| * |
| * @return The state model associated with this content extension. |
| * @see IExtensionStateModel |
| */ |
| IExtensionStateModel getStateModel(); |
| |
| } |