Package com.inductiveautomation.rm.base

Class RMUndoer

  • All Implemented Interfaces:
    Changeable
    public class RMUndoer
extends AbstractChangeable
    RMUndoer - this object manages undo by keeping lists of property changes.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static interface  RMUndoer.Selection
      An interface for undo/redo selection.

    • Constructor Summary

      Constructors 
      Constructor Description
      RMUndoer()
      Creates a new undoer.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addPropertyChange​(java.beans.PropertyChangeEvent anEvent)
      Adds a property change.
      void disable()
      Disables undoer so it can receive new changes.
      void enable()
      Enables undoer.
      RMUndoSet getActiveUndoSet()
      Returns the active undo set.
      java.lang.Object getRedoSelection()
      Returns the list of objects that should be selected after current undo is redone.
      RMUndoSet getRedoSetLast()
      Returns the last redo.
      java.util.List<RMUndoSet> getRedoSets()
      Returns the list of redo sets.
      java.lang.Object getUndoSelection()
      Returns the list of objects that should be selected after current undo is fired.
      RMUndoSet getUndoSetLast()
      Returns the last undo.
      java.util.List<RMUndoSet> getUndoSets()
      Returns the list of undo sets.
      boolean hasRedos()
      Returns whether undoer has Redo changes stored away.
      boolean hasUndos()
      Returns whether undoer has Undo changes stored away.
      boolean isBenignChange​(java.lang.String aString)
      Returns whether a given change doesn't really effect signficant state change.
      boolean isDuplicate​(java.lang.String aTitle, RMObject anObj)
      Returns whether given title is title of last undo.
      boolean isEnabled()
      Returns whether undoer is disabled.
      RMUndoSet redo()
      Pops last redo set off stack and has it update all changed objects it contains.
      void reset()
      Resets the undoer to its initial state (good to do when a document is saved).
      void saveChanges()
      Pushes current undo record on the stack and opens new one.
      void setActiveUndoSet​(RMUndoSet anUndoSet)
      Sets the active event (presumably from undo sets list).
      void setRedoSelection​(java.lang.Object aList)
      Sets the list of objects that should be selected after current undo is redone.
      void setUndoSelection​(java.lang.Object aList)
      Sets the list of objects that should be selected after current undo is fired.
      void setUndoTitle​(java.lang.String aString)
      Sets the title of the current undo.
      java.lang.String toString()
      Standard toString implementation.
      RMUndoSet undo()
      Pops last undo set off stack an has it update all changed objects it contains.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • RMUndoer

        public RMUndoer()
        Creates a new undoer.

    • Method Detail

      • getActiveUndoSet

        public RMUndoSet getActiveUndoSet()
        Returns the active undo set.

      • setActiveUndoSet

        public void setActiveUndoSet​(RMUndoSet anUndoSet)
        Sets the active event (presumably from undo sets list).

      • setUndoTitle

        public void setUndoTitle​(java.lang.String aString)
        Sets the title of the current undo.

      • getUndoSets

        public java.util.List<RMUndoSet> getUndoSets()
        Returns the list of undo sets.

      • getRedoSets

        public java.util.List<RMUndoSet> getRedoSets()
        Returns the list of redo sets.

      • getUndoSetLast

        public RMUndoSet getUndoSetLast()
        Returns the last undo.

      • getRedoSetLast

        public RMUndoSet getRedoSetLast()
        Returns the last redo.

      • getUndoSelection

        public java.lang.Object getUndoSelection()
        Returns the list of objects that should be selected after current undo is fired.

      • setUndoSelection

        public void setUndoSelection​(java.lang.Object aList)
        Sets the list of objects that should be selected after current undo is fired.

      • getRedoSelection

        public java.lang.Object getRedoSelection()
        Returns the list of objects that should be selected after current undo is redone.

      • setRedoSelection

        public void setRedoSelection​(java.lang.Object aList)
        Sets the list of objects that should be selected after current undo is redone.

      • addPropertyChange

        public void addPropertyChange​(java.beans.PropertyChangeEvent anEvent)
        Adds a property change.

      • saveChanges

        public void saveChanges()
        Pushes current undo record on the stack and opens new one.

      • undo

        public RMUndoSet undo()
        Pops last undo set off stack an has it update all changed objects it contains.

      • redo

        public RMUndoSet redo()
        Pops last redo set off stack and has it update all changed objects it contains.

      • isEnabled

        public boolean isEnabled()
        Returns whether undoer is disabled.

      • disable

        public void disable()
        Disables undoer so it can receive new changes.

      • enable

        public void enable()
        Enables undoer.

      • reset

        public void reset()
        Resets the undoer to its initial state (good to do when a document is saved).

      • isBenignChange

        public boolean isBenignChange​(java.lang.String aString)
        Returns whether a given change doesn't really effect signficant state change.

      • hasUndos

        public boolean hasUndos()
        Returns whether undoer has Undo changes stored away.

      • hasRedos

        public boolean hasRedos()
        Returns whether undoer has Redo changes stored away.

      • isDuplicate

        public boolean isDuplicate​(java.lang.String aTitle,
                           RMObject anObj)
        Returns whether given title is title of last undo.

      • toString

        public java.lang.String toString()
        Standard toString implementation.
        Overrides:
        toString in class java.lang.Object