asdoc/org/apache/royale/utils/undo/IUndoManager.swf.json

{ "type": "interface",
  "qname": "org.apache.royale.utils.undo.IUndoManager",
    "description": "IUndoManager defines the interface for managing the undo and redo stacks.  <p>An undo manager maintains a stack of operations that can be undone and redone.</p>",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 10.2", "AIR 2.6"]},
      {  "tagName": "productversion",
         "values": ["Royale 0.0"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
    "qname": "clearAll",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Clears both the undo and the redo histories.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.0"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": []}
  ,
  { "type": "accessor",
    "access": "read-write",
    "return": "int",
    "qname": "undoAndRedoItemLimit",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The maximum number of undoable or redoable operations to track.  <p>To disable the undo function, set this value to 0.</p>",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.0"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "method",
    "qname": "canUndo",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Indicates whether there is currently an operation that can be undone.  Otherwise, <code>false</code>.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.0"]},
        {  "tagName": "return",
           "values": ["Boolean <code>true</code>, if there is an operation on the undo stack that can be reversed."]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "Boolean",
      "params": []}
  ,
  { "type": "method",
    "qname": "peekUndo",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Returns the next operation to be undone.  is on the stack.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.0"]},
        {  "tagName": "return",
           "values": ["The undoable IOperation object, or <code>null</code>, if no undoable operation"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "org.apache.royale.utils.undo.IOperation",
      "params": []}
  ,
  { "type": "method",
    "qname": "popUndo",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Removes the next operation to be undone from the undo stack, and returns it.  is on the stack.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.0"]},
        {  "tagName": "return",
           "values": ["The undoable IOperation object, or <code>null</code>, if no undoable operation"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "org.apache.royale.utils.undo.IOperation",
      "params": []}
  ,
  { "type": "method",
    "qname": "pushUndo",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Adds an undoable operation to the undo stack.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.0"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": [{ "name": "operation", "type": "org.apache.royale.utils.undo.IOperation"}]}
  ,
  { "type": "method",
    "qname": "clearRedo",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Clears the redo stack.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.0"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": []}
  ,
  { "type": "method",
    "qname": "canRedo",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Indicates whether there is currently an operation that can be redone.  Otherwise, <code>false</code>.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.0"]},
        {  "tagName": "return",
           "values": ["Boolean <code>true</code>, if there is an operation on the redo stack that can be redone."]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "Boolean",
      "params": []}
  ,
  { "type": "method",
    "qname": "peekRedo",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Returns the next operation to be redone.  is on the stack.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.0"]},
        {  "tagName": "return",
           "values": ["The redoable IOperation object, or <code>null</code>, if no redoable operation"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "org.apache.royale.utils.undo.IOperation",
      "params": []}
  ,
  { "type": "method",
    "qname": "popRedo",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Removes the next operation to be redone from the redo stack, and returns it.  is on the stack.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.0"]},
        {  "tagName": "return",
           "values": ["The redoable IOperation object, or <code>null</code>, if no redoable operation"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "org.apache.royale.utils.undo.IOperation",
      "params": []}
  ,
  { "type": "method",
    "qname": "pushRedo",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Adds a redoable operation to the redo stack.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 10.2", "AIR 2.6"]},
        {  "tagName": "productversion",
           "values": ["Royale 0.0"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": [{ "name": "operation", "type": "org.apache.royale.utils.undo.IOperation"}]}
  ,
  { "type": "method",
    "qname": "undo",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Removes the next IOperation object from the undo stack and calls the performUndo() function of that object.",
    "tags": [
    {  "tagName": "see",
           "values": ["org.apache.royale.utils.undo.IUndoManager#canUndo()", "org.apache.royale.utils.undo.IUndoManager#clearUndo()", "org.apache.royale.utils.undo.IUndoManager#peekUndo()", "org.apache.royale.utils.undo.IUndoManager#pushUndo()", "org.apache.royale.utils.undo.IUndoManager#popUndo()"]}  ],
      "return": "void",
      "params": []}
  ,
  { "type": "method",
    "qname": "redo",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Removes the next IOperation object from the redo stack and calls the performRedo() function of that object.",
    "tags": [
    {  "tagName": "see",
           "values": ["org.apache.royale.utils.undo.IUndoManager#canRedo()", "org.apache.royale.utils.undo.IUndoManager#clearRedo()", "org.apache.royale.utils.undo.IUndoManager#peekRedo()", "org.apache.royale.utils.undo.IUndoManager#pushRedo()", "org.apache.royale.utils.undo.IUndoManager#popRedo()"]}  ],
      "return": "void",
      "params": []}
  ]
  }