public abstract class SynchronizationLabelProvider extends AbstractSynchronizeLabelProvider implements ICommonLabelProvider, IFontProvider
| Constructor and Description |
|---|
SynchronizationLabelProvider() |
| Modifier and Type | Method and Description |
|---|---|
ISynchronizationContext |
getContext()
Return the synchronization context associated with the view to which
this label provider applies.
|
String |
getDescription(Object anElement)
Provide a description for the status bar view, if available.
|
ICommonContentExtensionSite |
getExtensionSite()
Return the Common Navigator extension site for this
label provider.
|
Image |
getImage(Object element)
Returns the image for the label of the given element.
|
protected Object |
getModelRoot()
Return the root object for the model.
|
ISynchronizationScope |
getScope()
Return the resource mapping scope associated with the view to which
this label provider applies.
|
String |
getText(Object element)
Returns the text for the label of the given element.
|
void |
init(ICommonContentExtensionSite site)
Initialize the label provider with the given configuration.
|
protected boolean |
isDecorationEnabled()
Return whether the label provider should decorate with the synchronization state.
|
void |
restoreState(IMemento aMemento)
Restore the previous state of any actions using the flags in aMemento.
|
void |
saveState(IMemento aMemento)
Save flags in aMemento to remember the state of any actions that persist
from session to session.
|
addListener, decorateImage, decorateText, dispose, getDelegateImage, getDelegateLabelProvider, getDelegateText, getDiff, getFont, getMarkerSeverity, hasDecendantConflicts, isBusy, isIncludeOverlays, isLabelProperty, isSyncInfoInTextEnabled, removeListenerclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddListener, dispose, isLabelProperty, removeListenergetFontpublic void init(ICommonContentExtensionSite site)
ICommonLabelProviderinit in interface ICommonLabelProvidersite - The extension site provides information that some extensions
will find useful to configure themselves properly in a
particular viewer.ICommonContentProviderpublic ISynchronizationContext getContext()
null is returned if
no context is available.nullpublic ISynchronizationScope getScope()
null is returned if
no scope is available.nullpublic void restoreState(IMemento aMemento)
IMementoAwareRestore the previous state of any actions using the flags in aMemento. This method allows the state of any actions that persist from session to session to be restored.
restoreState in interface IMementoAwareaMemento - A memento that was given to the view part to restore its
state.public void saveState(IMemento aMemento)
IMementoAwareSave flags in aMemento to remember the state of any actions that persist from session to session.
Extensions should qualify any keys stored in the memento with their plugin id
saveState in interface IMementoAwareaMemento - A memento that was given to the view part to save its state.public String getDescription(Object anElement)
IDescriptionProviderProvide a description for the status bar view, if available. A default string of the form "(x) items selected" will be used if this method choosed to return null.
The empty string ("") will be respected as a valid value if returned. Return null if the extension defers to the default method of supplying status bar descriptions.
getDescription in interface IDescriptionProvideranElement - The element selected in the Navigatorprotected boolean isDecorationEnabled()
AbstractSynchronizeLabelProviderisDecorationEnabled in class AbstractSynchronizeLabelProviderpublic Image getImage(Object element)
ILabelProvidergetImage in interface ILabelProvidergetImage in class AbstractSynchronizeLabelProviderelement - the element for which to provide the label imagenull
if there is no image for the given objectprotected Object getModelRoot()
public String getText(Object element)
ILabelProvidergetText in interface ILabelProvidergetText in class AbstractSynchronizeLabelProviderelement - the element for which to provide the label textnull
if there is no text label for the given objectpublic ICommonContentExtensionSite getExtensionSite()
Guidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.