org.netbeans.spi.editor.fold

Class FoldInfo

java.lang.Object

org.netbeans.spi.editor.fold.FoldInfo

public final class FoldInfo
extends Object

The FoldInfo encapsulates the information passed to the FoldOperation#addToHierarchy(org.netbeans.api.editor.fold.FoldType, int, int, org.netbeans.api.editor.fold.FoldTemplate, boolean, java.lang.Object, org.netbeans.spi.editor.fold.FoldHierarchyTransaction). Set of FoldInfos can be then applied to the FoldHieararchy, creating new, and removing obsolete Folds, so that Folds which prevail remain in the hierarchy. The mandatory information is start and end of the fold, and the {@link FoldType}. If necessary, a {@link FoldTemplate} attached to the FoldType can be overriden for the specific Fold instance. Note though, that if the FoldTemplate instance changes with the next fold update, the Fold may fire change events.

Ultimately, it is possible to hand-override the Fold's description from the FoldTemplate provided value.

If the FoldInfo is used to update an existing Fold, the or the FoldTemplate's properties collapsed state are updated to the existing Fold instance. Appropriate fold change event is fired. It is not possible to change the type of the fold.

Initial folding state can be specified, for the case the fold will be created (it does not exist). If unspecified, the infrastructure can assign an appropriate state based on e.g. user preferences. Collapsed state is never changed for existing folds, even though FoldInfo specifies a value. Use {@link FoldUtilities#update} to perform the process.

Method Summary

Modifier and Type	Method and Description
FoldInfo	attach(Object extraInfo) Attaches custom extra info to the fold.
FoldInfo	collapsed(boolean state) Records the desired collapsed state.
Boolean	getCollapsed() Provides the desired collapsed state or null, if no specific state is required.
String	getDescriptionOverride() Returns description override.
int	getEnd() Provides end offset of the folded content
Object	getExtraInfo() Returns the extra information attached to a fold.
int	getStart() Provides start offset of the folded content
FoldTemplate	getTemplate() Provides FoldTemplate to be used with the Fold.
FoldType	getType() Provides FoldType for the fold.
static FoldInfo	range(int start, int end, FoldType type) Creates a FoldInfo for the specified range.
String	toString()
FoldInfo	withDescription(String desc) Use to provide a custom description for the fold.
FoldInfo	withTemplate(FoldTemplate t) Attaches FoldTemplate to the FoldInfo.

Methods inherited from class java.lang.Object

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

Method Detail

range

public static FoldInfo range(int start,
                             int end,
                             FoldType type)

Creates a FoldInfo for the specified range.

Parameters:

start - start offset

end - end offset

type - type of the fold

Returns:

FoldInfo instance

withTemplate

public FoldInfo withTemplate(FoldTemplate t)

Attaches FoldTemplate to the FoldInfo. The instance will be used to configure or update the Fold instance in preference to FoldType.getTemplate().

Parameters:

t - fold template

Returns:

this instance

withDescription

public FoldInfo withDescription(String desc)

Use to provide a custom description for the fold. The description overrides all other ones taken from FoldTemplates. The description can use content placeholder (see FoldTemplate for explanation. When null is set, the description Fold reverts back to the one provided by FoldTemplates (the override is cleared).

Parameters:

desc - description text.

Returns:

this instance

attach

public FoldInfo attach(Object extraInfo)

Attaches custom extra info to the fold. The extra info will be available from {@link org.netbeans.api.editor.fold.Fold#getExtraInfo.

Parameters:

extraInfo - custom data

Returns:

this instance

getDescriptionOverride

public String getDescriptionOverride()

Returns description override. When null, information from FoldTemplates should be used.

Returns:

explicit description, or null.

getExtraInfo

public Object getExtraInfo()

Returns the extra information attached to a fold.

Returns:

data, or null if no data is present

collapsed

public FoldInfo collapsed(boolean state)

Records the desired collapsed state.

Parameters:

state - the desired collapsed state

Returns:

this instance.

getStart

public int getStart()

Provides start offset of the folded content

Returns:

offset into the document

getEnd

public int getEnd()

Provides end offset of the folded content

Returns:

offset into the document

getTemplate

public FoldTemplate getTemplate()

Provides FoldTemplate to be used with the Fold. The template will be used in preference to FoldType.getTemplate(). Null return value means that the FoldTemplate from the FoldType is in effect.

Returns:

FoldTemplate instance, or null

getType

public FoldType getType()

Provides FoldType for the fold. The FoldType will be assigned to the new fold. If type of a fold (occupying the same range) changes during FoldOperation.update(java.util.Collection<org.netbeans.spi.editor.fold.FoldInfo>, java.util.Collection<org.netbeans.api.editor.fold.Fold>, java.util.Collection<org.netbeans.spi.editor.fold.FoldInfo>), the fold will be destroyed and re-created. It is not possible to change FoldType of a Fold.

Returns:

FoldType instance, never null.

getCollapsed

public Boolean getCollapsed()

Provides the desired collapsed state or null, if no specific state is required. When null is reported, the infrastructure can assign an an appropriate initial state to the fold, e.g. based on user preferences. States of existing fold is never changed during update.

Returns:

desired collapsed state or null

toString

public String toString()

Overrides:

toString in class Object