Eclipse Platform
Release 3.3

org.eclipse.team.ui.mapping
Interface ITeamContentProviderDescriptor


public interface ITeamContentProviderDescriptor

A description of a single extension registered with the org.eclipse.team.ui.teamContentProviders extension point. *

This interface is not intended to be implemented by clients.

Since:
3.2

Method Summary
 IPreferencePage createPreferencePage()
          Return a preference page that can be displayed to configure the content provider of this extension.
 String getContentExtensionId()
          Return the id of the content extension registered with the org.eclipse.ui.navigator.navigatorContent extension point that applies to the descriptors model provider.
 ImageDescriptor getImageDescriptor()
          Return an image descriptor that can be displayed with this content extension.
 String getModelProviderId()
          Return the id of the model provider to which this content provider applies.
 String getName()
          Returns the name specified for this content provider as specified in the extension point.
 boolean isEnabled()
          Return whether this content provider is enabled.
 boolean isFlatLayoutSupported()
          Return whether the FLAT layout is supported by this content provider.
 

Method Detail

getContentExtensionId

public String getContentExtensionId()
Return the id of the content extension registered with the org.eclipse.ui.navigator.navigatorContent extension point that applies to the descriptors model provider.

Returns:
id of the content extension registered with the org.eclipse.ui.navigator.navigatorContent extension point

getModelProviderId

public String getModelProviderId()
Return the id of the model provider to which this content provider applies.

Returns:
the id of the model provider to which this content provider applies

getImageDescriptor

public ImageDescriptor getImageDescriptor()
Return an image descriptor that can be displayed with this content extension.

Returns:
an image descriptor that can be displayed with this content extension

createPreferencePage

public IPreferencePage createPreferencePage()
                                     throws CoreException
Return a preference page that can be displayed to configure the content provider of this extension.

Returns:
a preference page that can be displayed to configure the content provider of this extension
Throws:
CoreException

isEnabled

public boolean isEnabled()
Return whether this content provider is enabled. If it is not enabled, it should not be included in any viewers.

Returns:
whether this content provider is enabled

getName

public String getName()
Returns the name specified for this content provider as specified in the extension point.

Returns:
a string containing the name or null if no name has been specified

isFlatLayoutSupported

public boolean isFlatLayoutSupported()
Return whether the FLAT layout is supported by this content provider.

Returns:
whether the FLAT layout is supported by this content provider
Since:
3.3
See Also:
ITeamContentProviderManager.PROP_PAGE_LAYOUT

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.