Eclipse Platform
Release 3.3

org.eclipse.jface.text.revisions
Interface IRevisionRulerColumnExtension

All Known Implementing Classes:
LineNumberChangeRulerColumn

public interface IRevisionRulerColumnExtension

Extension interface for IRevisionRulerColumn.

Introduces the ability to register a selection listener on revisions and configurable rendering modes.

Since:
3.3
See Also:
IRevisionRulerColumn

Nested Class Summary
static class IRevisionRulerColumnExtension.RenderingMode
          Rendering mode type-safe enum.
 
Field Summary
static IRevisionRulerColumnExtension.RenderingMode AGE
          Rendering mode that assigns colors to revisions by their age.
static IRevisionRulerColumnExtension.RenderingMode AUTHOR
          Rendering mode that assigns a unique color to each revision author.
static IRevisionRulerColumnExtension.RenderingMode AUTHOR_SHADED_BY_AGE
          Rendering mode that assigns unique colors per revision author and uses different color intensity depending on the age.
 
Method Summary
 void addRevisionListener(IRevisionListener listener)
          Adds a revision listener that will be notified when the displayed revision information changes.
 ISelectionProvider getRevisionSelectionProvider()
          Returns the revision selection provider.
 void removeRevisionListener(IRevisionListener listener)
          Removes a previously registered revision listener; nothing happens if listener was not registered with the receiver.
 void setRevisionRenderingMode(IRevisionRulerColumnExtension.RenderingMode mode)
          Changes the rendering mode and triggers redrawing if needed.
 void showRevisionAuthor(boolean show)
          Enables showing the revision author.
 void showRevisionId(boolean show)
          Enables showing the revision id.
 

Field Detail

AUTHOR

public static final IRevisionRulerColumnExtension.RenderingMode AUTHOR
Rendering mode that assigns a unique color to each revision author.


AGE

public static final IRevisionRulerColumnExtension.RenderingMode AGE
Rendering mode that assigns colors to revisions by their age.

Currently the most recent revision is red, the oldest is a faint yellow. The coloring scheme can change in future releases.


AUTHOR_SHADED_BY_AGE

public static final IRevisionRulerColumnExtension.RenderingMode AUTHOR_SHADED_BY_AGE
Rendering mode that assigns unique colors per revision author and uses different color intensity depending on the age.

Currently it selects lighter colors for older revisions and more intense colors for more recent revisions. The coloring scheme can change in future releases.

Method Detail

setRevisionRenderingMode

public void setRevisionRenderingMode(IRevisionRulerColumnExtension.RenderingMode mode)
Changes the rendering mode and triggers redrawing if needed.

Parameters:
mode - the rendering mode

showRevisionId

public void showRevisionId(boolean show)
Enables showing the revision id.

Parameters:
show - true to show the revision, false to hide it

showRevisionAuthor

public void showRevisionAuthor(boolean show)
Enables showing the revision author.

Parameters:
show - true to show the author, false to hide it

getRevisionSelectionProvider

public ISelectionProvider getRevisionSelectionProvider()
Returns the revision selection provider.

Returns:
the revision selection provider

addRevisionListener

public void addRevisionListener(IRevisionListener listener)
Adds a revision listener that will be notified when the displayed revision information changes.

Parameters:
listener - the listener to add

removeRevisionListener

public void removeRevisionListener(IRevisionListener listener)
Removes a previously registered revision listener; nothing happens if listener was not registered with the receiver.

Parameters:
listener - the listener to remove

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.