Navigator (Strange Eons API)

All Known Implementing Classes:

HtmlCodeSupport.HtmlNavigator, JavaScriptNavigator, MarkdownSupport.MarkdownNavigator, PropertyFileCodeSupport.PropertyNavigator, RegexNavigatorBase, TileSetCodeSupport.TileSetNavigator
```
public interface Navigator
```
Navigators build a list of NavigationPoints that allow quick navigation between semantically significant sections of edited source code. The generated list can be displayed to the user in a special pane, allowing the user to quickly jump between these significant locations.

Since:

3.0

Author:

Chris Jennings

See Also:

CodeEditor#setNavigator, NavigationPoint

Field Summary

Fields
Modifier and Type	Field	Description
`static java.util.List<NavigationPoint>`	`ASYNC_RETRY`	A navigator can return this constant to indicate that the generation of navigation points is in progress.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`java.util.List<NavigationPoint>`	`getNavigationPoints(java.lang.String sourceText)`	Parses the specified source text and returns a list of navigation points.

- Field Detail
  - ASYNC_RETRY
```
static final java.util.List<NavigationPoint> ASYNC_RETRY
```
    A navigator can return this constant to indicate that the generation of navigation points is in progress. The caller should request the list again later using the same source text.
- Method Detail
  - getNavigationPoints
```
java.util.List<NavigationPoint> getNavigationPoints(java.lang.String sourceText)
```
    Parses the specified source text and returns a list of navigation points.
    
    Parameters:
    
    sourceText - the source text to determine navigation points for
    
    Returns:
    
    a (possibly empty) list of the extracted points