maxGraph/dotnet/docs/html/classcom_1_1mxgraph_1_1mxSh...

391 lines
18 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>mxGraph: com.mxgraph.mxSharedDiagram Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">mxGraph
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacecom.html">com</a></li><li class="navelem"><a class="el" href="namespacecom_1_1mxgraph.html">mxgraph</a></li><li class="navelem"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html">mxSharedDiagram</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="#events">Events</a> &#124;
<a href="classcom_1_1mxgraph_1_1mxSharedDiagram-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">com.mxgraph.mxSharedDiagram Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Implements a diagram that may be shared among multiple sessions.
<a href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a32eb501cda14ddc913f29dc1d97384dd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#a32eb501cda14ddc913f29dc1d97384dd">mxSharedDiagram</a> (string <a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#ab68fece204a474238eebea8ea703f74b">state</a>)</td></tr>
<tr class="memdesc:a32eb501cda14ddc913f29dc1d97384dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new diagram with the given initial state. <a href="#a32eb501cda14ddc913f29dc1d97384dd">More...</a><br/></td></tr>
<tr class="separator:a32eb501cda14ddc913f29dc1d97384dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab973fc3e74a52956b34e53c8eb61d56e"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#ab973fc3e74a52956b34e53c8eb61d56e">GetDelta</a> ()</td></tr>
<tr class="memdesc:ab973fc3e74a52956b34e53c8eb61d56e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the delta of all changes as a string. <a href="#ab973fc3e74a52956b34e53c8eb61d56e">More...</a><br/></td></tr>
<tr class="separator:ab973fc3e74a52956b34e53c8eb61d56e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b201192518fb7c702bb1e5901a36fb6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#a2b201192518fb7c702bb1e5901a36fb6">ProcessDelta</a> (Object sender, XmlNode <a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#a7d21cd6fa4923562f671f1b4dbe75474">delta</a>)</td></tr>
<tr class="memdesc:a2b201192518fb7c702bb1e5901a36fb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Appends the given string to the history and dispatches the change to all sessions that are listening to this shared diagram. <a href="#a2b201192518fb7c702bb1e5901a36fb6">More...</a><br/></td></tr>
<tr class="separator:a2b201192518fb7c702bb1e5901a36fb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa261b4e37f098bda0ca8f17c83abdefe"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#aa261b4e37f098bda0ca8f17c83abdefe">ProcessEdit</a> (XmlNode node)</td></tr>
<tr class="separator:aa261b4e37f098bda0ca8f17c83abdefe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6eb7edcac8743c15fc609605cb28643"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#aa6eb7edcac8743c15fc609605cb28643">AddDelta</a> (String xml)</td></tr>
<tr class="memdesc:aa6eb7edcac8743c15fc609605cb28643"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the delta of all changes. <a href="#aa6eb7edcac8743c15fc609605cb28643">More...</a><br/></td></tr>
<tr class="separator:aa6eb7edcac8743c15fc609605cb28643"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a586efdac443a384ce8afdfef1ae5bb5a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#a586efdac443a384ce8afdfef1ae5bb5a">ResetDelta</a> ()</td></tr>
<tr class="memdesc:a586efdac443a384ce8afdfef1ae5bb5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the delta of all changes. <a href="#a586efdac443a384ce8afdfef1ae5bb5a">More...</a><br/></td></tr>
<tr class="separator:a586efdac443a384ce8afdfef1ae5bb5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ab68fece204a474238eebea8ea703f74b"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#ab68fece204a474238eebea8ea703f74b">state</a></td></tr>
<tr class="memdesc:ab68fece204a474238eebea8ea703f74b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds the initial state of the diagram. <a href="#ab68fece204a474238eebea8ea703f74b">More...</a><br/></td></tr>
<tr class="separator:ab68fece204a474238eebea8ea703f74b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d21cd6fa4923562f671f1b4dbe75474"><td class="memItemLeft" align="right" valign="top">StringBuilder&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#a7d21cd6fa4923562f671f1b4dbe75474">delta</a> = new StringBuilder()</td></tr>
<tr class="memdesc:a7d21cd6fa4923562f671f1b4dbe75474"><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds the delta of all changes of initial state. <a href="#a7d21cd6fa4923562f671f1b4dbe75474">More...</a><br/></td></tr>
<tr class="separator:a7d21cd6fa4923562f671f1b4dbe75474"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a0c9fff9633cefe81ebdd2cae627d15a7"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#a0c9fff9633cefe81ebdd2cae627d15a7">State</a><code> [get]</code></td></tr>
<tr class="memdesc:a0c9fff9633cefe81ebdd2cae627d15a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the initial state of the diagram. <a href="#a0c9fff9633cefe81ebdd2cae627d15a7">More...</a><br/></td></tr>
<tr class="separator:a0c9fff9633cefe81ebdd2cae627d15a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="events"></a>
Events</h2></td></tr>
<tr class="memitem:af00261659d9176c483c8b86555715758"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacecom_1_1mxgraph.html#a7d517929d5cfd90ae8526a3f946ea6f9">mxDiagramChangeEventHandler</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#af00261659d9176c483c8b86555715758">DiagramChange</a></td></tr>
<tr class="memdesc:af00261659d9176c483c8b86555715758"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fires when the diagram was changed. <a href="#af00261659d9176c483c8b86555715758">More...</a><br/></td></tr>
<tr class="separator:af00261659d9176c483c8b86555715758"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implements a diagram that may be shared among multiple sessions. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a32eb501cda14ddc913f29dc1d97384dd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">com.mxgraph.mxSharedDiagram.mxSharedDiagram </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>state</em>)</td><td></td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a new diagram with the given initial state. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">state</td><td>Initial state of the diagram.</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="aa6eb7edcac8743c15fc609605cb28643"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void com.mxgraph.mxSharedDiagram.AddDelta </td>
<td>(</td>
<td class="paramtype">String&#160;</td>
<td class="paramname"><em>xml</em>)</td><td></td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the delta of all changes. </p>
</div>
</div>
<a class="anchor" id="ab973fc3e74a52956b34e53c8eb61d56e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string com.mxgraph.mxSharedDiagram.GetDelta </td>
<td>(</td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the delta of all changes as a string. </p>
</div>
</div>
<a class="anchor" id="a2b201192518fb7c702bb1e5901a36fb6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void com.mxgraph.mxSharedDiagram.ProcessDelta </td>
<td>(</td>
<td class="paramtype">Object&#160;</td>
<td class="paramname"><em>sender</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">XmlNode&#160;</td>
<td class="paramname"><em>delta</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Appends the given string to the history and dispatches the change to all sessions that are listening to this shared diagram. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sender</td><td></td></tr>
<tr><td class="paramname">delta</td><td></td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa261b4e37f098bda0ca8f17c83abdefe"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string com.mxgraph.mxSharedDiagram.ProcessEdit </td>
<td>(</td>
<td class="paramtype">XmlNode&#160;</td>
<td class="paramname"><em>node</em>)</td><td></td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p></p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">node</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
<p>References <a class="el" href="classcom_1_1mxgraph_1_1mxUtils.html#a23d23b0548bc6e2f089d007c1b87319a">com.mxgraph.mxUtils.GetXml()</a>.</p>
</div>
</div>
<a class="anchor" id="a586efdac443a384ce8afdfef1ae5bb5a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void com.mxgraph.mxSharedDiagram.ResetDelta </td>
<td>(</td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Clears the delta of all changes. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a7d21cd6fa4923562f671f1b4dbe75474"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">StringBuilder com.mxgraph.mxSharedDiagram.delta = new StringBuilder()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Holds the delta of all changes of initial state. </p>
</div>
</div>
<a class="anchor" id="ab68fece204a474238eebea8ea703f74b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string com.mxgraph.mxSharedDiagram.state</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Holds the initial state of the diagram. </p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a0c9fff9633cefe81ebdd2cae627d15a7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string com.mxgraph.mxSharedDiagram.State</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the initial state of the diagram. </p>
</div>
</div>
<h2 class="groupheader">Event Documentation</h2>
<a class="anchor" id="af00261659d9176c483c8b86555715758"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacecom_1_1mxgraph.html#a7d517929d5cfd90ae8526a3f946ea6f9">mxDiagramChangeEventHandler</a> com.mxgraph.mxSharedDiagram.DiagramChange</td>
</tr>
</table>
</div><div class="memdoc">
<p>Fires when the diagram was changed. </p>
<p>Referenced by <a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#a917d860f029239d38f994a4ec8c050a8">com.mxgraph.mxSession.mxSession()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/sharing/mxSharedState.cs</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 29 2014 04:51:27 for mxGraph by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>