552 lines
26 KiB
HTML
552 lines
26 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.mxSession 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 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 List</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class 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_1mxSession.html">mxSession</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-attribs">Static Public Attributes</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="#properties">Properties</a> |
|
|
<a href="classcom_1_1mxgraph_1_1mxSession-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">com.mxgraph.mxSession Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Implements a session that may be attached to a shared diagram.
|
|
<a href="classcom_1_1mxgraph_1_1mxSession.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:a917d860f029239d38f994a4ec8c050a8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#a917d860f029239d38f994a4ec8c050a8">mxSession</a> (string <a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#a2d89c49a46afe11d0e7440d7a63dba8f">id</a>, <a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html">mxSharedDiagram</a> <a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#a892a9f4ac463579f782f302dbcbe95fe">diagram</a>)</td></tr>
|
|
<tr class="memdesc:a917d860f029239d38f994a4ec8c050a8"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new session with the given ID. <a href="#a917d860f029239d38f994a4ec8c050a8">More...</a><br/></td></tr>
|
|
<tr class="separator:a917d860f029239d38f994a4ec8c050a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4fc396cabbe5b805cf287cbd3859c97"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#aa4fc396cabbe5b805cf287cbd3859c97">Init</a> ()</td></tr>
|
|
<tr class="memdesc:aa4fc396cabbe5b805cf287cbd3859c97"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the session buffer and returns a string that represents the state of the session. <a href="#aa4fc396cabbe5b805cf287cbd3859c97">More...</a><br/></td></tr>
|
|
<tr class="separator:aa4fc396cabbe5b805cf287cbd3859c97"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6a947426cc1ccd4f77de8c83d554eef6"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#a6a947426cc1ccd4f77de8c83d554eef6">GetInitialMessage</a> ()</td></tr>
|
|
<tr class="memdesc:a6a947426cc1ccd4f77de8c83d554eef6"><td class="mdescLeft"> </td><td class="mdescRight">Returns an XML string that represents the current state of the session and the shared diagram. A globally unique ID is used as the session's namespace, which is used on the client side to prefix IDs of newly created cells. <a href="#a6a947426cc1ccd4f77de8c83d554eef6">More...</a><br/></td></tr>
|
|
<tr class="separator:a6a947426cc1ccd4f77de8c83d554eef6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab691093cfec965dcfc4c5befffca18a7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#ab691093cfec965dcfc4c5befffca18a7">Receive</a> (XmlNode message)</td></tr>
|
|
<tr class="memdesc:ab691093cfec965dcfc4c5befffca18a7"><td class="mdescLeft"> </td><td class="mdescRight">Posts the change represented by the given XML string to the shared diagram. <a href="#ab691093cfec965dcfc4c5befffca18a7">More...</a><br/></td></tr>
|
|
<tr class="separator:ab691093cfec965dcfc4c5befffca18a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6beda19b5da62e5076d14a189bef7471"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#a6beda19b5da62e5076d14a189bef7471">Poll</a> ()</td></tr>
|
|
<tr class="memdesc:a6beda19b5da62e5076d14a189bef7471"><td class="mdescLeft"> </td><td class="mdescRight">Returns the changes received by other sessions for the shared diagram. The method returns an empty XML node if no change was received within 10 seconds. <a href="#a6beda19b5da62e5076d14a189bef7471">More...</a><br/></td></tr>
|
|
<tr class="separator:a6beda19b5da62e5076d14a189bef7471"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5cd687913e6c803d7cd21e5bd0043985"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#a5cd687913e6c803d7cd21e5bd0043985">Poll</a> (int timeout)</td></tr>
|
|
<tr class="memdesc:a5cd687913e6c803d7cd21e5bd0043985"><td class="mdescLeft"> </td><td class="mdescRight">Returns the changes received by other sessions for the shared diagram. The method returns an empty XML node if no change was received within the given timeout. <a href="#a5cd687913e6c803d7cd21e5bd0043985">More...</a><br/></td></tr>
|
|
<tr class="separator:a5cd687913e6c803d7cd21e5bd0043985"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af305f6960c5cd86050f23380b438ab3f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#af305f6960c5cd86050f23380b438ab3f">DiagramChanged</a> (Object sender, string xml)</td></tr>
|
|
<tr class="memdesc:af305f6960c5cd86050f23380b438ab3f"><td class="mdescLeft"> </td><td class="mdescRight">Invoked when the shared diagram has changed. <a href="#af305f6960c5cd86050f23380b438ab3f">More...</a><br/></td></tr>
|
|
<tr class="separator:af305f6960c5cd86050f23380b438ab3f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afeae090ff25b15387ffb89a5ddb815c8"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#afeae090ff25b15387ffb89a5ddb815c8">InactiveTimeMillis</a> ()</td></tr>
|
|
<tr class="memdesc:afeae090ff25b15387ffb89a5ddb815c8"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of milliseconds this session has been inactive. <a href="#afeae090ff25b15387ffb89a5ddb815c8">More...</a><br/></td></tr>
|
|
<tr class="separator:afeae090ff25b15387ffb89a5ddb815c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa3b3747c85960407fdd93f9be380c9ca"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#aa3b3747c85960407fdd93f9be380c9ca">Destroy</a> ()</td></tr>
|
|
<tr class="memdesc:aa3b3747c85960407fdd93f9be380c9ca"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the session and removes its listener from the shared diagram. <a href="#aa3b3747c85960407fdd93f9be380c9ca">More...</a><br/></td></tr>
|
|
<tr class="separator:aa3b3747c85960407fdd93f9be380c9ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
|
|
Static Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a1450251f61062db9caa04e6dd12534da"><td class="memItemLeft" align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#a1450251f61062db9caa04e6dd12534da">DEFAULT_TIMEOUT</a> = 10000</td></tr>
|
|
<tr class="memdesc:a1450251f61062db9caa04e6dd12534da"><td class="mdescLeft"> </td><td class="mdescRight">Default timeout is 10000 ms. <a href="#a1450251f61062db9caa04e6dd12534da">More...</a><br/></td></tr>
|
|
<tr class="separator:a1450251f61062db9caa04e6dd12534da"><td class="memSeparator" colspan="2"> </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:a2d89c49a46afe11d0e7440d7a63dba8f"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#a2d89c49a46afe11d0e7440d7a63dba8f">id</a></td></tr>
|
|
<tr class="memdesc:a2d89c49a46afe11d0e7440d7a63dba8f"><td class="mdescLeft"> </td><td class="mdescRight">Holds the session ID. <a href="#a2d89c49a46afe11d0e7440d7a63dba8f">More...</a><br/></td></tr>
|
|
<tr class="separator:a2d89c49a46afe11d0e7440d7a63dba8f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a892a9f4ac463579f782f302dbcbe95fe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html">mxSharedDiagram</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#a892a9f4ac463579f782f302dbcbe95fe">diagram</a></td></tr>
|
|
<tr class="memdesc:a892a9f4ac463579f782f302dbcbe95fe"><td class="mdescLeft"> </td><td class="mdescRight">Reference to the shared diagram. <a href="#a892a9f4ac463579f782f302dbcbe95fe">More...</a><br/></td></tr>
|
|
<tr class="separator:a892a9f4ac463579f782f302dbcbe95fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaa0d3d363332e37a66dee0a0d38a7acb"><td class="memItemLeft" align="right" valign="top">StringBuilder </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#aaa0d3d363332e37a66dee0a0d38a7acb">buffer</a> = new StringBuilder()</td></tr>
|
|
<tr class="memdesc:aaa0d3d363332e37a66dee0a0d38a7acb"><td class="mdescLeft"> </td><td class="mdescRight">Holds the send buffer for this session. <a href="#aaa0d3d363332e37a66dee0a0d38a7acb">More...</a><br/></td></tr>
|
|
<tr class="separator:aaa0d3d363332e37a66dee0a0d38a7acb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac8ca0c11db845ca7151326397a866654"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#ac8ca0c11db845ca7151326397a866654">lastTimeMillis</a> = 0</td></tr>
|
|
<tr class="memdesc:ac8ca0c11db845ca7151326397a866654"><td class="mdescLeft"> </td><td class="mdescRight">Holds the last active time millis. <a href="#ac8ca0c11db845ca7151326397a866654">More...</a><br/></td></tr>
|
|
<tr class="separator:ac8ca0c11db845ca7151326397a866654"><td class="memSeparator" colspan="2"> </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:a7ffb211995b7885112a7a8b70f08f5a6"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1mxgraph_1_1mxSession.html#a7ffb211995b7885112a7a8b70f08f5a6">Id</a><code> [get]</code></td></tr>
|
|
<tr class="memdesc:a7ffb211995b7885112a7a8b70f08f5a6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the session ID. <a href="#a7ffb211995b7885112a7a8b70f08f5a6">More...</a><br/></td></tr>
|
|
<tr class="separator:a7ffb211995b7885112a7a8b70f08f5a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Implements a session that may be attached to a shared diagram. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a917d860f029239d38f994a4ec8c050a8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">com.mxgraph.mxSession.mxSession </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html">mxSharedDiagram</a> </td>
|
|
<td class="paramname"><em>diagram</em> </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>Constructs a new session with the given ID. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">id</td><td>Specifies the session ID to be used.</td></tr>
|
|
<tr><td class="paramname">diagram</td><td>Reference to the shared diagram.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>References <a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html#af00261659d9176c483c8b86555715758">com.mxgraph.mxSharedDiagram.DiagramChange</a>, and <a class="el" href="namespacecom_1_1mxgraph.html#a7d517929d5cfd90ae8526a3f946ea6f9">com.mxgraph.mxDiagramChangeEventHandler()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="aa3b3747c85960407fdd93f9be380c9ca"></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.mxSession.Destroy </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>Destroys the session and removes its listener from the shared diagram. </p>
|
|
|
|
<p>References <a class="el" href="namespacecom_1_1mxgraph.html#a7d517929d5cfd90ae8526a3f946ea6f9">com.mxgraph.mxDiagramChangeEventHandler()</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="af305f6960c5cd86050f23380b438ab3f"></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.mxSession.DiagramChanged </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Object </td>
|
|
<td class="paramname"><em>sender</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>xml</em> </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>Invoked when the shared diagram has changed. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">sender</td><td>Session where the change was received from.</td></tr>
|
|
<tr><td class="paramname">xml</td><td>XML string that represents the change.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6a947426cc1ccd4f77de8c83d554eef6"></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.mxSession.GetInitialMessage </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 an XML string that represents the current state of the session and the shared diagram. A globally unique ID is used as the session's namespace, which is used on the client side to prefix IDs of newly created cells. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="afeae090ff25b15387ffb89a5ddb815c8"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">long com.mxgraph.mxSession.InactiveTimeMillis </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 number of milliseconds this session has been inactive. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="aa4fc396cabbe5b805cf287cbd3859c97"></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.mxSession.Init </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>Initializes the session buffer and returns a string that represents the state of the session. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the initial state of the session.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6beda19b5da62e5076d14a189bef7471"></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.mxSession.Poll </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 changes received by other sessions for the shared diagram. The method returns an empty XML node if no change was received within 10 seconds. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a string representing the changes to the shared diagram.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a5cd687913e6c803d7cd21e5bd0043985"></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.mxSession.Poll </td>
|
|
<td>(</td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>timeout</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>Returns the changes received by other sessions for the shared diagram. The method returns an empty XML node if no change was received within the given timeout. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">timeout</td><td>Time in milliseconds to wait for changes.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a string representing the changes to the shared diagram.</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab691093cfec965dcfc4c5befffca18a7"></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.mxSession.Receive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">XmlNode </td>
|
|
<td class="paramname"><em>message</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>Posts the change represented by the given XML string to the shared diagram. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">xml</td><td>XML string that represents the change.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a class="anchor" id="aaa0d3d363332e37a66dee0a0d38a7acb"></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.mxSession.buffer = 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 send buffer for this session. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a1450251f61062db9caa04e6dd12534da"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int com.mxgraph.mxSession.DEFAULT_TIMEOUT = 10000</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default timeout is 10000 ms. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a892a9f4ac463579f782f302dbcbe95fe"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classcom_1_1mxgraph_1_1mxSharedDiagram.html">mxSharedDiagram</a> com.mxgraph.mxSession.diagram</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>Reference to the shared diagram. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a2d89c49a46afe11d0e7440d7a63dba8f"></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.mxSession.id</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 session ID. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac8ca0c11db845ca7151326397a866654"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">long com.mxgraph.mxSession.lastTimeMillis = 0</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 last active time millis. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Property Documentation</h2>
|
|
<a class="anchor" id="a7ffb211995b7885112a7a8b70f08f5a6"></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.mxSession.Id</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 session ID. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>src/sharing/mxSession.cs</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Mon Jun 2 2014 04:15:11 for mxGraph by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.4
|
|
</small></address>
|
|
</body>
|
|
</html>
|