Package org.eclipse.ltk.ui.refactoring.model

Class AbstractSynchronizationLabelProvider

java.lang.Object
org.eclipse.team.ui.synchronize.AbstractSynchronizeLabelProvider
org.eclipse.team.ui.mapping.SynchronizationLabelProvider
org.eclipse.ltk.ui.refactoring.model.AbstractSynchronizationLabelProvider
All Implemented Interfaces:
IBaseLabelProvider, IFontProvider, ILabelProvider, ICommonLabelProvider, IDescriptionProvider, IMementoAware
public abstract class AbstractSynchronizationLabelProvider extends SynchronizationLabelProvider
Partial implementation of a refactoring-aware synchronization label provider.

This class overrides several methods from SynchronizationLabelProvider to customize the rendering of refactoring history objects in team synchronization views.

Note: this class is designed to be extended by clients. Programming language implementers who need refactoring support in a synchronization label provider used in team synchronization views may use this class as a basis for refactoring-aware synchronization label providers.

Since:
3.2
See Also:

  • Constructor Details

    • AbstractSynchronizationLabelProvider

      public AbstractSynchronizationLabelProvider()

  • Method Details

    • decorateText

      protected String decorateText(String base, Object element)
      Description copied from class: AbstractSynchronizeLabelProvider
      Decorate the text with the appropriate diff decorations. By default, this method uses the diff associated with the given element to determine how to decorate the text.
      Overrides:
      decorateText in class AbstractSynchronizeLabelProvider
      Parameters:
      base - the base text to be decorated.
      element - the element
      Returns:
      the text decorated appropriately using the diff associated with the element
      See Also:

    • getDiff

      protected IDiff getDiff(Object element)
      Description copied from class: AbstractSynchronizeLabelProvider
      Return the sync kind of the given element. This is used to determine how to decorate the image and label of the element. The sync kind is described in the SyncInfo class. A null is returned by default.
      Overrides:
      getDiff in class AbstractSynchronizeLabelProvider
      Parameters:
      element - the element being tested
      Returns:
      the sync kind of the given element

    • getDirection

      protected int getDirection(Object element)
      Returns the direction of the difference of the specified refactoring history object.

      The result of this method is used to compose an icon which reflects the direction of the difference between the two or three versions of the refactoring history object.

      Parameters:
      element - the refactoring history object
      Returns:
      the direction of the difference
      See Also:

    • getKind

      protected int getKind(Object element)
      Returns the kind of difference between the three sides ancestor, left and right of the specified refactoring history object.

      The result of this method is used to compose an icon which reflects the kind of difference between the two or three versions of the refactoring history object.

      Parameters:
      element - the refactoring history object
      Returns:
      the kind of difference
      See Also: