org.eclipse.compare.ICompareNavigator Maven / Gradle / Ivy
Show all versions of org.eclipse.compare Show documentation
/*******************************************************************************
* Copyright (c) 2003, 2011 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.compare;
/**
* A ICompareNavigator is used to navigate through the individual
* differences of a CompareEditorInput or another type of Compare container.
*
* You can retrieve an object implementing the ICompareNavigator from a
* CompareEditorInput by calling getAdapter(ICompareNavigator)
* on the CompareEditorInput.
*
*
* Although it is legal for clients to implement this interface, it is better
* to subclass {@link CompareNavigator}.
*
* @since 3.0
*/
public 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.
*
* @param next if true the next change is selected, otherwise the previous change
* @return returns true if end (beginning) is reached, false otherwise
*/
public boolean selectChange(boolean next);
}