maxGraph/java/docs/com/mxgraph/model/mxIGraphModel.html

845 lines
37 KiB
HTML
Raw Normal View History

2012-05-21 20:32:26 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2014-04-01 11:30:48 +00:00
<!-- NewPage -->
<html lang="en">
<head>
2014-11-10 09:02:21 +00:00
<!-- Generated by javadoc (version 1.7.0_51) on Mon Nov 10 04:00:00 EST 2014 -->
<title>mxIGraphModel (mxGraph 3.1.1.1 API Specification)</title>
<meta name="date" content="2014-11-10">
2014-04-01 11:30:48 +00:00
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
2012-05-21 20:32:26 +00:00
if (location.href.indexOf('is-external=true') == -1) {
2014-11-10 09:02:21 +00:00
parent.document.title="mxIGraphModel (mxGraph 3.1.1.1 API Specification)";
2012-05-21 20:32:26 +00:00
}
2014-04-01 11:30:48 +00:00
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2012-05-21 20:32:26 +00:00
<!-- ========= START OF TOP NAVBAR ======= -->
2014-04-01 11:30:48 +00:00
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/mxIGraphModel.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
2014-11-10 09:02:21 +00:00
<div class="aboutLanguage"><em><p><b>mxGraph 3.1.1.1</b></p></em></div>
2014-04-01 11:30:48 +00:00
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/mxgraph/model/mxICell.html" title="interface in com.mxgraph.model"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/mxgraph/model/mxIGraphModel.mxAtomicGraphModelChange.html" title="class in com.mxgraph.model"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/mxgraph/model/mxIGraphModel.html" target="_top">Frames</a></li>
<li><a href="mxIGraphModel.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
2012-05-21 20:32:26 +00:00
if(window==top) {
2014-04-01 11:30:48 +00:00
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
2012-05-21 20:32:26 +00:00
}
//-->
2014-04-01 11:30:48 +00:00
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
2012-05-21 20:32:26 +00:00
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
2014-04-01 11:30:48 +00:00
<div class="header">
<div class="subTitle">com.mxgraph.model</div>
<h2 title="Interface mxIGraphModel" class="title">Interface mxIGraphModel</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../com/mxgraph/model/mxGraphModel.html" title="class in com.mxgraph.model">mxGraphModel</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">mxIGraphModel</span></pre>
<div class="block">Defines the requirements for a graph model to be used with mxGraph.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
2012-05-21 20:32:26 +00:00
<!-- ======== NESTED CLASS SUMMARY ======== -->
2014-04-01 11:30:48 +00:00
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.mxAtomicGraphModelChange.html" title="class in com.mxgraph.model">mxIGraphModel.mxAtomicGraphModelChange</a></strong></code>
<div class="block">Defines the interface for an atomic change of the graph model.</div>
</td>
</tr>
</table>
</li>
</ul>
2012-05-21 20:32:26 +00:00
<!-- ========== METHOD SUMMARY =========== -->
2014-04-01 11:30:48 +00:00
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#add(java.lang.Object, java.lang.Object, int)">add</a></strong>(java.lang.Object&nbsp;parent,
java.lang.Object&nbsp;child,
2014-04-01 11:30:48 +00:00
int&nbsp;index)</code>
<div class="block">Adds the specified child to the parent at the given index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
2014-11-10 09:02:21 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#addListener(java.lang.String, com.mxgraph.util.mxEventSource.mxIEventListener)">addListener</a></strong>(java.lang.String&nbsp;eventName,
2014-04-01 11:30:48 +00:00
<a href="../../../com/mxgraph/util/mxEventSource.mxIEventListener.html" title="interface in com.mxgraph.util">mxEventSource.mxIEventListener</a>&nbsp;listener)</code>
<div class="block">Binds the specified function to the given event name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#beginUpdate()">beginUpdate</a></strong>()</code>
<div class="block">Increments the updateLevel by one.</div>
</td>
</tr>
<tr class="rowColor">
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.lang.Object[]</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#cloneCells(java.lang.Object[], boolean)">cloneCells</a></strong>(java.lang.Object[]&nbsp;cells,
2014-04-01 11:30:48 +00:00
boolean&nbsp;includeChildren)</code>
<div class="block">Returns an array of clones for the given array of cells.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
2014-11-10 09:02:21 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#contains(java.lang.Object)">contains</a></strong>(java.lang.Object&nbsp;cell)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Returns true if the model contains the given cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#endUpdate()">endUpdate</a></strong>()</code>
<div class="block">Decrements the updateLevel by one and fires a notification event if the
updateLevel reaches 0.</div>
</td>
</tr>
<tr class="altColor">
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#getChildAt(java.lang.Object, int)">getChildAt</a></strong>(java.lang.Object&nbsp;parent,
2014-04-01 11:30:48 +00:00
int&nbsp;index)</code>
<div class="block">Returns the child of the given parent at the given index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
2014-11-10 09:02:21 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#getChildCount(java.lang.Object)">getChildCount</a></strong>(java.lang.Object&nbsp;cell)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the number of children in the given cell.</div>
</td>
</tr>
<tr class="altColor">
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#getEdgeAt(java.lang.Object, int)">getEdgeAt</a></strong>(java.lang.Object&nbsp;cell,
2014-04-01 11:30:48 +00:00
int&nbsp;index)</code>
<div class="block">Returns the edge of cell at the given index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
2014-11-10 09:02:21 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#getEdgeCount(java.lang.Object)">getEdgeCount</a></strong>(java.lang.Object&nbsp;cell)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the number of distinct edges connected to the given cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/mxgraph/model/mxGeometry.html" title="class in com.mxgraph.model">mxGeometry</a></code></td>
2014-11-10 09:02:21 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#getGeometry(java.lang.Object)">getGeometry</a></strong>(java.lang.Object&nbsp;cell)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the geometry of the given cell.</div>
</td>
</tr>
<tr class="rowColor">
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#getParent(java.lang.Object)">getParent</a></strong>(java.lang.Object&nbsp;child)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the parent of the given cell.</div>
</td>
</tr>
<tr class="altColor">
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.lang.Object</code></td>
2014-04-01 11:30:48 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#getRoot()">getRoot</a></strong>()</code>
<div class="block">Returns the root of the model or the topmost parent of the given cell.</div>
</td>
</tr>
<tr class="rowColor">
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#getStyle(java.lang.Object)">getStyle</a></strong>(java.lang.Object&nbsp;cell)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the style of the given cell.</div>
</td>
</tr>
<tr class="altColor">
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#getTerminal(java.lang.Object, boolean)">getTerminal</a></strong>(java.lang.Object&nbsp;edge,
2014-04-01 11:30:48 +00:00
boolean&nbsp;isSource)</code>
<div class="block">Returns the source or target terminal of the given edge depending on the
value of the boolean parameter.</div>
</td>
</tr>
<tr class="rowColor">
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#getValue(java.lang.Object)">getValue</a></strong>(java.lang.Object&nbsp;cell)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the user object of the given cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
2014-11-10 09:02:21 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#isAncestor(java.lang.Object, java.lang.Object)">isAncestor</a></strong>(java.lang.Object&nbsp;parent,
java.lang.Object&nbsp;child)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Returns true if the given parent is an ancestor of the given child.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
2014-11-10 09:02:21 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#isCollapsed(java.lang.Object)">isCollapsed</a></strong>(java.lang.Object&nbsp;cell)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Returns true if the given cell is collapsed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
2014-11-10 09:02:21 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#isConnectable(java.lang.Object)">isConnectable</a></strong>(java.lang.Object&nbsp;cell)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Returns true if the given cell is connectable.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
2014-11-10 09:02:21 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#isEdge(java.lang.Object)">isEdge</a></strong>(java.lang.Object&nbsp;cell)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Returns true if the given cell is an edge.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
2014-11-10 09:02:21 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#isVertex(java.lang.Object)">isVertex</a></strong>(java.lang.Object&nbsp;cell)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Returns true if the given cell is a vertex.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
2014-11-10 09:02:21 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#isVisible(java.lang.Object)">isVisible</a></strong>(java.lang.Object&nbsp;cell)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Returns true if the given cell is visible.</div>
</td>
</tr>
<tr class="altColor">
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#remove(java.lang.Object)">remove</a></strong>(java.lang.Object&nbsp;cell)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Removes the specified cell from the model.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#removeListener(com.mxgraph.util.mxEventSource.mxIEventListener)">removeListener</a></strong>(<a href="../../../com/mxgraph/util/mxEventSource.mxIEventListener.html" title="interface in com.mxgraph.util">mxEventSource.mxIEventListener</a>&nbsp;listener)</code>
<div class="block">Function: removeListener
Removes the given listener from the list of listeners.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#removeListener(com.mxgraph.util.mxEventSource.mxIEventListener, java.lang.String)">removeListener</a></strong>(<a href="../../../com/mxgraph/util/mxEventSource.mxIEventListener.html" title="interface in com.mxgraph.util">mxEventSource.mxIEventListener</a>&nbsp;listener,
2014-11-10 09:02:21 +00:00
java.lang.String&nbsp;eventName)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Function: removeListener
Removes the given listener from the list of listeners.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
2014-11-10 09:02:21 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#setCollapsed(java.lang.Object, boolean)">setCollapsed</a></strong>(java.lang.Object&nbsp;cell,
2014-04-01 11:30:48 +00:00
boolean&nbsp;collapsed)</code>
<div class="block">Sets the collapsed state of the given cell.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/mxgraph/model/mxGeometry.html" title="class in com.mxgraph.model">mxGeometry</a></code></td>
2014-11-10 09:02:21 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#setGeometry(java.lang.Object, com.mxgraph.model.mxGeometry)">setGeometry</a></strong>(java.lang.Object&nbsp;cell,
2014-04-01 11:30:48 +00:00
<a href="../../../com/mxgraph/model/mxGeometry.html" title="class in com.mxgraph.model">mxGeometry</a>&nbsp;geometry)</code>
<div class="block">Sets the geometry of the given cell.</div>
</td>
</tr>
<tr class="rowColor">
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#setRoot(java.lang.Object)">setRoot</a></strong>(java.lang.Object&nbsp;root)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Sets the root of the model and resets all structures.</div>
</td>
</tr>
<tr class="altColor">
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#setStyle(java.lang.Object, java.lang.String)">setStyle</a></strong>(java.lang.Object&nbsp;cell,
java.lang.String&nbsp;style)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Sets the style of the given cell.</div>
</td>
</tr>
<tr class="rowColor">
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#setTerminal(java.lang.Object, java.lang.Object, boolean)">setTerminal</a></strong>(java.lang.Object&nbsp;edge,
java.lang.Object&nbsp;terminal,
2014-04-01 11:30:48 +00:00
boolean&nbsp;isSource)</code>
<div class="block">Sets the source or target terminal of the given edge using.</div>
</td>
</tr>
<tr class="altColor">
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#setValue(java.lang.Object, java.lang.Object)">setValue</a></strong>(java.lang.Object&nbsp;cell,
java.lang.Object&nbsp;value)</code>
2014-04-01 11:30:48 +00:00
<div class="block">Sets the user object of then given cell.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
2014-11-10 09:02:21 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/model/mxIGraphModel.html#setVisible(java.lang.Object, boolean)">setVisible</a></strong>(java.lang.Object&nbsp;cell,
2014-04-01 11:30:48 +00:00
boolean&nbsp;visible)</code>
<div class="block">Sets the visible state of the given cell.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
2012-05-21 20:32:26 +00:00
<!-- ============ METHOD DETAIL ========== -->
2014-04-01 11:30:48 +00:00
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getRoot()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRoot</h4>
2014-11-10 09:02:21 +00:00
<pre>java.lang.Object&nbsp;getRoot()</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the root of the model or the topmost parent of the given cell.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Returns the root cell.</dd></dl>
</li>
</ul>
<a name="setRoot(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setRoot</h4>
2014-11-10 09:02:21 +00:00
<pre>java.lang.Object&nbsp;setRoot(java.lang.Object&nbsp;root)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Sets the root of the model and resets all structures.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>root</code> - Cell that specifies the new root.</dd></dl>
</li>
</ul>
<a name="cloneCells(java.lang.Object[], boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>cloneCells</h4>
2014-11-10 09:02:21 +00:00
<pre>java.lang.Object[]&nbsp;cloneCells(java.lang.Object[]&nbsp;cells,
boolean&nbsp;includeChildren)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns an array of clones for the given array of cells.
2012-05-21 20:32:26 +00:00
Depending on the value of includeChildren, a deep clone is created for
each cell. Connections are restored based if the corresponding
2014-04-01 11:30:48 +00:00
cell is contained in the passed in array.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cells</code> - Array of cells to be cloned.</dd><dd><code>includeChildren</code> - Boolean indicating if the cells should be cloned
with all descendants.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns a cloned array of cells.</dd></dl>
</li>
</ul>
<a name="isAncestor(java.lang.Object, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAncestor</h4>
2014-11-10 09:02:21 +00:00
<pre>boolean&nbsp;isAncestor(java.lang.Object&nbsp;parent,
java.lang.Object&nbsp;child)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns true if the given parent is an ancestor of the given child.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - Cell that specifies the parent.</dd><dd><code>child</code> - Cell that specifies the child.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns true if child is an ancestor of parent.</dd></dl>
</li>
</ul>
<a name="contains(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>contains</h4>
2014-11-10 09:02:21 +00:00
<pre>boolean&nbsp;contains(java.lang.Object&nbsp;cell)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns true if the model contains the given cell.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell to be checked.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns true if the cell is in the model.</dd></dl>
</li>
</ul>
<a name="getParent(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParent</h4>
2014-11-10 09:02:21 +00:00
<pre>java.lang.Object&nbsp;getParent(java.lang.Object&nbsp;child)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the parent of the given cell.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>child</code> - Cell whose parent should be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the parent of the given cell.</dd></dl>
</li>
</ul>
<a name="add(java.lang.Object, java.lang.Object, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
2014-11-10 09:02:21 +00:00
<pre>java.lang.Object&nbsp;add(java.lang.Object&nbsp;parent,
java.lang.Object&nbsp;child,
int&nbsp;index)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Adds the specified child to the parent at the given index. If no index
2012-05-21 20:32:26 +00:00
is specified then the child is appended to the parent's array of
2014-04-01 11:30:48 +00:00
children.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - Cell that specifies the parent to contain the child.</dd><dd><code>child</code> - Cell that specifies the child to be inserted.</dd><dd><code>index</code> - Integer that specifies the index of the child.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the inserted child.</dd></dl>
</li>
</ul>
<a name="remove(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
2014-11-10 09:02:21 +00:00
<pre>java.lang.Object&nbsp;remove(java.lang.Object&nbsp;cell)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Removes the specified cell from the model. This operation will remove
the cell and all of its children from the model.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell that should be removed.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the removed cell.</dd></dl>
</li>
</ul>
<a name="getChildCount(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildCount</h4>
2014-11-10 09:02:21 +00:00
<pre>int&nbsp;getChildCount(java.lang.Object&nbsp;cell)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the number of children in the given cell.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell whose number of children should be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the number of children in the given cell.</dd></dl>
</li>
</ul>
<a name="getChildAt(java.lang.Object, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildAt</h4>
2014-11-10 09:02:21 +00:00
<pre>java.lang.Object&nbsp;getChildAt(java.lang.Object&nbsp;parent,
int&nbsp;index)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the child of the given parent at the given index.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parent</code> - Cell that represents the parent.</dd><dd><code>index</code> - Integer that specifies the index of the child to be
returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the child at index in parent.</dd></dl>
</li>
</ul>
<a name="getTerminal(java.lang.Object, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTerminal</h4>
2014-11-10 09:02:21 +00:00
<pre>java.lang.Object&nbsp;getTerminal(java.lang.Object&nbsp;edge,
boolean&nbsp;isSource)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the source or target terminal of the given edge depending on the
value of the boolean parameter.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>edge</code> - Cell that specifies the edge.</dd><dd><code>isSource</code> - Boolean indicating which end of the edge should be
returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the source or target of the given edge.</dd></dl>
</li>
</ul>
<a name="setTerminal(java.lang.Object, java.lang.Object, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTerminal</h4>
2014-11-10 09:02:21 +00:00
<pre>java.lang.Object&nbsp;setTerminal(java.lang.Object&nbsp;edge,
java.lang.Object&nbsp;terminal,
boolean&nbsp;isSource)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Sets the source or target terminal of the given edge using.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>edge</code> - Cell that specifies the edge.</dd><dd><code>terminal</code> - Cell that specifies the new terminal.</dd><dd><code>isSource</code> - Boolean indicating if the terminal is the new source or
target terminal of the edge.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the new terminal.</dd></dl>
</li>
</ul>
<a name="getEdgeCount(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEdgeCount</h4>
2014-11-10 09:02:21 +00:00
<pre>int&nbsp;getEdgeCount(java.lang.Object&nbsp;cell)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the number of distinct edges connected to the given cell.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell that represents the vertex.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the number of edges connected to cell.</dd></dl>
</li>
</ul>
<a name="getEdgeAt(java.lang.Object, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEdgeAt</h4>
2014-11-10 09:02:21 +00:00
<pre>java.lang.Object&nbsp;getEdgeAt(java.lang.Object&nbsp;cell,
int&nbsp;index)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the edge of cell at the given index.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell that specifies the vertex.</dd><dd><code>index</code> - Integer that specifies the index of the edge to return.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the edge at the given index.</dd></dl>
</li>
</ul>
<a name="isVertex(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isVertex</h4>
2014-11-10 09:02:21 +00:00
<pre>boolean&nbsp;isVertex(java.lang.Object&nbsp;cell)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns true if the given cell is a vertex.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell that represents the possible vertex.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns true if the given cell is a vertex.</dd></dl>
</li>
</ul>
<a name="isEdge(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isEdge</h4>
2014-11-10 09:02:21 +00:00
<pre>boolean&nbsp;isEdge(java.lang.Object&nbsp;cell)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns true if the given cell is an edge.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell that represents the possible edge.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns true if the given cell is an edge.</dd></dl>
</li>
</ul>
<a name="isConnectable(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isConnectable</h4>
2014-11-10 09:02:21 +00:00
<pre>boolean&nbsp;isConnectable(java.lang.Object&nbsp;cell)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns true if the given cell is connectable.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell whose connectable state should be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the connectable state of the given cell.</dd></dl>
</li>
</ul>
<a name="getValue(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
2014-11-10 09:02:21 +00:00
<pre>java.lang.Object&nbsp;getValue(java.lang.Object&nbsp;cell)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the user object of the given cell.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell whose user object should be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the user object of the given cell.</dd></dl>
</li>
</ul>
<a name="setValue(java.lang.Object, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
2014-11-10 09:02:21 +00:00
<pre>java.lang.Object&nbsp;setValue(java.lang.Object&nbsp;cell,
java.lang.Object&nbsp;value)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Sets the user object of then given cell.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell whose user object should be changed.</dd><dd><code>value</code> - Object that defines the new user object.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the new value.</dd></dl>
</li>
</ul>
<a name="getGeometry(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGeometry</h4>
2014-11-10 09:02:21 +00:00
<pre><a href="../../../com/mxgraph/model/mxGeometry.html" title="class in com.mxgraph.model">mxGeometry</a>&nbsp;getGeometry(java.lang.Object&nbsp;cell)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the geometry of the given cell.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell whose geometry should be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the geometry of the given cell.</dd></dl>
</li>
</ul>
<a name="setGeometry(java.lang.Object, com.mxgraph.model.mxGeometry)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setGeometry</h4>
2014-11-10 09:02:21 +00:00
<pre><a href="../../../com/mxgraph/model/mxGeometry.html" title="class in com.mxgraph.model">mxGeometry</a>&nbsp;setGeometry(java.lang.Object&nbsp;cell,
2014-04-01 11:30:48 +00:00
<a href="../../../com/mxgraph/model/mxGeometry.html" title="class in com.mxgraph.model">mxGeometry</a>&nbsp;geometry)</pre>
<div class="block">Sets the geometry of the given cell.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell whose geometry should be changed.</dd><dd><code>geometry</code> - Object that defines the new geometry.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the new geometry.</dd></dl>
</li>
</ul>
<a name="getStyle(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStyle</h4>
2014-11-10 09:02:21 +00:00
<pre>java.lang.String&nbsp;getStyle(java.lang.Object&nbsp;cell)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the style of the given cell.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell whose style should be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the style of the given cell.</dd></dl>
</li>
</ul>
<a name="setStyle(java.lang.Object, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStyle</h4>
2014-11-10 09:02:21 +00:00
<pre>java.lang.String&nbsp;setStyle(java.lang.Object&nbsp;cell,
java.lang.String&nbsp;style)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Sets the style of the given cell.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell whose style should be changed.</dd><dd><code>style</code> - String of the form stylename[;key=value] to specify
the new cell style.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the new style.</dd></dl>
</li>
</ul>
<a name="isCollapsed(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isCollapsed</h4>
2014-11-10 09:02:21 +00:00
<pre>boolean&nbsp;isCollapsed(java.lang.Object&nbsp;cell)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns true if the given cell is collapsed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell whose collapsed state should be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the collapsed state of the given cell.</dd></dl>
</li>
</ul>
<a name="setCollapsed(java.lang.Object, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCollapsed</h4>
2014-11-10 09:02:21 +00:00
<pre>boolean&nbsp;setCollapsed(java.lang.Object&nbsp;cell,
2014-04-01 11:30:48 +00:00
boolean&nbsp;collapsed)</pre>
<div class="block">Sets the collapsed state of the given cell.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell whose collapsed state should be changed.</dd><dd><code>collapsed</code> - Boolean that specifies the new collpased state.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the new collapsed state.</dd></dl>
</li>
</ul>
<a name="isVisible(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isVisible</h4>
2014-11-10 09:02:21 +00:00
<pre>boolean&nbsp;isVisible(java.lang.Object&nbsp;cell)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns true if the given cell is visible.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell whose visible state should be returned.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the visible state of the given cell.</dd></dl>
</li>
</ul>
<a name="setVisible(java.lang.Object, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVisible</h4>
2014-11-10 09:02:21 +00:00
<pre>boolean&nbsp;setVisible(java.lang.Object&nbsp;cell,
2014-04-01 11:30:48 +00:00
boolean&nbsp;visible)</pre>
<div class="block">Sets the visible state of the given cell.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cell</code> - Cell whose visible state should be changed.</dd><dd><code>visible</code> - Boolean that specifies the new visible state.</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns the new visible state.</dd></dl>
</li>
</ul>
<a name="beginUpdate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beginUpdate</h4>
<pre>void&nbsp;beginUpdate()</pre>
<div class="block">Increments the updateLevel by one. The event notification is queued
until updateLevel reaches 0 by use of endUpdate.</div>
</li>
</ul>
<a name="endUpdate()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>endUpdate</h4>
<pre>void&nbsp;endUpdate()</pre>
<div class="block">Decrements the updateLevel by one and fires a notification event if the
updateLevel reaches 0.</div>
</li>
</ul>
<a name="addListener(java.lang.String, com.mxgraph.util.mxEventSource.mxIEventListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addListener</h4>
2014-11-10 09:02:21 +00:00
<pre>void&nbsp;addListener(java.lang.String&nbsp;eventName,
2014-04-01 11:30:48 +00:00
<a href="../../../com/mxgraph/util/mxEventSource.mxIEventListener.html" title="interface in com.mxgraph.util">mxEventSource.mxIEventListener</a>&nbsp;listener)</pre>
<div class="block">Binds the specified function to the given event name. If no event name
is given, then the listener is registered for all events.</div>
</li>
</ul>
<a name="removeListener(com.mxgraph.util.mxEventSource.mxIEventListener)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeListener</h4>
<pre>void&nbsp;removeListener(<a href="../../../com/mxgraph/util/mxEventSource.mxIEventListener.html" title="interface in com.mxgraph.util">mxEventSource.mxIEventListener</a>&nbsp;listener)</pre>
<div class="block">Function: removeListener
Removes the given listener from the list of listeners.</div>
</li>
</ul>
<a name="removeListener(com.mxgraph.util.mxEventSource.mxIEventListener, java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>removeListener</h4>
<pre>void&nbsp;removeListener(<a href="../../../com/mxgraph/util/mxEventSource.mxIEventListener.html" title="interface in com.mxgraph.util">mxEventSource.mxIEventListener</a>&nbsp;listener,
2014-11-10 09:02:21 +00:00
java.lang.String&nbsp;eventName)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Function: removeListener
Removes the given listener from the list of listeners.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
2012-05-21 20:32:26 +00:00
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
2014-04-01 11:30:48 +00:00
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/mxIGraphModel.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
2014-11-10 09:02:21 +00:00
<div class="aboutLanguage"><em><p><b>mxGraph 3.1.1.1</b></p></em></div>
2014-04-01 11:30:48 +00:00
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/mxgraph/model/mxICell.html" title="interface in com.mxgraph.model"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/mxgraph/model/mxIGraphModel.mxAtomicGraphModelChange.html" title="class in com.mxgraph.model"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/mxgraph/model/mxIGraphModel.html" target="_top">Frames</a></li>
<li><a href="mxIGraphModel.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
2012-05-21 20:32:26 +00:00
if(window==top) {
2014-04-01 11:30:48 +00:00
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
2012-05-21 20:32:26 +00:00
}
//-->
2014-04-01 11:30:48 +00:00
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
2012-05-21 20:32:26 +00:00
<!-- ======== END OF BOTTOM NAVBAR ======= -->
2014-04-01 11:30:48 +00:00
<p class="legalCopy"><small><font size=1>Copyright (c) 2010 <a href="http://www.mxgraph.com/"
target="_blank">Gaudenz Alder, David Benson</a>. All rights reserved.</font></small></p>
</body>
</html>