maxGraph/java/docs/com/mxgraph/layout/mxIGraphLayout.html

298 lines
12 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>
2018-12-14 11:54:12 +00:00
<!-- Generated by javadoc (10.0.2) on Fri Dec 14 10:40:09 UTC 2018 -->
<title>mxIGraphLayout (mxGraph 3.9.12 API Specification)</title>
2018-11-06 11:46:01 +00:00
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
2018-12-14 11:54:12 +00:00
<meta name="date" content="2018-12-14">
2014-04-01 11:30:48 +00:00
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
2018-11-06 11:46:01 +00:00
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
2016-06-02 09:57:18 +00:00
<script type="text/javascript" src="../../../script.js"></script>
2018-11-06 11:46:01 +00:00
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-1.10.2.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
2014-04-01 11:30:48 +00:00
</head>
<body>
<script type="text/javascript"><!--
2016-06-02 09:57:18 +00:00
try {
if (location.href.indexOf('is-external=true') == -1) {
2018-12-14 11:54:12 +00:00
parent.document.title="mxIGraphLayout (mxGraph 3.9.12 API Specification)";
2016-06-02 09:57:18 +00:00
}
}
catch(err) {
2012-05-21 20:32:26 +00:00
}
2014-04-01 11:30:48 +00:00
//-->
2016-06-02 09:57:18 +00:00
var methods = {"i0":6,"i1":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
2018-11-06 11:46:01 +00:00
var pathtoroot = "../../../";loadScripts(document, 'script');</script>
2014-04-01 11:30:48 +00:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2018-11-06 11:46:01 +00:00
<div class="fixedNav">
2012-05-21 20:32:26 +00:00
<!-- ========= START OF TOP NAVBAR ======= -->
2016-06-02 09:57:18 +00:00
<div class="topNav"><a name="navbar.top">
2014-04-01 11:30:48 +00:00
<!-- -->
2016-06-02 09:57:18 +00:00
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
2014-04-01 11:30:48 +00:00
<!-- -->
</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/mxIGraphLayout.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>
2018-12-14 11:54:12 +00:00
<div class="aboutLanguage"><p><b>mxGraph 3.9.12</b></p></div>
2014-04-01 11:30:48 +00:00
</div>
<div class="subNav">
<ul class="navList">
2016-06-02 09:57:18 +00:00
<li><a href="../../../com/mxgraph/layout/mxGraphLayout.html" title="class in com.mxgraph.layout"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/mxgraph/layout/mxOrganicLayout.html" title="class in com.mxgraph.layout"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
2014-04-01 11:30:48 +00:00
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/mxgraph/layout/mxIGraphLayout.html" target="_top">Frames</a></li>
2016-06-02 09:57:18 +00:00
<li><a href="mxIGraphLayout.html" target="_top">No&nbsp;Frames</a></li>
2014-04-01 11:30:48 +00:00
</ul>
<ul class="navList" id="allclasses_navbar_top">
2016-06-02 09:57:18 +00:00
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
2014-04-01 11:30:48 +00:00
</ul>
2018-11-06 11:46:01 +00:00
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
2014-04-01 11:30:48 +00:00
<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>
2018-11-06 11:46:01 +00:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2014-04-01 11:30:48 +00:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
2016-06-02 09:57:18 +00:00
<li><a href="#method.summary">Method</a></li>
2014-04-01 11:30:48 +00:00
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
2016-06-02 09:57:18 +00:00
<li><a href="#method.detail">Method</a></li>
2014-04-01 11:30:48 +00:00
</ul>
</div>
2016-06-02 09:57:18 +00:00
<a name="skip.navbar.top">
2014-04-01 11:30:48 +00:00
<!-- -->
</a></div>
2012-05-21 20:32:26 +00:00
<!-- ========= END OF TOP NAVBAR ========= -->
2018-11-06 11:46:01 +00:00
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
2012-05-21 20:32:26 +00:00
<!-- ======== START OF CLASS DATA ======== -->
2014-04-01 11:30:48 +00:00
<div class="header">
2018-11-06 11:46:01 +00:00
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="../../../com/mxgraph/layout/package-summary.html">com.mxgraph.layout</a></div>
2014-04-01 11:30:48 +00:00
<h2 title="Interface mxIGraphLayout" class="title">Interface mxIGraphLayout</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Known Implementing Classes:</dt>
2018-11-06 11:46:01 +00:00
<dd><code><a href="../../../com/mxgraph/layout/mxCircleLayout.html" title="class in com.mxgraph.layout">mxCircleLayout</a></code>, <code><a href="../../../com/mxgraph/layout/mxCompactTreeLayout.html" title="class in com.mxgraph.layout">mxCompactTreeLayout</a></code>, <code><a href="../../../com/mxgraph/layout/mxEdgeLabelLayout.html" title="class in com.mxgraph.layout">mxEdgeLabelLayout</a></code>, <code><a href="../../../com/mxgraph/layout/mxFastOrganicLayout.html" title="class in com.mxgraph.layout">mxFastOrganicLayout</a></code>, <code><a href="../../../com/mxgraph/layout/mxGraphLayout.html" title="class in com.mxgraph.layout">mxGraphLayout</a></code>, <code><a href="../../../com/mxgraph/layout/hierarchical/mxHierarchicalLayout.html" title="class in com.mxgraph.layout.hierarchical">mxHierarchicalLayout</a></code>, <code><a href="../../../com/mxgraph/layout/mxOrganicLayout.html" title="class in com.mxgraph.layout">mxOrganicLayout</a></code>, <code><a href="../../../com/mxgraph/layout/orthogonal/mxOrthogonalLayout.html" title="class in com.mxgraph.layout.orthogonal">mxOrthogonalLayout</a></code>, <code><a href="../../../com/mxgraph/layout/mxParallelEdgeLayout.html" title="class in com.mxgraph.layout">mxParallelEdgeLayout</a></code>, <code><a href="../../../com/mxgraph/layout/mxPartitionLayout.html" title="class in com.mxgraph.layout">mxPartitionLayout</a></code>, <code><a href="../../../com/mxgraph/layout/mxStackLayout.html" title="class in com.mxgraph.layout">mxStackLayout</a></code></dd>
2014-04-01 11:30:48 +00:00
</dl>
<hr>
2016-06-02 09:57:18 +00:00
<pre>public interface <span class="typeNameLabel">mxIGraphLayout</span></pre>
2014-04-01 11:30:48 +00:00
<div class="block">Defines the requirements for an object that implements a graph layout.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
2012-05-21 20:32:26 +00:00
<!-- ========== METHOD SUMMARY =========== -->
2014-04-01 11:30:48 +00:00
<ul class="blockList">
2016-06-02 09:57:18 +00:00
<li class="blockList"><a name="method.summary">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<h3>Method Summary</h3>
2018-11-06 11:46:01 +00:00
<table class="memberSummary" summary="Method Summary table, listing methods, and an explanation">
2016-06-02 09:57:18 +00:00
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
2014-04-01 11:30:48 +00:00
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
2018-11-06 11:46:01 +00:00
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
2014-04-01 11:30:48 +00:00
</tr>
2016-06-02 09:57:18 +00:00
<tr id="i0" class="altColor">
2014-04-01 11:30:48 +00:00
<td class="colFirst"><code>void</code></td>
2018-11-06 11:46:01 +00:00
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/mxgraph/layout/mxIGraphLayout.html#execute-java.lang.Object-">execute</a></span>&#8203;(java.lang.Object&nbsp;parent)</code></th>
<td class="colLast">
2014-04-01 11:30:48 +00:00
<div class="block">Executes the layout for the children of the specified parent.</div>
</td>
</tr>
2016-06-02 09:57:18 +00:00
<tr id="i1" class="rowColor">
2014-04-01 11:30:48 +00:00
<td class="colFirst"><code>void</code></td>
2018-11-06 11:46:01 +00:00
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="../../../com/mxgraph/layout/mxIGraphLayout.html#moveCell-java.lang.Object-double-double-">moveCell</a></span>&#8203;(java.lang.Object&nbsp;cell,
2014-04-01 11:30:48 +00:00
double&nbsp;x,
2018-11-06 11:46:01 +00:00
double&nbsp;y)</code></th>
<td class="colLast">
2014-04-01 11:30:48 +00:00
<div class="block">Notified when a cell is being moved in a parent that has automatic
layout to update the cell state (eg.</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">
2016-06-02 09:57:18 +00:00
<li class="blockList"><a name="method.detail">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<h3>Method Detail</h3>
2016-06-02 09:57:18 +00:00
<a name="execute-java.lang.Object-">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
2018-11-06 11:46:01 +00:00
<pre>void&nbsp;execute&#8203;(java.lang.Object&nbsp;parent)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Executes the layout for the children of the specified parent.</div>
2016-06-02 09:57:18 +00:00
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>parent</code> - Parent cell that contains the children to be layed out.</dd>
</dl>
2014-04-01 11:30:48 +00:00
</li>
</ul>
2016-06-02 09:57:18 +00:00
<a name="moveCell-java.lang.Object-double-double-">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>moveCell</h4>
2018-11-06 11:46:01 +00:00
<pre>void&nbsp;moveCell&#8203;(java.lang.Object&nbsp;cell,
2016-06-02 09:57:18 +00:00
double&nbsp;x,
double&nbsp;y)</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Notified when a cell is being moved in a parent that has automatic
2012-05-21 20:32:26 +00:00
layout to update the cell state (eg. index) so that the outcome of the
layout will position the vertex as close to the point (x, y) as
2014-04-01 11:30:48 +00:00
possible.</div>
2016-06-02 09:57:18 +00:00
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>cell</code> - Cell which is being moved.</dd>
<dd><code>x</code> - X-coordinate of the new cell location.</dd>
<dd><code>y</code> - Y-coordinate of the new cell location.</dd>
</dl>
2014-04-01 11:30:48 +00:00
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
2012-05-21 20:32:26 +00:00
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
2016-06-02 09:57:18 +00:00
<div class="bottomNav"><a name="navbar.bottom">
2014-04-01 11:30:48 +00:00
<!-- -->
2016-06-02 09:57:18 +00:00
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
2014-04-01 11:30:48 +00:00
<!-- -->
</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/mxIGraphLayout.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>
2018-12-14 11:54:12 +00:00
<div class="aboutLanguage"><p><b>mxGraph 3.9.12</b></p></div>
2014-04-01 11:30:48 +00:00
</div>
<div class="subNav">
<ul class="navList">
2016-06-02 09:57:18 +00:00
<li><a href="../../../com/mxgraph/layout/mxGraphLayout.html" title="class in com.mxgraph.layout"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/mxgraph/layout/mxOrganicLayout.html" title="class in com.mxgraph.layout"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
2014-04-01 11:30:48 +00:00
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/mxgraph/layout/mxIGraphLayout.html" target="_top">Frames</a></li>
2016-06-02 09:57:18 +00:00
<li><a href="mxIGraphLayout.html" target="_top">No&nbsp;Frames</a></li>
2014-04-01 11:30:48 +00:00
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
2016-06-02 09:57:18 +00:00
<li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
2014-04-01 11:30:48 +00:00
</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>
2018-11-06 11:46:01 +00:00
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2014-04-01 11:30:48 +00:00
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
2016-06-02 09:57:18 +00:00
<li><a href="#method.summary">Method</a></li>
2014-04-01 11:30:48 +00:00
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
2016-06-02 09:57:18 +00:00
<li><a href="#method.detail">Method</a></li>
2014-04-01 11:30:48 +00:00
</ul>
</div>
2016-06-02 09:57:18 +00:00
<a name="skip.navbar.bottom">
2014-04-01 11:30:48 +00:00
<!-- -->
</a></div>
2012-05-21 20:32:26 +00:00
<!-- ======== END OF BOTTOM NAVBAR ======= -->
2017-06-27 11:43:19 +00:00
<p class="legalCopy"><small><font size=1>Copyright (c) 2010-2017 <a href="http://www.jgraph.com/"
target="_blank">Gaudenz Alder, JGraph Ltd</a>. All rights reserved.</font></small></p>
2014-04-01 11:30:48 +00:00
</body>
</html>