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:
-
TeamUI.getTeamContentProviderManager(),
ModelProvider
P_SYNCHRONIZATION_PAGE_CONFIGURATION
static final
String P_SYNCHRONIZATION_PAGE_CONFIGURATION
- Property constant used to store and retrieve the synchronization page
configuration from the
IExtensionStateModel used by the Common
Navigator framework.
-
See Also:
-
Constant Field Values
P_SYNCHRONIZATION_CONTEXT
static final
String P_SYNCHRONIZATION_CONTEXT
- Property constant used to store and retrieve the synchronization context
from the
IExtensionStateModel used by
the Common Navigator framework. It is also used to associate a context
with an
ISynchronizePageConfiguration when models are being
shown in an
ISynchronizePage.
-
See Also:
-
Constant Field Values
P_SYNCHRONIZATION_SCOPE
static final
String P_SYNCHRONIZATION_SCOPE
- Property constant used to store and retrieve the resource mapping scope
from the
IExtensionStateModel used by
the Common Navigator framework. It is also used to associate a scope
with an
ISynchronizePageConfiguration when models are being
shown in an
ISynchronizePage.
-
See Also:
-
Constant Field Values
PROP_PAGE_LAYOUT
static final
String PROP_PAGE_LAYOUT
- Property constant used to store and retrieve the page layout
from the
ISynchronizePageConfiguration when models are being
shown in an
ISynchronizePage. At this time, there are two layouts,
TREE_LAYOUT and FLAT_LAYOUT. Other may be added
-
Since:
- 3.3
-
See Also:
-
Constant Field Values
TREE_LAYOUT
static final
String 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:
-
Constant Field Values
FLAT_LAYOUT
static final
String 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 their
teamContentProviders
that they support the flat layout will be enabled when the PROP_PAGE_LAYOUT is set
to FLAT_LAYOUT.
-
Since:
- 3.3
-
See Also:
-
Constant Field Values
PROP_ENABLED_MODEL_PROVIDERS
static final
String 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:
-
Constant Field Values
getDescriptors
ITeamContentProviderDescriptor[] getDescriptors()
- Return descriptors for all the registered content extensions.
-
-
Returns:
- descriptors for all the registered content extensions
getDescriptor
ITeamContentProviderDescriptor getDescriptor(
String modelProviderId)
- Return the team content provider descriptor for the
given model provider id. A
null 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
void addPropertyChangeListener(
IPropertyChangeListener listener)
- Add a property change listener to the manager.
-
-
Parameters:
-
listener - the listener
removePropertyChangeListener
void removePropertyChangeListener(
IPropertyChangeListener listener)
- Remove a property change listener from the manager.
-
-
Parameters:
-
listener - the listener
getContentProviderIds
String[] getContentProviderIds(
ISynchronizationScope scope)
- 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
void setEnabledDescriptors(
ITeamContentProviderDescriptor[] descriptors)
- Enable the given content descriptors, disabling all others.
This method will fire a
PROP_ENABLED_MODEL_PROVIDERS
property change event to any registered listeners.
-
-
Parameters:
-
descriptors - the descriptors to be enabled. -
Since:
- 3.3
-
See Also:
-
ITeamContentProviderDescriptor.isEnabled()
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
