org.netbeans.spi.editor.bracesmatching

Interface BracesMatcher.ContextLocator

Enclosing interface:

BracesMatcher

public static interface BracesMatcher.ContextLocator

Mixin interface, which provides context ranges for brace matches. The interface is expected to be implemented on the BracesMatcher instances produced by BracesMatcherFactory. If implemented, the infrastructure may call the method to obtain additional context for display along with brace highlight. See the BraceContext for more information.

Method Summary

Modifier and Type	Method and Description
BraceContext	findContext(int originOrMatchPosition) Obtains context for the given text position.

Method Detail

findContext

BraceContext findContext(int originOrMatchPosition)

Obtains context for the given text position. At this moment, only start offset of the origin will be passed in, but the implementation should be prepared to handle (or ignore) each of the starting offsets reported by BracesMatcher.findOrigin() or BracesMatcher.findMatches().

Note: the document is not read locked by the caller. If the passed position does not exist in the document, or seems obsolete, the SPI should return null.

Parameters:

originOrMatchPosition - position of 'origin' or 'match' brace

Returns:

context information or null if the context cannot be provided.