org.eclipse.jface.text.revisions
Class RevisionInformation
java.lang.Object
org.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
Methods inherited from class java.lang.
Object
|
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait
|
RevisionInformation
public RevisionInformation()
- Creates a new revision information model.
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
-
Restriction:
- This method is not intended to be referenced by clients.
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.
Note: The created information control must be able to display the object
returned by the concrete implementation of
Revision.getHoverInfo()
.
-
-
-
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
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.