com.im.df.api.support
Class DFUndoConfig

java.lang.Object
  com.im.df.api.support.DFUndoConfig

public final class DFUndoConfig
extends Object

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.

Field Summary

static DFUndoConfig

OFF

Method Summary

static DFUndoConfig	create(String undoName, boolean allChangesAsSingleUndo)
String	getUndoName() Display name of undo
boolean	isAllChangesAsSingleUndo() Should all changes be grouped in a single undo operation?
boolean	isUndoEnabled() Is undo enabled?

Methods inherited from class java.lang.Object

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

Field Detail

OFF

public static final DFUndoConfig OFF

Method Detail

create

public static DFUndoConfig create(String undoName,
                                  boolean allChangesAsSingleUndo)

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

Is undo enabled?

Returns:

false for OFF otherwise true.

isAllChangesAsSingleUndo

public boolean isAllChangesAsSingleUndo()

Should all changes be grouped in a single undo operation?

getUndoName

public String getUndoName()

Display name of undo

Returns:

The name of undo operation