org.openide.windows

Class IOFolding.FoldHandleDefinition

java.lang.Object

org.openide.windows.IOFolding.FoldHandleDefinition

Enclosing class:

IOFolding

protected abstract static class IOFolding.FoldHandleDefinition
extends Object

An SPI for creating custom FoldHandle implementations.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FoldHandleDefinition()

Method Summary

Modifier and Type	Method and Description
abstract void	finish() Finish the fold at the current last line.
abstract void	setExpanded(boolean expanded) Set state of the fold.
abstract IOFolding.FoldHandleDefinition	startFold(boolean expanded) Start a new fold at the current last line.

Methods inherited from class java.lang.Object

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

Constructor Detail

FoldHandleDefinition

protected FoldHandleDefinition()

Method Detail

finish

public abstract void finish()

Finish the fold at the current last line. Ensure that nested folds are finished correctly.

Throws:

IllegalStateException - if parent fold has been already finished, or if there is an unfinished nested fold.

startFold

public abstract IOFolding.FoldHandleDefinition startFold(boolean expanded)

Start a new fold at the current last line. Ensure that the parent fold hasn't been finished yet.

Parameters:

expanded - If false, the fold will be collapsed by default, otherwise it will be expanded.

Returns:

FoldHandleDefinition of handle for the newly created fold.

Throws:

IllegalStateException - if the fold has been already finished, or if the last nested fold hasn't been finished yet.

setExpanded

public abstract void setExpanded(boolean expanded)

Set state of the fold. If a nested fold is expanded, expand all parent folds too.

Parameters:

expanded - True to expand the fold, false to collapse it.