Class Index | File Index

Classes


Class orion.editor.UndoStack

The UndoStack is used to record the history of a text model associated to an view. Every change to the model is added to stack, allowing the application to undo and redo these changes.

See:
orion.editor.TextView


Defined in: </jobs/genie.orion/orion-client-stable/workspace/bundles/org.eclipse.orion.client.editor/web/orion/editor/undoStack.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
Constructs a new UndoStack on a text view.
Method Summary
Method Attributes Method Name and Description
 
add(change)
Adds a change to the stack.
 
Returns true if there is at least one change to redo.
 
Returns true if there is at least one change to undo.
 
Destroy the undo stack.
 
Finishes a compound change.
 
Returns the redo changes.
 
Returns the sizes of the stack.
 
Returns the undo changes.
 
Returns true if current state of stack is the same as the state when markClean() was called.
 
Marks the current state of the stack as clean.
 
redo()
Redo the last change in the stack.
 
Reset the stack to its original state.
 
setView(view)
 
Starts a compound change.
 
undo()
Undo the last change in the stack.
Class Detail
orion.editor.UndoStack(view, size)
Constructs a new UndoStack on a text view.
Parameters:
{orion.editor.TextView} view
the text view for the undo stack.
{Number} size Optional, Default: 100
the size for the undo stack.
Method Detail
add(change)
Adds a change to the stack.
Parameters:
change
the change to add.

{Boolean} canRedo()
Returns true if there is at least one change to redo.
Returns:
{Boolean} returns true if there is at least one change to redo.
See:
orion.editor.UndoStack#canUndo
orion.editor.UndoStack#redo

{Boolean} canUndo()
Returns true if there is at least one change to undo.
Returns:
{Boolean} returns true if there is at least one change to undo.
See:
orion.editor.UndoStack#canRedo
orion.editor.UndoStack#undo

destroy()
Destroy the undo stack.

endCompoundChange()
Finishes a compound change.
See:
orion.editor.UndoStack#startCompoundChange

{orion.editor.TextChange[]} getRedoChanges()
Returns the redo changes.
Returns:
{orion.editor.TextChange[]} an array of TextChanges that are returned in the order that they occurred (most recent change last).
See:
orion.editor.UndoStack#getUndoChanges

{object} getSize()
Returns the sizes of the stack.
Returns:
{object} a object where object.undo is the number of changes that can be un-done, and object.redo is the number of changes that can be re-done.
See:
orion.editor.UndoStack#canUndo
orion.editor.UndoStack#canRedo

{orion.editor.TextChange[]} getUndoChanges()
Returns the undo changes.
Returns:
{orion.editor.TextChange[]} an array of TextChanges that are returned in the reverse order that they occurred (most recent change first).
See:
orion.editor.UndoStack#getRedoChanges

{Boolean} isClean()
Returns true if current state of stack is the same as the state when markClean() was called.

For example, the application calls markClean(), then calls undo() four times and redo() four times. At this point isClean() returns true.

This function is typically called to determine if the content of the view associated with the stack has changed since the last time it was saved.

Returns:
{Boolean} returns if the state is the same as the state when markClean() was called.
See:
orion.editor.UndoStack#markClean

markClean()
Marks the current state of the stack as clean.

This function is typically called when the content of view associated with the stack is saved.

See:
orion.editor.UndoStack#isClean

{Boolean} redo()
Redo the last change in the stack.
Returns:
{Boolean} returns true if a change was re-done.
See:
orion.editor.UndoStack#undo
orion.editor.UndoStack#canRedo

reset()
Reset the stack to its original state. All changes in the stack are thrown away.

setView(view)
Parameters:
view

startCompoundChange(owner)
Starts a compound change.

All changes added to stack from the time startCompoundChange() is called to the time that endCompoundChange() is called are compound on one change that can be un-done or re-done with one single call to undo() or redo().

Parameters:
owner
the owner of the compound change which is called for start, end, undo and redo.
Returns:
the compound change
See:
orion.editor.UndoStack#endCompoundChange

{Boolean} undo()
Undo the last change in the stack.
Returns:
{Boolean} returns true if a change was un-done.
See:
orion.editor.UndoStack#redo
orion.editor.UndoStack#canUndo

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Jun 29 2017 14:37:21 GMT-0400 (EDT)