Java Doc for HighlightsContainer.java in  » IDE-Netbeans » editor » org » netbeans » spi » editor » highlighting » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Typically highlights only affect rendering of a small part of text (perhaps just several characters).

The returned highlighted areas (highlights) must obey the following rules:

• The starting and ending offsets of each highlight should be within the range specified by the startOffset and endOffset parameters.

If you use this key for a highlight which contains the new-line character at the end of an empty line and set the value of this attribute to Boolean.TRUE then the highlight will be drawn as a half-character-wide stripe at the beginning of the line.

Typically highlights only affect rendering of a small part of text (perhaps just several characters). Some layers, however, need to highlight a whole line in an editor window regardless of how much text the line contains. The highlighting of a line with a caret is an example of such a layer.

If you want a highlight that spans accross the whole editor pane you can add this attribute key to the highlight's AttributeSet and set its value to Boolean.TRUE. The highlighted area must contain the new-line character at the end of the line.

The returned highlighted areas (highlights) must obey the following rules:

• The starting and ending offsets of each highlight should be within the range specified by the startOffset and endOffset parameters. Any highlights outside of this range will be clipped by the rendering infrastructure.
• The highlights must not overlap. The infrastructure may ignore or trim any overlapping highlights.
• The list of highlights must be sorted by their starting offsets ascendingly (i.e. the smallest offset first).

The editor infrastructure will log any problems it may encounter with provided implementations of this interface. Although the infrastructure will try to do its best to render all highlights supplied by the implementors, if the above rules are violated the results can't be garanteed.
Parameters:
  startOffset - The starting offset of the area which the callerattempts to repaint (or create views for). The staring offset is always >=0.
Parameters:
  endOffset - The ending offset of the rendered area. The Integer.MAX_VALUEcan be passed in if the end offset is unknown to the caller.The highlights container is then expected to return all highlightsup to the end of the document. non-null iterator of highlights sorted by offsets.