org.eclipse.fx.text.ui

Interface IRewriteTarget

public interface IRewriteTarget

A target publishing the required functions to modify a document that is displayed in a text viewer. It provides access to the document and control over the redraw behavior and the grouping of document changes into undo commands.

Since:

2.0

See Also:

org.eclipse.jface.text.ITextViewer, org.eclipse.jface.text.IDocument, org.eclipse.jface.text.IUndoManager

Method Summary

Modifier and Type	Method and Description
void	beginCompoundChange() If an undo manager is connected to the document's visible presentation, this method tells the undo manager to fold all subsequent changes into one single undo command until endCompoundChange is called.
void	endCompoundChange() If an undo manager is connected to the document's visible presentation, this method tells the undo manager to stop the folding of changes into a single undo command.
IDocument	getDocument() Returns the document of this target.
void	setRedraw(boolean redraw) Disables/enables redrawing while modifying the target's document.

Method Detail

getDocument

IDocument getDocument()

Returns the document of this target.

Returns:

the document of this target

setRedraw

void setRedraw(boolean redraw)

Disables/enables redrawing while modifying the target's document.

Parameters:

redraw - true if the document's visible presentation should be updated, false otherwise

beginCompoundChange

void beginCompoundChange()

If an undo manager is connected to the document's visible presentation, this method tells the undo manager to fold all subsequent changes into one single undo command until endCompoundChange is called.

endCompoundChange

void endCompoundChange()

If an undo manager is connected to the document's visible presentation, this method tells the undo manager to stop the folding of changes into a single undo command. After this call, all subsequent changes are considered to be individually undo-able.