oracle.javatools.editor.folding

Class AbstractCodeFoldingPlugin<B>

java.lang.Object

oracle.javatools.editor.plugins.AbstractEditorPlugin

oracle.javatools.editor.folding.AbstractCodeFoldingPlugin<B>

All Implemented Interfaces:

java.beans.PropertyChangeListener, java.util.EventListener, EditorPlugin

public abstract class AbstractCodeFoldingPlugin<B>
extends AbstractEditorPlugin

Defines common behavior for an editor plugin that enables collapsible source code blocks.

Since:

10.1.3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractCodeFoldingPlugin.DocumentHandler

Field Summary

Fields inherited from class oracle.javatools.editor.plugins.AbstractEditorPlugin

_editor

Constructor Summary

Constructors

Constructor and Description
AbstractCodeFoldingPlugin()

Method Summary

Modifier and Type	Method and Description
protected void	attach(BasicEditorPane editorPane)
void	beginCompoundEdit(CodeFoldingModel<B> model)
protected CodeFoldingMargin<B>	createMargin()
protected BasicDocument.PrePostDocumentListener	createPrePostDocumentListener()
protected abstract CodeFoldingProvider<B>	createProvider()
protected void	deinstallImpl(BasicEditorPane editorPane) Deinstall routine for subclasses that have added deinstallation code to execute.
protected void	detach(BasicEditorPane editorPane)
void	endCompoundEdit(CodeFoldingModel<B> model)
protected CodeFoldingMargin<B>	getMargin()
protected CodeFoldingModel<B>	getModel()
protected CodeFoldingProvider<B>	getProvider()
protected void	installImpl(BasicEditorPane editorPane) Install routine for subclasses that have added installation code to execute.
protected boolean	isMarginEnabled()
protected void	propertyChangeImpl(java.beans.PropertyChangeEvent e) Property change notification routine for subclasses that have want to respond to property changes.
protected void	setModel(CodeFoldingModel<B> model)

Methods inherited from class oracle.javatools.editor.plugins.AbstractEditorPlugin

deinstall, getDocument, getEditorPane, install, propertyChange

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCodeFoldingPlugin

public AbstractCodeFoldingPlugin()

Method Detail

installImpl

protected void installImpl(BasicEditorPane editorPane)

Description copied from class: AbstractEditorPlugin

Install routine for subclasses that have added installation code to execute. This is performed after the abstract implementation performs its install tasks.

Overrides:

installImpl in class AbstractEditorPlugin

Parameters:

editorPane - the editor pane

deinstallImpl

protected void deinstallImpl(BasicEditorPane editorPane)

Description copied from class: AbstractEditorPlugin

Deinstall routine for subclasses that have added deinstallation code to execute. This is performed before the abstract implementation performs its deinstall tasks.

Overrides:

deinstallImpl in class AbstractEditorPlugin

Parameters:

editorPane - the editor pane

propertyChangeImpl

protected void propertyChangeImpl(java.beans.PropertyChangeEvent e)

Description copied from class: AbstractEditorPlugin

Property change notification routine for subclasses that have want to respond to property changes. This is performed before the abstract implementation responds to property changes.

Overrides:

propertyChangeImpl in class AbstractEditorPlugin

Parameters:

e - A PropertyChangeEvent object describing the event source and the property that has changed.

beginCompoundEdit

public void beginCompoundEdit(CodeFoldingModel<B> model)

endCompoundEdit

public void endCompoundEdit(CodeFoldingModel<B> model)

createProvider

protected abstract CodeFoldingProvider<B> createProvider()

attach

protected void attach(BasicEditorPane editorPane)

detach

protected void detach(BasicEditorPane editorPane)

isMarginEnabled

protected boolean isMarginEnabled()

getModel

protected CodeFoldingModel<B> getModel()

setModel

protected void setModel(CodeFoldingModel<B> model)

getProvider

protected CodeFoldingProvider<B> getProvider()

getMargin

protected CodeFoldingMargin<B> getMargin()

createMargin

protected CodeFoldingMargin<B> createMargin()

createPrePostDocumentListener

protected BasicDocument.PrePostDocumentListener createPrePostDocumentListener()