org.openide.windows

Class FoldHandle

java.lang.Object

org.openide.windows.FoldHandle

public final class FoldHandle
extends Object

An object that refers to a fold in output window. It can be used to finish the fold, or to create nested folds.

Since:

openide.io/1.38

Method Summary

Modifier and Type	Method and Description
void	finish() Finish the fold at the current last line in the output window.
FoldHandle	getCurrentNestedFold() Get current nested fold.
FoldHandle	getLastNestedFold() Get handle created by the last invocation of FoldHandle.startFold(boolean) or FoldHandle.silentStartFold(boolean).
boolean	isFinished() Check whether this fold handle has been finished.
void	setExpanded(boolean expanded) Set state of the fold.
void	silentFinish() Similar to FoldHandle.finish(), but no exception is thrown if the fold handle has been already finished.
FoldHandle	silentStartFold(boolean expanded) Similar to FoldHandle.startFold(boolean), but no exception is thrown if the fold is already finished, as well as if an unfinished nested fold exists.
FoldHandle	startFold(boolean expanded) Start a nested fold at the current last line in output window.

Methods inherited from class java.lang.Object

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

Method Detail

finish

public void finish()

Finish the fold at the current last line in the output window.

Throws:

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

startFold

public FoldHandle startFold(boolean expanded)

Start a nested fold at the current last line in output window.

Parameters:

expanded - True to expand the new fold, false to collapse it, parent folds will not be collapsed/expanded.

Returns:

Handle for the newly created fold.

Throws:

IllegalStateException - if the fold has been already finished, or if an unfinished nested fold exists.

setExpanded

public void setExpanded(boolean expanded)

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

Parameters:

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

isFinished

public boolean isFinished()

Check whether this fold handle has been finished.

Returns:

True if FoldHandle.finish() or FoldHandle.silentFinish() has been already called on this fold handle, false otherwise.

Since:

openide.io/1.42

getLastNestedFold

@CheckForNull
public FoldHandle getLastNestedFold()

Get handle created by the last invocation of FoldHandle.startFold(boolean) or FoldHandle.silentStartFold(boolean). The handle can be finished or unfinished.

Returns:

The last started nested fold. Can be null.

Since:

openide.io/1.42

getCurrentNestedFold

@CheckForNull
public FoldHandle getCurrentNestedFold()

Get current nested fold. Similar to FoldHandle.getLastNestedFold(), but returns null if the last nested fold has been already finished.

Returns:

The last unfinished nested fold or null.

Since:

openide.io/1.42

silentFinish

public void silentFinish()

Similar to FoldHandle.finish(), but no exception is thrown if the fold handle has been already finished. If an unfinished child fold exists, it will be finished too. Any exception that could happen will be caught and logged.

Since:

openide.io/1.42

silentStartFold

@CheckForNull
public FoldHandle silentStartFold(boolean expanded)

Similar to FoldHandle.startFold(boolean), but no exception is thrown if the fold is already finished, as well as if an unfinished nested fold exists. If an unfinished nested fold exists, it will be finished before creation of the new one.

Parameters:

expanded - True to expand the new fold, false to collapse it, parent folds will not be collapsed/expanded.

Returns:

The new fold handle, or null if it cannot be created.

Since:

openide.io/1.42