javax.swing.undo

Class AbstractUndoableEdit

Contents

    • Field Detail

      • UndoName

        protected static final String UndoName
        String returned by getUndoPresentationName; as of Java 2 platform v1.3.1 this field is no longer used. This value is now localized and comes from the defaults table with key AbstractUndoableEdit.undoText.
        See Also:
        UIDefaults, Constant Field Values

      • RedoName

        protected static final String RedoName
        String returned by getRedoPresentationName; as of Java 2 platform v1.3.1 this field is no longer used. This value is now localized and comes from the defaults table with key AbstractUndoableEdit.redoText.
        See Also:
        UIDefaults, Constant Field Values

    • Constructor Detail

      • AbstractUndoableEdit

        public AbstractUndoableEdit()
        Creates an AbstractUndoableEdit which defaults hasBeenDone and alive to true.

    • Method Detail

      • die

        public void die()
        Sets alive to false. Note that this is a one way operation; dead edits cannot be resurrected. Sending undo or redo to a dead edit results in an exception being thrown.

        Typically an edit is killed when it is consolidated by another edit's addEdit or replaceEdit method, or when it is dequeued from an UndoManager.

        Specified by:
        die in interface UndoableEdit
        See Also:
        CompoundEdit.die()

      • undo

        public void undo()
          throws CannotUndoException
        Throws CannotUndoException if canUndo returns false. Sets hasBeenDone to false. Subclasses should override to undo the operation represented by this edit. Override should begin with a call to super.
        Specified by:
        undo in interface UndoableEdit
        Throws:
        CannotUndoException - if canUndo returns false
        See Also:
        canUndo()

      • canUndo

        public boolean canUndo()
        Returns true if this edit is alive and hasBeenDone is true.
        Specified by:
        canUndo in interface UndoableEdit
        Returns:
        true if this edit is alive and hasBeenDone is true
        See Also:
        die(), undo(), redo()

      • redo

        public void redo()
          throws CannotRedoException
        Throws CannotRedoException if canRedo returns false. Sets hasBeenDone to true. Subclasses should override to redo the operation represented by this edit. Override should begin with a call to super.
        Specified by:
        redo in interface UndoableEdit
        Throws:
        CannotRedoException - if canRedo returns false
        See Also:
        canRedo()

      • canRedo

        public boolean canRedo()
        Returns true if this edit is alive and hasBeenDone is false.
        Specified by:
        canRedo in interface UndoableEdit
        Returns:
        true if this edit is alive and hasBeenDone is false
        See Also:
        die(), undo(), redo()

      • getPresentationName

        public String getPresentationName()
        This default implementation returns "". Used by getUndoPresentationName and getRedoPresentationName to construct the strings they return. Subclasses should override to return an appropriate description of the operation this edit represents.
        Specified by:
        getPresentationName in interface UndoableEdit
        Returns:
        the empty string ""
        See Also:
        getUndoPresentationName(), getRedoPresentationName()

      • getUndoPresentationName

        public String getUndoPresentationName()
        Retreives the value from the defaults table with key AbstractUndoableEdit.undoText and returns that value followed by a space, followed by getPresentationName. If getPresentationName returns "", then the defaults value is returned alone.
        Specified by:
        getUndoPresentationName in interface UndoableEdit
        Returns:
        the value from the defaults table with key AbstractUndoableEdit.undoText, followed by a space, followed by getPresentationName unless getPresentationName is "" in which case, the defaults value is returned alone.
        See Also:
        getPresentationName()

      • getRedoPresentationName

        public String getRedoPresentationName()
        Retreives the value from the defaults table with key AbstractUndoableEdit.redoText and returns that value followed by a space, followed by getPresentationName. If getPresentationName returns "", then the defaults value is returned alone.
        Specified by:
        getRedoPresentationName in interface UndoableEdit
        Returns:
        the value from the defaults table with key AbstractUndoableEdit.redoText, followed by a space, followed by getPresentationName unless getPresentationName is "" in which case, the defaults value is returned alone.
        See Also:
        getPresentationName()

      • toString

        public String toString()
        Returns a string that displays and identifies this object's properties.
        Overrides:
        toString in class Object
        Returns:
        a String representation of this object

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/swing/undo/abstractundoableedit.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut