org.netbeans.api.editor

Class NavigationHistory

java.lang.Object

org.netbeans.api.editor.NavigationHistory

public final class NavigationHistory
extends Object

0 1 2 3 4 waypoints.size() | W1 | W2 | W3 | W4 | W5 | ^ | previous waypoints <- pointer -> next Waypoints current waypoint getPreviousWaypoints() == { W1, W2, W3 } getNextWaypoints() == { W4, W5 } navigateBack() == W3, moves pointer one position left navigateForward() == W4, moves pointer one position right

Since:

1.74

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NavigationHistory.Waypoint

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_WAYPOINTS

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener l)
NavigationHistory.Waypoint	getCurrentWaypoint()
static NavigationHistory	getEdits()
static NavigationHistory	getNavigations()
List<NavigationHistory.Waypoint>	getNextWaypoints()
List<NavigationHistory.Waypoint>	getPreviousWaypoints()
boolean	hasNextWaypoints() Is pointer showing other than last waypoint entry
boolean	hasPreviousWaypoints() Is pointer showing other than first waypoint entry
NavigationHistory.Waypoint	markWaypoint(JTextComponent comp, int offset, boolean currentPosition, boolean append) Create and add new waypoint to navigation history
NavigationHistory.Waypoint	navigateBack() Change selected waypoint by moving pointer to previous waypoint
NavigationHistory.Waypoint	navigateFirst() Change selected waypoint by moving pointer to first waypoint
NavigationHistory.Waypoint	navigateForward() Change selected waypoint by moving pointer to next waypoint
NavigationHistory.Waypoint	navigateLast() Change selected waypoint by moving pointer to last waypoint
NavigationHistory.Waypoint	navigateTo(NavigationHistory.Waypoint waypoint) Change selected waypoint by moving pointer to waypoint in parameter
void	removePropertyChangeListener(PropertyChangeListener l)

Methods inherited from class java.lang.Object

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

Field Detail

PROP_WAYPOINTS

public static final String PROP_WAYPOINTS

See Also:

Constant Field Values

Method Detail

getNavigations

public static NavigationHistory getNavigations()

Returns:

list of waypoints where user navigated.

getEdits

public static NavigationHistory getEdits()

Returns:

list of waypoints where user edited content.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

markWaypoint

public NavigationHistory.Waypoint markWaypoint(JTextComponent comp,
                                               int offset,
                                               boolean currentPosition,
                                               boolean append)
                                        throws BadLocationException

Create and add new waypoint to navigation history

Parameters:

offset - A valid ofset inside the component's document or -1 if the offset is unspecified.

Throws:

BadLocationException

getCurrentWaypoint

public NavigationHistory.Waypoint getCurrentWaypoint()

Returns:

waypoint under pointer

hasPreviousWaypoints

public boolean hasPreviousWaypoints()

Is pointer showing other than first waypoint entry

hasNextWaypoints

public boolean hasNextWaypoints()

Is pointer showing other than last waypoint entry

getPreviousWaypoints

public List<NavigationHistory.Waypoint> getPreviousWaypoints()

Returns:

all waypoints before waypoint under pointer

getNextWaypoints

public List<NavigationHistory.Waypoint> getNextWaypoints()

Returns:

all waypoints after waypoint under pointer

navigateBack

public NavigationHistory.Waypoint navigateBack()

Change selected waypoint by moving pointer to previous waypoint

navigateForward

public NavigationHistory.Waypoint navigateForward()

Change selected waypoint by moving pointer to next waypoint

navigateTo

public NavigationHistory.Waypoint navigateTo(NavigationHistory.Waypoint waypoint)

Change selected waypoint by moving pointer to waypoint in parameter

navigateFirst

public NavigationHistory.Waypoint navigateFirst()

Change selected waypoint by moving pointer to first waypoint

navigateLast

public NavigationHistory.Waypoint navigateLast()

Change selected waypoint by moving pointer to last waypoint