IBM ILOG Dojo Diagrammer 1.1.1 API Documentation
Legend: Array Boolean Constructor Date DomNode Error Function Namespace Number Object RegExp Singleton String

ibm_ilog.diagram.editor.undo.UserCustomizedAction

Object » ibm_ilog.diagram.editor.undo.Action » ibm_ilog.diagram.editor.undo.UserCustomizedAction
dojo.require("ibm_ilog.diagram.editor.undo.UserCustomizedAction");

this action is a simple action, that also called a userCustomized function on undo/redo. The functions onUndo and onRedo must be overwritten by subclasses

Method Summary

  • constructor(label) creates a new instance, setting the corresponding label
  • getLabel() return the label. This should be used to be shown in the UI
  • getRedoUserFunction() gets the redoUser function.
  • getUndoManager() Gets the undo Manager. The UndoManager is set in the Action automatically when it is added to the undo stack
  • getUndoUserFunction() gets the undoUser function. This function is called when undo function.
  • initialize(undoFunction, redoFunction) initialize the action, by setting the undo and redo functions
  • isRedoing() return true if the action is executing a redo action
  • isUndoing() return true if the action is executing an undo action
  • redo() call the redo function
  • redoFunction() this function must be overwritten by subclasses, and is called on redo
  • setLabel(label) sets the label that should be used to be shown in the UI
  • setRedoUserFunction(redoUserFunction) sets the undoUser function. The set function is called after the standard undo function is done.
  • setUndoManager(undoManager) Sets the undo Manager
  • setUndoUserFunction(undoUserFunction) sets the undoUser function. The set function is called when undo function. The undoUserFunction must be set every time the user adds custom code on drop action.
  • undo() call the undo function
  • undoFunction() this function must be overwritten by subclasses, and is called on undo

Methods

constructor
creates a new instance, setting the corresponding label
ParameterTypeDescription
label
getLabel
return the label. This should be used to be shown in the UI
getRedoUserFunction
gets the redoUser function.
getUndoManager
Gets the undo Manager. The UndoManager is set in the Action automatically when it is added to the undo stack
getUndoUserFunction
gets the undoUser function. This function is called when undo function.
initialize
initialize the action, by setting the undo and redo functions
ParameterTypeDescription
undoFunction
redoFunction
isRedoing
return true if the action is executing a redo action
isUndoing
return true if the action is executing an undo action
redo
call the redo function
redoFunction
this function must be overwritten by subclasses, and is called on redo
setLabel
sets the label that should be used to be shown in the UI
ParameterTypeDescription
label
setRedoUserFunction
sets the undoUser function. The set function is called after the standard undo function is done.
ParameterTypeDescription
redoUserFunction
setUndoManager
Sets the undo Manager
ParameterTypeDescription
undoManager
setUndoUserFunction
sets the undoUser function. The set function is called when undo function. The undoUserFunction must be set every time the user adds custom code on drop action.
ParameterTypeDescription
undoUserFunction
undo
call the undo function
undoFunction
this function must be overwritten by subclasses, and is called on undo