oracle.javatools.compare.view
Interface NavigableView

All Known Implementing Classes:

BaseCompareView, ListCompareView, SequenceCompareView, WedgeCompareView

public interface NavigableView

A CompareView that provides support for navigating between differences implements this interface.

Since:

10.0.3

Method Summary

void	addPositionListener(javax.swing.event.ChangeListener l) Adds a listener for changes to the current navigable view position.
boolean	goToFirstDifference() Navigate to the first difference in this view.
boolean	goToInitialDifference() Navigate to the initial difference in this view, without requesting focus
boolean	goToLastDifference() Navigate to the last difference in this view.
boolean	goToNextDifference() Navigate to the next difference in this view.
boolean	goToPreviousDifference() Navigate to the previous difference in this view.
boolean	hasNavigableDifferences() Asks whether the view has navigable differences.
boolean	hasNextDifference() Asks whether there is a next difference based on the position.
boolean	hasPreviousDifference() Asks whether there is a previous difference based on the position.
void	removePositionListener(javax.swing.event.ChangeListener l) Removes a listener for changes to the current navigable view position.

Method Detail

goToInitialDifference

boolean goToInitialDifference()

Navigate to the initial difference in this view, without requesting focus

Returns:

true if there was at least one difference in this view and navigation was successful.

addPositionListener

void addPositionListener(javax.swing.event.ChangeListener l)

Adds a listener for changes to the current navigable view position.

Parameters:

l - the listener to add.

removePositionListener

void removePositionListener(javax.swing.event.ChangeListener l)

Removes a listener for changes to the current navigable view position.

Parameters:

l - the listener to remove.

hasNavigableDifferences

boolean hasNavigableDifferences()

Asks whether the view has navigable differences.

Returns:

true if the view has differences which can be navigated.

hasPreviousDifference

boolean hasPreviousDifference()

Asks whether there is a previous difference based on the position.

Returns:

true if a previous difference can be reached from the current position in the navigable view.

hasNextDifference

boolean hasNextDifference()

Asks whether there is a next difference based on the position.

Returns:

true if a successive difference can be reached from the current position in the navigable view.

goToFirstDifference

boolean goToFirstDifference()

Navigate to the first difference in this view.

Returns:

true if there was at least one difference in this view and navigation was successful.

goToLastDifference

boolean goToLastDifference()

Navigate to the last difference in this view.

Returns:

true if there was at least one difference in this view and navigation was successful.

goToPreviousDifference

boolean goToPreviousDifference()

Navigate to the previous difference in this view.

Returns:

true if there was at least one difference between the current difference and the start of the view. If false is returned and you want to wrap navigation, you can call goToLastDifference().

goToNextDifference

boolean goToNextDifference()

Navigate to the next difference in this view.

Returns:

true if there was at least one difference between the current difference and the end of the view. If false is returned and you want to wrap navigation, you can call goToFirstDifference().