org.openide.windows

Class IOFolding

java.lang.Object

org.openide.windows.IOFolding

public abstract class IOFolding
extends Object

Folding of group of lines in Output Window.

Client usage:

  InputOutput io = ...;
  if (!IOFolding.isSupported(io)) {
    throw new Exception("Folding is not supported");
  }
  io.getOut().println("First Line - start of fold");
  FoldHandle fold = IOFolding.startFold(io, true);
  io.getOut().println("  Fold Content 1");
  io.getOut().println("  The first line of nested fold");
  FoldHandle nestedFold = fold.startFold(true);
  io.getOut().println("     Nested fold content 1");
  nestedFold.finish();
  io.getOut().println("  Fold Content 2");
  fold.finish();
  io.getOut().println("Text outside of the fold.");
 

How to support IOFolding in own IOProvider implementation:

• InputOutput provided by IOProvider has to implement Lookup.Provider
• Extend IOFolding and implement its abstract methods
• Extend IOFolding.FoldHandleDefinition
• Place instance of IOFolding to Lookup provided by InputOutput

Since:

openide.io/1.38

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	IOFolding.FoldHandleDefinition An SPI for creating custom FoldHandle implementations.

Constructor Summary

Constructors

Constructor and Description
IOFolding()

Method Summary

Modifier and Type	Method and Description
static boolean	isSupported(InputOutput io) Check whether an InputOutput supports folding.
protected abstract IOFolding.FoldHandleDefinition	startFold(boolean expanded) Create a fold handle definition for the current last line in the output window.
static FoldHandle	startFold(InputOutput io, boolean expanded) Create a fold handle for the current last line in the output window.

Methods inherited from class java.lang.Object

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

Constructor Detail

IOFolding

public IOFolding()

Method Detail

isSupported

public static boolean isSupported(@NonNull
                                  InputOutput io)

Check whether an InputOutput supports folding.

Parameters:

io - The InputOutput to check.

Returns:

True if IOFolding.startFold(InputOutput, boolean) can be used with io, false otherwise.

startFold

@NonNull
protected abstract IOFolding.FoldHandleDefinition startFold(boolean expanded)

Create a fold handle definition for the current last line in the output window.

Parameters:

expanded - Initial state of the fold.

Returns:

FoldHandleDefinition for the fold handle. Never null.

Throws:

IllegalStateException - if the last fold hasn't been finished yet.

startFold

@CheckReturnValue
 @NonNull
public static FoldHandle startFold(@NonNull
                                                               InputOutput io,
                                                               boolean expanded)

Create a fold handle for the current last line in the output window.

Parameters:

io - InputOutput to create the fold in.

expanded - Initial state of the fold.

Returns:

The fold handle that can be used to finish the fold or to create nested folds.

Throws:

IllegalStateException - if the last fold hasn't been finished yet.

UnsupportedOperationException - if folding is not supported by the InputOutput object.