Eclipse Platform
Release 3.3

org.eclipse.compare
Class CompareNavigator

java.lang.Object
  extended byorg.eclipse.compare.CompareNavigator
All Implemented Interfaces:
ICompareNavigator

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
CompareNavigator()
           
 
Method Summary
protected abstract  INavigatable[] getNavigatables()
           
protected  INavigatable getNavigator(Object object)
          Return the INavigatable for the given object.
 boolean hasChange(boolean next)
          Return 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 Detail

CompareNavigator

public CompareNavigator()
Method Detail

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)
Return the INavigatable for the given object. If the object implements INavigatable, then the object is returned. Otherwise, if the object implements IAdaptable, the object is adapted to INavigatable.

Parameters:
object - the object
Returns:
the INavigatable for the given object or null

hasChange

public boolean hasChange(boolean next)
Return 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

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

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