Class Index | File Index

## Classes

- _global_
- Boolean
- Date
- eclipse.sites
- eclipse.sites.SiteRenderer
- eclipse.sites.SiteTreeModel
- exports.GitCommitExplorer-GitCommitExplorer
- exports.GitRepositoryExplorer-GitRepositoryExplorer
- Object
- orion.breadcrumbs.BreadCrumbs
- orion.commands.Command
- orion.commands.CommandService
- orion.commonHTMLFragments
- orion.compare.DiffProvider
- orion.compare.rulers.CompareOverviewRuler
- orion.compare.rulers.CompareRuler
- orion.compare.rulers.LineNumberCompareRuler
- orion.compareUtils
- orion.console.Console
- orion.console.ConsoleInput
- orion.contentAssist.CssContentAssistProvider
- orion.contentAssist.HTMLContentAssistProvider
- orion.dialogs.DialogService
- orion.edit.Dispatcher
- orion.editor.ContentAssist
- orion.editor.Editor
- orion.editor.JavaScriptContentAssistProvider
- orion.editor.regex
- orion.editor.StyleReadyEvent
- orion.editor.StyleReadyEvent#LineStyle
- orion.editor.TextMateStyler
- orion.editor.util
- orion.explorer-table.FileExplorer
- orion.explorer.Explorer
- orion.explorer.ExplorerFlatModel
- orion.explorer.ExplorerModel
- orion.explorer.SelectionRenderer
- orion.ExplorerNavHandler.ExplorerNavHandler
- orion.extensionCommands
- orion.favorites.FavoritesService
- orion.file.ContentType
- orion.file.ContentTypeService
- orion.fileClient.FileClient
- orion.fileCommands
- orion.git.GitClonesExplorer
- orion.git.GitClonesModel
- orion.git.GitCommitNavigator
- orion.git.GitService
- orion.git.widgets.OpenCommitDialog
- orion.globalCommands
- orion.highlight.SyntaxHighlighter
- orion.links.TextLinkService
- orion.log.LogService
- orion.mirror.CodeMirrorStyler
- orion.mirror.Mirror
- orion.mirror.MirrorLineStyle
- orion.mirror.ModeApplier
- orion.navoutliner.NavigationOutliner
- orion.outliner.Outliner
- orion.outliner.OutlineService
- orion.parameterCollectors.CommandParameterCollector
- orion.pluginregistry.Plugin
- orion.pluginregistry.PluginRegistry
- orion.preferences.Preferences
- orion.preferences.PreferencesService
- orion.problems.ProblemService
- orion.profile.usersClient.UsersClient
- orion.progress.ProgressService
- orion.searchClient.Searcher
- orion.searchResults.SearchResultsGenerator
- orion.searchUtils
- orion.selection.Selection
- orion.serviceregistry.EventTarget
- orion.serviceregistry.Service
- orion.serviceregistry.ServiceReference
- orion.serviceregistry.ServiceRegistration
- orion.serviceregistry.ServiceRegistry
- orion.siteService.SiteConfiguration
- orion.siteService.SiteService
- orion.status.StatusReportingService
- orion.textview.Annotation
- orion.textview.AnnotationIterator
- orion.textview.AnnotationModel
- orion.textview.AnnotationRuler
- orion.textview.AnnotationStyler
- orion.textview.AnnotationTypeList
- orion.textview.BlurEvent
- orion.textview.ContextMenuEvent
- orion.textview.DestroyEvent
- orion.textview.EventTarget
- orion.textview.FocusEvent
- orion.textview.FoldingAnnotation
- orion.textview.KeyBinding
- orion.textview.LineNumberRuler
- orion.textview.LineStyleEvent
- orion.textview.LoadEvent
- orion.textview.ModelChangedEvent
- orion.textview.ModelChangingEvent
- orion.textview.ModifyEvent
- orion.textview.OverviewRuler
- orion.textview.Projection
- orion.textview.ProjectionTextModel
- orion.textview.Ruler
- orion.textview.ScrollEvent
- orion.textview.Selection
- orion.textview.SelectionEvent
- orion.textview.Style
- orion.textview.StyleRange
- orion.textview.TextModel
- orion.textview.TextView
- orion.textview.TextViewOptions
- orion.textview.UndoStack
- orion.textview.UnloadEvent
- orion.textview.VerifyEvent
- orion.TreeModelIterator.TreeModelIterator
- orion.treetable.TableTree
- orion.util
- orion.widgets.DirectoryTreeModel
- orion.widgets.OpenResourceDialog
- orion.widgets.SiteEditor
- String

# Class orion.textview.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.textview.TextView

Defined in: </shared/eclipse/e4/orion/I201202282230/plugins/org.eclipse.orion.client.editor/web/orion/textview/undoStack.js>.

Class Summary
Constructor Attributes | Constructor Name and Description
--- | ---
| orion.textview.UndoStack(view, size) Constructs a new UndoStack on a text view.

Method Summary
Method Attributes | Method Name and Description
--- | ---
| add(change) Adds a change to the stack.
| canRedo() Returns true if there is at least one change to redo.
| canUndo() Returns true if there is at least one change to undo.
| endCompoundChange() Finishes a compound change.
| getSize() Returns the sizes of the stack.
| isClean() Returns true if current state of stack is the same as the state when markClean() was called.
| markClean() Marks the current state of the stack as clean.
| redo() Redo the last change in the stack.
| reset() Reset the stack to its original state.
| startCompoundChange() Starts a compound change.
| undo() Undo the last change in the stack.

Class Detail
orion.textview.UndoStack(view, size)
Constructs a new UndoStack on a text view.

Parameters:
{orion.textview.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.
{Number} change.offset
  the offset of the change
{String} change.text
  the new text of the change
{String} change.previousText
  the previous text of the change

{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:
  #canUndo
  #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:
  #canRedo
  #undo

endCompoundChange()
Finishes a compound change.

See:
  #startCompoundChange

{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:
  #canUndo
  #canRedo

{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:
  #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:
  #isClean

{Boolean} redo()
Redo the last change in the stack.

Returns:
  {Boolean} returns true if a change was re-done.

See:
  #undo
  #canRedo

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

startCompoundChange()
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().

See:
  #endCompoundChange

{Boolean} undo()
Undo the last change in the stack.

Returns:
  {Boolean} returns true if a change was un-done.

See:
  #redo
  #canUndo

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Feb 28 2012 22:34:48 GMT-0500 (EST)