org.netbeans.spi.editor.fold

Interface ContentReader

public interface ContentReader

Callback interface, which is called to extract description for a fold. The Reader will be called to produce a preview text to be displayed in the folded view. The reader will be called under document lock, although the fold hierarchy will not be locked. You may query the fold properties, but may not traverse the fold hierarchy.

An instance of ContentReader is used repeatedly, i.e. if the same FoldTemplate is assigned to multiple folds. It is advised that the implementation of ContentReader is stateless.

Since:

1.35

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ContentReader.Factory Factory, which produces ContentReader instance(s) appropriate for the fold type.

Method Summary

Modifier and Type	Method and Description
CharSequence	read(Document d, Fold f, FoldTemplate ft) Acquires text for fold content.

Method Detail

read

CharSequence read(Document d,
                  Fold f,
                  FoldTemplate ft)
           throws BadLocationException

Acquires text for fold content. The method is executed under read lock on the Document. However, the Fold Hierarchy is not locked. Accessing fold offsets should be safe, but relationships with other Folds (parents, children, root) are not guarded.

If the ContentReader cannot extract the contents (i.e. it does not want to handle the fold), null may be returned. If more ContentReaders are registered, some other instance might handle the fold properly. If not, the placeholder will be retained and presented in the fold text.

Parameters:

d - the document to read from

f - fold, whose contents should be read

ft - the original fold template, if available

Returns:

content to be displayed in the folded view, or null if unwilling to retrieve the content.

Throws:

BadLocationException