org.netbeans.spi.editor.document

Class OnSaveTask.Context

java.lang.Object

org.netbeans.spi.editor.document.OnSaveTask.Context

Enclosing interface:

OnSaveTask

public static final class OnSaveTask.Context
extends Object

Context given to factory for production of on-save task.

Method Summary

Modifier and Type	Method and Description
void	addUndoEdit(UndoableEdit edit) Task may add a custom undoable edit related to its operation by using this method.
Document	getDocument() Get a document on which the task is being executed.
Element	getModificationsRootElement() Get a root element with zero or more child elements each designating a modified region of a document.

Methods inherited from class java.lang.Object

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

Method Detail

getDocument

public Document getDocument()

Get a document on which the task is being executed.

Returns:

addUndoEdit

public void addUndoEdit(UndoableEdit edit)

Task may add a custom undoable edit related to its operation by using this method.
When undo would be performed after the save then this edit would be undone (together with any possible modification changes performed by the task on the underlying document).
Note: this method should only be called during OnSaveTask.performTask().

Parameters:

edit - a custom undoable edit provided by the task.

getModificationsRootElement

public Element getModificationsRootElement()

Get a root element with zero or more child elements each designating a modified region of a document.
Tasks may use this information to work on modified document parts only.
Note: unlike in some other root element implementations here the child elements do not fully cover the root element's offset space.

Returns:

root element containing modified regions of document as child elements. Null if document's implementation does not support modified elements collecting.