Eclipse Platform
Release 3.3

org.eclipse.jface.text.revisions
Class RevisionInformation

java.lang.Object
  extended byorg.eclipse.jface.text.revisions.RevisionInformation
All Implemented Interfaces:
IInformationProviderExtension2, ITextHoverExtension

public final class RevisionInformation
extends Object
implements ITextHoverExtension, IInformationProviderExtension2

Encapsulates revision information for one line-based document.

Clients may instantiate.

Since:
3.2
See Also:
Revision

Constructor Summary
RevisionInformation()
          Creates a new revision information model.
 
Method Summary
 void addRevision(Revision revision)
          Adds a revision.
 void applyDiff(org.eclipse.jface.internal.text.revisions.Hunk[] hunks)
          Adjusts the revision information to the given diff information.
 IInformationControlCreator getHoverControlCreator()
          Returns the hover control creator of this text hover or null
 IInformationControlCreator getInformationPresenterControlCreator()
          Returns the information control creator of this information provider.
 List getRanges()
          Returns the line ranges of this revision information.
 List getRevisions()
          Returns the contained revisions.
 void setHoverControlCreator(IInformationControlCreator creator)
          Sets the hover control creator.
 void setInformationPresenterControlCreator(IInformationControlCreator creator)
          Sets the information presenter control creator.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RevisionInformation

public RevisionInformation()
Creates a new revision information model.

Method Detail

addRevision

public void addRevision(Revision revision)
Adds a revision.

Parameters:
revision - a revision

getRevisions

public List getRevisions()
Returns the contained revisions.

Returns:
an unmodifiable view of the contained revisions (element type: Revision)

getRanges

public List getRanges()
Returns the line ranges of this revision information. The returned information is only valid at the moment it is returned, and may change as the annotated document is modified. See IRevisionListener for a way to be informed when the revision information changes. The returned list is sorted by document offset.

Returns:
an unmodifiable view of the line ranges (element type: RevisionRange)
Since:
3.3
See Also:
IRevisionListener

applyDiff

public void applyDiff(org.eclipse.jface.internal.text.revisions.Hunk[] hunks)
Adjusts the revision information to the given diff information. Any previous diff information is discarded. Note: This is an internal framework method and must not be called by clients.

Parameters:
hunks - the diff hunks to adjust the revision information to
Since:
3.3

getHoverControlCreator

public IInformationControlCreator getHoverControlCreator()
Description copied from interface: ITextHoverExtension
Returns the hover control creator of this text hover or null

Specified by:
getHoverControlCreator in interface ITextHoverExtension
Returns:
the hover control creator or null

getInformationPresenterControlCreator

public IInformationControlCreator getInformationPresenterControlCreator()
Returns the information control creator of this information provider.

Specified by:
getInformationPresenterControlCreator in interface IInformationProviderExtension2
Returns:
the information control creator or null
Since:
3.3

setHoverControlCreator

public void setHoverControlCreator(IInformationControlCreator creator)
Sets the hover control creator.

Parameters:
creator - the control creator
Since:
3.3

setInformationPresenterControlCreator

public void setInformationPresenterControlCreator(IInformationControlCreator creator)
Sets the information presenter control creator.

Parameters:
creator - the control creator
Since:
3.3

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

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