Package org.eclipse.team.ui.mapping
Interface ITeamContentProviderManager
public interface ITeamContentProviderManager
The team content provider manager provides access to the content
extenstions registered with the
org.eclipse.team.ui.teamContentProviders
extension point. A team content provider defines a mapping between
a ModelProvider
and a content extension registered with
the org.eclipse.ui.navigator.navigatorContent
extension point.
This interface is not intended to be implemented by clients.
- Since:
- 3.2
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for the PROP_PAGE_LAYOUT that indicates that the models should display their elements as a flat list.static final String
Property constant used to store and retrieve the synchronization context from theIExtensionStateModel
used by the Common Navigator framework.static final String
Property constant used to store and retrieve the synchronization page configuration from theIExtensionStateModel
used by the Common Navigator framework.static final String
Property constant used to store and retrieve the resource mapping scope from theIExtensionStateModel
used by the Common Navigator framework.static final String
Property constant used during property change notification to indicate that one one or more model providers have either been enabled or disabled.static final String
Property constant used to store and retrieve the page layout from theISynchronizePageConfiguration
when models are being shown in anISynchronizePage
.static final String
Value for the PROP_PAGE_LAYOUT that indicates that the models should display their elements in tree form. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Add a property change listener to the manager.String[]
Convenience method that returns the list of all enabled content extension ids for models that have mappings in the given scope.getDescriptor
(String modelProviderId) Return the team content provider descriptor for the given model provider id.Return descriptors for all the registered content extensions.void
Remove a property change listener from the manager.void
setEnabledDescriptors
(ITeamContentProviderDescriptor[] descriptors) Enable the given content descriptors, disabling all others.
-
Field Details
-
P_SYNCHRONIZATION_PAGE_CONFIGURATION
Property constant used to store and retrieve the synchronization page configuration from theIExtensionStateModel
used by the Common Navigator framework.- See Also:
-
P_SYNCHRONIZATION_CONTEXT
Property constant used to store and retrieve the synchronization context from theIExtensionStateModel
used by the Common Navigator framework. It is also used to associate a context with anISynchronizePageConfiguration
when models are being shown in anISynchronizePage
.- See Also:
-
P_SYNCHRONIZATION_SCOPE
Property constant used to store and retrieve the resource mapping scope from theIExtensionStateModel
used by the Common Navigator framework. It is also used to associate a scope with anISynchronizePageConfiguration
when models are being shown in anISynchronizePage
.- See Also:
-
PROP_PAGE_LAYOUT
Property constant used to store and retrieve the page layout from theISynchronizePageConfiguration
when models are being shown in anISynchronizePage
. At this time, there are two layouts, TREE_LAYOUT and FLAT_LAYOUT. Other may be added- Since:
- 3.3
- See Also:
-
TREE_LAYOUT
Value for the PROP_PAGE_LAYOUT that indicates that the models should display their elements in tree form.- Since:
- 3.3
- See Also:
-
FLAT_LAYOUT
Value for the PROP_PAGE_LAYOUT that indicates that the models should display their elements as a flat list. Only models that indicate in theirteamContentProviders
that they support the flat layout will be enabled when the PROP_PAGE_LAYOUT is set to FLAT_LAYOUT.- Since:
- 3.3
- See Also:
-
PROP_ENABLED_MODEL_PROVIDERS
Property constant used during property change notification to indicate that one one or more model providers have either been enabled or disabled.- See Also:
-
-
Method Details
-
getDescriptors
ITeamContentProviderDescriptor[] getDescriptors()Return descriptors for all the registered content extensions.- Returns:
- descriptors for all the registered content extensions
-
getDescriptor
Return the team content provider descriptor for the given model provider id. Anull
is returned if no extension is registered.- Parameters:
modelProviderId
- the model provider id- Returns:
- the team content provider descriptor for the
given model provider id or
null
-
addPropertyChangeListener
Add a property change listener to the manager.- Parameters:
listener
- the listener
-
removePropertyChangeListener
Remove a property change listener from the manager.- Parameters:
listener
- the listener
-
getContentProviderIds
Convenience method that returns the list of all enabled content extension ids for models that have mappings in the given scope.- Parameters:
scope
- the scope- Returns:
- the list of all content extension ids for models that have mappings in the given scope
-
setEnabledDescriptors
Enable the given content descriptors, disabling all others. This method will fire aPROP_ENABLED_MODEL_PROVIDERS
property change event to any registered listeners.- Parameters:
descriptors
- the descriptors to be enabled.- Since:
- 3.3
- See Also:
-