Class DFUndoConfig


  • @Deprecated
    public final class DFUndoConfig
    extends java.lang.Object
    Deprecated.
    since 20.12.0
    The config parameter for operations which are undoable (see DFEntityDataProvider methods for example).

    You have basicaly three options how to use this configuration object:

    • DFUndoConfig.OFF means that undo is not created (operation won't be undoable)
    • DFUndoConfig.create("Pasting multiple values", true) is configuration where whole operation will create a single undo edit.
    • DFUndoConfig.create("Edit", false means that if operation (e.g. DFEntityDataProvider.update(java.util.List, com.im.df.api.support.DFUndoConfig, com.im.commons.progress.DFEnvironmentRW)) performs more DB changes in a single DIF method call then each operation will have own undo. For example if you call update for changes in 3 rows then user will need to press Undo action three times to revert changes.
    Author:
    Petr Hamernik
    • Field Detail

      • MAX_ROW_COUNT

        public static final int MAX_ROW_COUNT
        Deprecated.
        Maximum number of rows that can be undoable when deleting rows.
        See Also:
        Constant Field Values
    • Method Detail

      • create

        public static DFUndoConfig create​(java.lang.String undoName,
                                          boolean allChangesAsSingleUndo)
        Deprecated.
        Parameters:
        undoName - Name of undo opearation e.g. "Insert rows", "Paste",...
        allChangesAsSingleUndo - If all changes should be grouped into a single undo operation
        Returns:
        The configuration
      • isUndoEnabled

        public boolean isUndoEnabled()
        Deprecated.
        Is undo enabled?
        Returns:
        false for OFF otherwise true.
      • isAllChangesAsSingleUndo

        public boolean isAllChangesAsSingleUndo()
        Deprecated.
        Should all changes be grouped in a single undo operation?
      • getUndoName

        public java.lang.String getUndoName()
        Deprecated.
        Display name of undo
        Returns:
        The name of undo operation