Package 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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      IPreferencePage createPreferencePage()
      Return a preference page that can be displayed to configure the content provider of this extension.
      java.lang.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.
      java.lang.String getModelProviderId()
      Return the id of the model provider to which this content provider applies.
      java.lang.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

        java.lang.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

        java.lang.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

        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

        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 - if an error occurs

      • isEnabled

        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

        java.lang.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

        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