|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.3.0) E17493-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CodeFoldingProvider
The interface that defines how a language implementation provides a generic data model for supporting collapsible source code blocks in the code editor.
Method Summary | |
---|---|
void |
beginCompoundEdit(CodeFoldingModel model) Notifies this provider that a compound edit has started. |
CodeFoldingModel |
createModel(BasicEditorPane editorPane) Creates a new data model describing the collapsible source code blocks in the document attached to the specified editor component. |
void |
endCompoundEdit(CodeFoldingModel model) Notifies this provider that a compound edit has ended. |
javax.swing.JPopupMenu |
getPopupMenu() Returns the popup menu of actions that can be performed by the provider. |
void |
insertUpdate(CodeFoldingModel model, int offset, int length) Executes an immediate update of the model due to an insertion in the document. |
void |
removeUpdate(CodeFoldingModel model, int offset, int length) Executes an immediate update of the model due to a deletion in the document. |
Method Detail |
---|
CodeFoldingModel createModel(BasicEditorPane editorPane)
editorPane
- the editor pane componentvoid beginCompoundEdit(CodeFoldingModel model)
insertUpdate(oracle.javatools.editor.folding.CodeFoldingModel, int, int)
s and removeUpdate(oracle.javatools.editor.folding.CodeFoldingModel, int, int)
s, and then an endCompoundEdit(oracle.javatools.editor.folding.CodeFoldingModel)
will follow immediately. This method will not be called for singleton edits.
When a compound edit is in progress, implementations are encouraged to defer UI updates from insertUpdate(oracle.javatools.editor.folding.CodeFoldingModel, int, int)
and removeUpdate(oracle.javatools.editor.folding.CodeFoldingModel, int, int)
to endCompoundEdit(oracle.javatools.editor.folding.CodeFoldingModel)
.
model
- the code folding data model.void insertUpdate(CodeFoldingModel model, int offset, int length)
model
- the code folding data modeloffset
- the caret offset of the insertionlength
- the length in characters of the inserted textvoid removeUpdate(CodeFoldingModel model, int offset, int length)
model
- the code folding data modeloffset
- the caret offset of the deletionlength
- the length in characters of the deleted textvoid endCompoundEdit(CodeFoldingModel model)
model
- the code folding data model.beginCompoundEdit(oracle.javatools.editor.folding.CodeFoldingModel)
javax.swing.JPopupMenu getPopupMenu()
null
if no actions are supported.null
if no actions are supported
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.3.0) E17493-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |