|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.team.ui.synchronize.AbstractSynchronizeLabelProvider
org.eclipse.team.ui.mapping.SynchronizationLabelProvider
public abstract class SynchronizationLabelProvider
A label provider wrapper that adds synchronization image and/or text decorations to the image and label obtained from the delegate provider.
| Constructor Summary | |
|---|---|
SynchronizationLabelProvider()
|
|
| Method Summary | |
|---|---|
ISynchronizationContext |
getContext()
Return the synchronization context associated with the view to which this label provider applies. |
java.lang.String |
getDescription(java.lang.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(java.lang.Object element)
Returns the image for the label of the given element. |
protected java.lang.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. |
java.lang.String |
getText(java.lang.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. |
| Methods inherited from class org.eclipse.team.ui.synchronize.AbstractSynchronizeLabelProvider |
|---|
addListener, decorateImage, decorateText, dispose, getCompareImage, getDelegateImage, getDelegateLabelProvider, getDelegateText, getDiff, getFont, getMarkerSeverity, hasDecendantConflicts, isBusy, isIncludeOverlays, isLabelProperty, isSyncInfoInTextEnabled, removeListener |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Methods inherited from interface org.eclipse.jface.viewers.IBaseLabelProvider |
|---|
addListener, dispose, isLabelProperty, removeListener |
| Methods inherited from interface org.eclipse.jface.viewers.IFontProvider |
|---|
getFont |
| Constructor Detail |
|---|
public SynchronizationLabelProvider()
| Method Detail |
|---|
public void init(ICommonContentExtensionSite site)
ICommonLabelProvider
init 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 java.lang.String getDescription(java.lang.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 choose 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 Navigator
protected boolean isDecorationEnabled()
AbstractSynchronizeLabelProvider
isDecorationEnabled in class AbstractSynchronizeLabelProviderpublic Image getImage(java.lang.Object element)
ILabelProvider
getImage in interface ILabelProvidergetImage in class AbstractSynchronizeLabelProviderelement - the element for which to provide the label image
null
if there is no image for the given objectprotected java.lang.Object getModelRoot()
public java.lang.String getText(java.lang.Object element)
ILabelProvider
getText in interface ILabelProvidergetText in class AbstractSynchronizeLabelProviderelement - the element for which to provide the label text
null
if there is no text label for the given objectpublic ICommonContentExtensionSite getExtensionSite()
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.