zcy
/
maxGraph
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
maxGraph/docs/js-api/files/util/mxUndoableEdit-js.html

71 lines
33 KiB
HTML
Raw Normal View History

Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
<html><head><title>mxUndoableEdit</title><link rel="stylesheet" type="text/css" href="../../styles/main.css"><script language=JavaScript src="../../javascript/main.js"></script><script language=JavaScript src="../../javascript/prettify.js"></script><script language=JavaScript src="../../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.5 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxUndoableEdit"></a>mxUndoableEdit</h1><div class=CBody><p>Implements a composite undoable edit.</p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#mxUndoableEdit" >mxUndoableEdit</a></td><td class=SDescription>Implements a composite undoable edit.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxUndoableEdit.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxUndoableEdit.mxUndoableEdit" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxUndoableEdit</a></td><td class=SDescription>Constructs a new undoable edit for the given source.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxUndoableEdit.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxUndoableEdit.source" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">source</a></td><td class=SDescription>Specifies the source of the edit.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxUndoableEdit.changes" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">changes</a></td><td class=SDescription>Array that contains the changes that make up this edit. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxUndoableEdit.significant" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">significant</a></td><td class=SDescription>Specifies if the undoable change is significant. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxUndoableEdit.undone" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">undone</a></td><td class=SDescription>Specifies if this edit has been undone. </td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxUndoableEdit.redone" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">redone</a></td><td class=SDescription>Specifies if this edit has been redone. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxUndoableEdit.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxUndoableEdit.isEmpty" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">isEmpty</a></td><td class=SDescription>Returns true if the this edit contains no changes.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mxUndoableEdit.isSignificant" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">isSignificant</a></td><td class=SDescription>Returns <a href="#mxUndoableEdit.significant" class=LVariable id=link9 onMouseOver="ShowTip(event, 'tt4', 'link9')" onMouseOut="HideTip('tt4')">significant</a>.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxUndoableEdit.add" id=link10 onMouseOver="ShowTip(event, 'tt9', 'link10')" onMouseOut="HideTip('tt9')">add</a></td><td class=SDescription>Adds the specified change to this edit. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mxUndoableEdit.notify" id=link11 onMouseOver="ShowTip(event, 'tt10', 'link11')" onMouseOut="HideTip('tt10')">notify</a></td><td class=SDescription>Hook to notify any listeners of the changes after an <a href="#mxUndoableEdit.undo" class=LFunction id=link12 onMouseOver="ShowTip(event, 'tt11', 'link12')" onMouseOut="HideTip('tt11')">undo</a> or <a href="#mxUndoableEdit.redo" class=LFunction id=link13 onMouseOver="ShowTip(event, 'tt12', 'link13')" onMouseOut="HideTip('tt12')">redo</a> has been carried out. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxUndoableEdit.die" id=link14 onMouseOver="ShowTi
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxUndoableEdit.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxUndoableEdit.mxUndoableEdit"></a>mxUndoableEdit</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function mxUndoableEdit(</td><td class=PParameter nowrap>source,</td></tr><tr><td></td><td class=PParameter nowrap>significant</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs a new undoable edit for the given source.</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxUndoableEdit.Variables"></a>Variables</h3></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxUndoableEdit.source"></a>source</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.source</td></tr></table></blockquote><p>Specifies the source of the edit.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxUndoableEdit.changes"></a>changes</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.changes</td></tr></table></blockquote><p>Array that contains the changes that make up this edit.&nbsp; The changes are expected to either have an undo and redo function, or an execute function.&nbsp; Default is an empty array.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxUndoableEdit.significant"></a>significant</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.significant</td></tr></table></blockquote><p>Specifies if the undoable change is significant.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxUndoableEdit.undone"></a>undone</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.undone</td></tr></table></blockquote><p>Specifies if this edit has been undone.&nbsp; Default is false.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxUndoableEdit.redone"></a>redone</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.redone</td></tr></table></blockquote><p>Specifies if this edit has been redone.&nbsp; Default is false.</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxUndoableEdit.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxUndoableEdit.isEmpty"></a>isEmpty</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.isEmpty = function()</td></tr></table></blockquote><p>Returns true if the this edit contains no changes.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxUndoableEdit.isSignificant"></a>isSignificant</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.isSignificant = function()</td></tr></table></blockquote><p>Returns <a href="#mxUndoableEdit.significant" class=LVariable id=link17 onMouseOver="ShowTip(event, 'tt4', 'link17')" onMouseOut="HideTip('tt4')">significant</a>.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxUndoableEdit.add"></a>add</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxUndoableEdit.prototype.add = function(</td><td class=PParameter nowrap>change</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds the specified change to this edit.&nbsp; The change is an object that is expected to either have an undo and redo, or an execute function.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxUndoableEdit.notify"></a>notify</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.notify = function()</td></tr></table></blockquote><p>Hook to notify any listeners of the changes after an <a href="#mxUndoableEdit.undo" class=LFunction id=link18 onMouseOver="ShowTip(event, 'tt11', 'link18')" onMouseOut="HideTip('tt11')">undo</a> or <a href="#mxUndoableEdit.redo" class=LFunction id=link19 onMouseOver="ShowTip(event, 'tt12', 'link19')" onMouseOut="HideTip('tt12')">redo</a> has been carried out.&nbsp; This implementation is empty.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxUndoableEdit.die"></a>die</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.die = function()</td></tr></table></blockquote><p>Hook to free resources after the edit has been removed from the command history.&nbsp; This implementation is empty.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxUndoableEdit.undo"></a>undo</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.undo = function()</td></tr></table></blockquote><p>Undoes all changes in this edit.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxUndoableEdit.redo"></a>redo</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.redo = function()</td></tr></table></blockquote><p>Redoes all changes in this edit.</p></div></div></div>
</div><!--Content-->
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
<div id=Menu><div class=MEntry><div class=MFile><a href="../index-txt.html">API Specification</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Editor</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="../editor/mxDefaultKeyHandler-js.html">mxDefaultKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="../editor/mxDefaultPopupMenu-js.html">mxDefaultPopupMenu</a></div></div><div class=MEntry><div class=MFile><a href="../editor/mxDefaultToolbar-js.html">mxDefaultToolbar</a></div></div><div class=MEntry><div class=MFile><a href="../editor/mxEditor-js.html">mxEditor</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Handler</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="../handler/mxCellHighlight-js.html">mxCellHighlight</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxCellMarker-js.html">mxCellMarker</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxCellTracker-js.html">mxCellTracker</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxConnectionHandler-js.html">mxConnectionHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxConstraintHandler-js.html">mxConstraintHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxEdgeHandler-js.html">mxEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxEdgeSegmentHandler-js.html">mxEdgeSegmentHandler.js</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxElbowEdgeHandler-js.html">mxElbowEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxGraphHandler-js.html">mxGraphHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxKeyHandler-js.html">mxKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxPanningHandler-js.html">mxPanningHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxRubberband-js.html">mxRubberband</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxSelectionCellsHandler-js.html">mxSelectionCellsHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxTooltipHandler-js.html">mxTooltipHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxVertexHandler-js.html">mxVertexHandler</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Io</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="../io/mxCellCodec-js.html">mxCellCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxChildChangeCodec-js.html">mxChildChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxCodec-js.html">mxCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxCodecRegistry-js.html">mxCodecRegistry</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxDefaultKeyHandlerCodec-js.html">mxDefaultKeyHandlerCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxDefaultPopupMenuCodec-js.html">mxDefaultPopupMenuCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxDefaultToolbarCodec-js.html">mxDefaultToolbarCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxEditorCodec-js.html">mxEditorCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxGenericChangeCodec-js.html">mxGenericChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxGraphCodec-js.html">mxGraphCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxGraphViewCodec-js.html">mxGraphViewCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxModelCodec-js.html">mxModelCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxObjectCodec-js.html">mxObjectCodec</a></div></div><div
var searchPanel = new SearchPanel("searchPanel", "HTML", "../../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Cookies">Cookies</option><option value="Events">Events</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
HideAllBut([10], 13);// --></script></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>function mxUndoableEdit(</td><td class=PParameter nowrap>source,</td></tr><tr><td></td><td class=PParameter nowrap>significant</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Constructs a new undoable edit for the given source.</div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.source</td></tr></table></blockquote>Specifies the source of the edit.</div></div><div class=CToolTip id="tt3"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.changes</td></tr></table></blockquote>Array that contains the changes that make up this edit. </div></div><div class=CToolTip id="tt4"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.significant</td></tr></table></blockquote>Specifies if the undoable change is significant. </div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.undone</td></tr></table></blockquote>Specifies if this edit has been undone. </div></div><div class=CToolTip id="tt6"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.redone</td></tr></table></blockquote>Specifies if this edit has been redone. </div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.isEmpty = function()</td></tr></table></blockquote>Returns true if the this edit contains no changes.</div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.isSignificant = function()</td></tr></table></blockquote>Returns significant.</div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxUndoableEdit.prototype.add = function(</td><td class=PParameter nowrap>change</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Adds the specified change to this edit. </div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.notify = function()</td></tr></table></blockquote>Hook to notify any listeners of the changes after an undo or redo has been carried out. </div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.undo = function()</td></tr></table></blockquote>Undoes all changes in this edit.</div></div><div class=CToolTip id="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.redo = function()</td></tr></table></blockquote>Redoes all changes in this edit.</div></div><div class=CToolTip id="tt13"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxUndoableEdit.prototype.die = function()</td></tr></table></blockquote>Hook to free resources after the edit has been removed from the command history. </div></div><!--END_ND_TOOLTIPS-->
<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>