org.eclipse.fx.code.editor.services

Interface NavigationProvider

public interface NavigationProvider

The navigation provider is responsible to provide informations about sensitive regions in the current document

Since:

2.4.0

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<java.util.Optional<NavigationRegion>>	getNavigationRegion(int caretOffet) Search for the navigation at the provided caret offset or return an empty optional of the current position is not a navigation sensitive region
java.util.concurrent.CompletableFuture<java.util.List<NavigationRegion>>	getNavigationRegions()

Method Detail

getNavigationRegions

java.util.concurrent.CompletableFuture<java.util.List<NavigationRegion>> getNavigationRegions()

Returns:

all navigation regions known

getNavigationRegion

java.util.concurrent.CompletableFuture<java.util.Optional<NavigationRegion>> getNavigationRegion(int caretOffet)

Search for the navigation at the provided caret offset or return an empty optional of the current position is not a navigation sensitive region

Parameters:

caretOffet - the caret offset

Returns:

optional containing the sensitive region