Package oracle.javatools.editor.folding

Provides classes and interfaces for supporting collapsible source code blocks in the code editor.

See: Description

Interface Summary

Interface	Description
CodeExpansionListener	The listener that's notified when there is a change in the expansion state of a collapsible source code block.
CodeFoldingModel<B>	The interface that defines the data model for a code editor that supports collapsible source code blocks.
CodeFoldingModelListener	Defines the interface for an object to listen for changes in a CodeFoldingModel.
CodeFoldingProvider<B>	The interface that defines how a language implementation provides a generic data model for supporting collapsible source code blocks in the code editor.
CodeWillExpandListener	The listener that's notified prior to a change in the expansion state of a collapsible source code block, giving the listener an opportunity to veto the change.
CompoundCodeExpansionListener	Extension of CodeExpansionListener to allow compound folding operations to be received in only one call.
FoldingBlock<B extends FoldingBlock>	Defines the requirements for an object that can be used to describe a collapsible source code block in the default code folding model.

Class Summary

Class	Description
AbstractCodeFoldingPlugin<B>	Defines common behavior for an editor plugin that enables collapsible source code blocks.
AbstractFoldingBlock<B extends FoldingBlock>	Defines common behavior for an object that describes a collapsible source code block in a code folding data model.
CodeExpansionAdapter	An abstract adapter class for receiving code folding events.
CodeExpansionEvent	An event used to describe a change in the expansion state of a collapsible source code block.
CodeFoldingMargin<B>	A control that allows manipulation of collapsible source code blocks.
CodeFoldingModelEvent	Encapsulates information used to notify a CodeFoldingModelListener describing changes to a CodeFoldingModel.
DefaultCodeFoldingModel<B extends DefaultFoldingBlock>	A simple data model that describes the collapsible source code blocks in the code editor.
DefaultFoldingBlock<B extends DefaultFoldingBlock,U>	A general-purpose implementation describing a collapsible source code block in the code editor.
FoldingFader	Class to animate a background color fade for newly expanded and collapsed blocks.

Enum Summary

Enum	Description
CodeExpansionEvent.Type

Exception Summary

Exception	Description
CodeExpansionVetoException	An exception used to stop a change in the expansion state of a collapsible source code block.

Package oracle.javatools.editor.folding Description

Provides classes and interfaces for supporting collapsible source code blocks in the code editor. The implementation consists of:

• The data model classes and interfaces to describe the structure of collapsible source code blocks in the code editor in a language-independent manner.
• The data model provider interface to define how a language implementation provides the code folding data model to the editor.
• The event classes and interfaces for listening and responding to changes in the expansion state of collapsible source code blocks as well as changes in the code folding data model.
• An abstract editor plugin to serve as the basis for a language-specific editor plugin.
• Extensible default data model classes to provide common functionality needed by a typical language implementation.
• The UI margin control for manipulating the expansion state of collapsible source code blocks.

Since:

10.1.3