Package com.im.df.api.support
Class DFUndoConfig
- java.lang.Object
-
- com.im.df.api.support.DFUndoConfig
-
@Deprecated public final class DFUndoConfig extends java.lang.ObjectDeprecated.since 20.12.0The config parameter for operations which are undoable (seeDFEntityDataProvidermethods for example).You have basicaly three options how to use this configuration object:
DFUndoConfig.OFFmeans 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", falsemeans 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 Summary
Fields Modifier and Type Field Description static intMAX_ROW_COUNTDeprecated.Maximum number of rows that can be undoable when deleting rows.static DFUndoConfigOFFDeprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static DFUndoConfigcreate(java.lang.String undoName, boolean allChangesAsSingleUndo)Deprecated.java.lang.StringgetUndoName()Deprecated.Display name of undobooleanisAllChangesAsSingleUndo()Deprecated.Should all changes be grouped in a single undo operation?booleanisUndoEnabled()Deprecated.Is undo enabled?
-
-
-
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
-
OFF
public static final DFUndoConfig OFF
Deprecated.
-
-
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:
falseforOFFotherwisetrue.
-
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
-
-