Package org.eclipse.compare

Class CompareNavigator

java.lang.Object

org.eclipse.compare.CompareNavigator

All Implemented Interfaces:

ICompareNavigator

Direct Known Subclasses:

CompareEditorInputNavigator

public abstract class CompareNavigator
extends Object
implements ICompareNavigator

Supports cross-pane navigation through the differences of a compare container.

Clients may subclass this class.

Since:

3.3

See Also:

• INavigatable

Constructor Summary

Constructors

Constructor	Description
CompareNavigator()

Method Summary

Modifier and Type	Method	Description
protected abstract INavigatable[]	getNavigatables()
protected final INavigatable	getNavigator(Object object)	Returns the INavigatable for the given object if the object adapts to INavigatable.
boolean	hasChange(boolean next)	Returns whether a call to ICompareNavigator.selectChange(boolean) with the same parameter would succeed.
boolean	selectChange(boolean next)	Starting from the current selection selectChange selects and reveals the next (previous) change.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CompareNavigator

public CompareNavigator()

Method Details

selectChange

public boolean selectChange(boolean next)

Description copied from interface: ICompareNavigator

Starting from the current selection selectChange selects and reveals the next (previous) change. If the end (or beginning) is reached, the method returns true.

Specified by:

selectChange in interface ICompareNavigator

Parameters:

next - if true the next change is selected, otherwise the previous change

Returns:

returns true if end (beginning) is reached, false otherwise

getNavigatables

protected abstract INavigatable[] getNavigatables()

getNavigator

protected final INavigatable getNavigator(Object object)

Returns the INavigatable for the given object if the object adapts to INavigatable.

Parameters:

object - the object

Returns:

the INavigatable for the given object or null

hasChange

public boolean hasChange(boolean next)

Returns whether a call to ICompareNavigator.selectChange(boolean) with the same parameter would succeed.

Parameters:

next - if true the next change is selected, otherwise the previous change

Returns:

whether a call to ICompareNavigator.selectChange(boolean) with the same parameter would succeed.

Since:

3.3