org.netbeans.spi.editor.highlighting

Interface SplitOffsetHighlightsSequence

All Superinterfaces:

HighlightsSequence

public interface SplitOffsetHighlightsSequence
extends HighlightsSequence

Highlights sequence that supports split offsets in addition to regular offsets. This allows to color individual spaces within a tab character or to color extra virtual characters at line end (as a split of newline character).

Since:

2.13.0

Field Summary

Fields inherited from interface org.netbeans.spi.editor.highlighting.HighlightsSequence

EMPTY

Method Summary

Modifier and Type	Method and Description
int	getEndSplitOffset() Get zero-based offset "within" a character (usually tab or newline to which HighlightsSequence.getEndOffset() points to) that ends a highlight.
int	getStartSplitOffset() Get zero-based offset "within" a character (usually tab or newline to which HighlightsSequence.getStartOffset() points to) that starts a highlight.

Methods inherited from interface org.netbeans.spi.editor.highlighting.HighlightsSequence

getAttributes, getEndOffset, getStartOffset, moveNext

Method Detail

getStartSplitOffset

int getStartSplitOffset()

Get zero-based offset "within" a character (usually tab or newline to which HighlightsSequence.getStartOffset() points to) that starts a highlight.
Zero should be returned if the character is not intended to be split.
To highlight second and third space of a tab character at offset == 123 the HighlightsSequence.getStartOffset() == HighlightsSequence.getEndOffset() == 123 and SplitOffsetHighlightsSequence.getStartSplitOffset() == 1 and SplitOffsetHighlightsSequence.getEndSplitOffset() == 3.

Returns:

>=0 start split offset.

See Also:

HighlightsSequence.getStartOffset()

getEndSplitOffset

int getEndSplitOffset()

Get zero-based offset "within" a character (usually tab or newline to which HighlightsSequence.getEndOffset() points to) that ends a highlight.
Zero should be returned if the character is not intended to be split.
Get end of a highlight "within" a particular character (either tab or newline) while HighlightsSequence.getEndOffset() points to the tab or newline character.

Returns:

>=0 end split offset.

See Also:

SplitOffsetHighlightsSequence.getStartSplitOffset()