edu.princeton.swing.text
Interface HighlightedDocumentRenderer

All Known Implementing Classes:

PHighlightedTextArea.InternalTextArea

public interface HighlightedDocumentRenderer

A HighlightedDocumentRenderer is an interface which describes a class which can recieve special read privileges to the protected data of a HighlightedDocument.

Method Summary

void	doRender(char[] chars, byte[] charStyles, int charCount, short[] lineOffsets, int lineCount, Object extraInfo) When the doRender method of HighlightedDocument is called, it obtains a read lock and passes its protected data to the specified instance of HighlightedDocumentRenderer.

Method Detail

doRender

public void doRender(char[] chars,
                     byte[] charStyles,
                     int charCount,
                     short[] lineOffsets,
                     int lineCount,
                     Object extraInfo)

When the doRender method of HighlightedDocument is called, it obtains a read lock and passes its protected data to the specified instance of HighlightedDocumentRenderer. The implementation of HighlightedDocumentRenderer should not modify the data or presume that it will be valid after the method returns.

Parameters:

chars - The characters in the document.

charStyles - The style index of each character in the document.

charCount - The number of characters in the document.

lineOffsets - The offsets of the first character of each line.

lineCount - The number of lines in the document.

extraInfo - An object to hold additional parameters from the caller of allowRender.

See Also:

HighlightedDocument.allowRender(HighlightedDocumentRenderer, Object)