org.netbeans.api.editor.fold

Class FoldTemplate

java.lang.Object

org.netbeans.api.editor.fold.FoldTemplate

public final class FoldTemplate
extends Object

Template that describes how the fold should appear and interact with the user. The FoldTemplate defines how many characters at the start (end) should act as a fold guard: change to that area will remove the fold because it becomes damaged. It also defines what placeholder should appear in place of the folded code.

A template may be attached to a FoldType instance. Folds of that kind will automatically use the attached Template, if not overriden explicitly.

The string "..." (FoldTemplate.CONTENT_PLACEHOLDER) is treated as a placeholder. If a ContentReader is available for the FoldType, the placeholder will be replaced by the product of the Reader. Otherwise the placeholder will remain in the displayText and will be presented.

Since:

1.35

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_PLACEHOLDER This string is interpreted as a placeholder for the infrastructure to inject
static FoldTemplate	DEFAULT The default template for folded text: no markers before+after, ellipsis shown.
static FoldTemplate	DEFAULT_BLOCK A standard template, which represents a block of something.

Constructor Summary

Constructors

Constructor and Description
FoldTemplate(int guardedStart, int guardedEnd, String displayText) Creates a FoldTemplate with a fixed description.

Method Summary

Modifier and Type	Method and Description
String	getDescription()
int	getGuardedEnd()
int	getGuardedStart()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT

public static final FoldTemplate DEFAULT

The default template for folded text: no markers before+after, ellipsis shown.

DEFAULT_BLOCK

public static final FoldTemplate DEFAULT_BLOCK

A standard template, which represents a block of something.

CONTENT_PLACEHOLDER

public static final String CONTENT_PLACEHOLDER

This string is interpreted as a placeholder for the infrastructure to inject

Constructor Detail

FoldTemplate

public FoldTemplate(int guardedStart,
                    int guardedEnd,
                    String displayText)

Creates a FoldTemplate with a fixed description.

Parameters:

guardedStart - length of the start marker, or -1 if no start marker is present

guardedEnd - length of the end marker, or -1 if no end marker is present

displayText - text which should be displayed in place of the folded content

Method Detail

getDescription

public String getDescription()

getGuardedEnd

public int getGuardedEnd()

getGuardedStart

public int getGuardedStart()