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

58 lines
32 KiB
HTML
Raw Normal View History

Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
3.7.3 release
2017-06-27 11:43:19 +00:00
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>mxCompositeLayout</title><link rel="stylesheet" type="text/css" href="../../styles/main.css"><script language=JavaScript src="../../javascript/main.js"></script><script language=JavaScript src="../../javascript/prettify.js"></script><script language=JavaScript src="../../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
3.7.3 release
2017-06-27 11:43:19 +00:00
<!-- Generated by Natural Docs, version 1.51 -->
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxCompositeLayout"></a>mxCompositeLayout</h1><div class=CBody><p>Allows to compose multiple layouts into a single layout.&nbsp; The master layout is the layout that handles move operations if another layout than the first element in <a href="#mxCompositeLayout.layouts" class=LVariable id=link11 onMouseOver="ShowTip(event, 'tt2', 'link11')" onMouseOut="HideTip('tt2')">layouts</a> should be used.&nbsp; The &lt;master&gt; layout is not executed as the code assumes that it is part of <a href="#mxCompositeLayout.layouts" class=LVariable id=link12 onMouseOver="ShowTip(event, 'tt2', 'link12')" onMouseOut="HideTip('tt2')">layouts</a>.</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">var first = new mxFastOrganicLayout(graph);
var second = new mxParallelEdgeLayout(graph);
var layout = new mxCompositeLayout(graph, [first, second], first);
layout.execute(graph.getDefaultParent());</pre></blockquote><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#mxCompositeLayout" >mxCompositeLayout</a></td><td class=SDescription>Allows to compose multiple layouts into a single layout. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxCompositeLayout.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxCompositeLayout.mxCompositeLayout" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxCompositeLayout</a></td><td class=SDescription>Constructs a new layout using the given layouts. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxCompositeLayout.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxCompositeLayout.layouts" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">layouts</a></td><td class=SDescription>Holds the array of <a href="mxGraphLayout-js.html#mxGraphLayout" class=LClass id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">mxGraphLayouts</a> that this layout contains.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxCompositeLayout.layouts" >layouts</a></td><td class=SDescription>Reference to the <a href="mxGraphLayout-js.html#mxGraphLayout" class=LClass id=link4 onMouseOver="ShowTip(event, 'tt3', 'link4')" onMouseOut="HideTip('tt3')">mxGraphLayouts</a> that handles moves. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxCompositeLayout.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxCompositeLayout.moveCell" id=link5 onMouseOver="ShowTip(event, 'tt4', 'link5')" onMouseOut="HideTip('tt4')">moveCell</a></td><td class=SDescription>Implements <a href="mxGraphLayout-js.html#mxGraphLayout.moveCell" class=LFunction id=link6 onMouseOver="ShowTip(event, 'tt5', 'link6')" onMouseOut="HideTip('tt5')">mxGraphLayout.moveCell</a> by calling move on &lt;master&gt; or the first layout in <a href="#mxCompositeLayout.layouts" class=LVariable id=link7 onMouseOver="ShowTip(event, 'tt2', 'link7')" onMouseOut="HideTip('tt2')">layouts</a>.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mxCompositeLayout.execute" id=link8 onMouseOver="ShowTip(event, 'tt6', 'link8')" onMouseOut="HideTip('tt6')">execute</a></td><td class=SDescription>Implements <a href="mxGraphLayout-js.html#mxGraphLayout.execute" class=LFunction id=link9 onMouseOver="ShowTip(event, 'tt7', 'link9')" onMouseOut="HideTip('tt7')">mxGraphLayout.execute</a> by executing all <a href="#mxCompositeLayout.layouts" class=LVariable id=link10 onMouseOver="ShowTip(event, 'tt2', 'link10')" onMouseOut="HideTip('tt2')">layouts</a> in a single transaction.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxCompositeLayout.Functions"></a>Functions</h3></div></div>
3.7.3 release
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompositeLayout.mxCompositeLayout"></a>mxCompositeLayout</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function mxCompositeLayout(</td><td class="PParameter prettyprint " nowrap>graph,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>layouts,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>master</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs a new layout using the given layouts.&nbsp; The graph instance is required for creating the transaction that contains all layouts.</p><h4 class=CHeading>Arguments</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>graph</td><td class=CDLDescription>Reference to the enclosing <a href="../view/mxGraph-js.html#mxGraph" class=LClass id=link13 onMouseOver="ShowTip(event, 'tt8', 'link13')" onMouseOut="HideTip('tt8')">mxGraph</a>.</td></tr><tr><td class=CDLEntry>layouts</td><td class=CDLDescription>Array of <a href="mxGraphLayout-js.html#mxGraphLayout" class=LClass id=link14 onMouseOver="ShowTip(event, 'tt3', 'link14')" onMouseOut="HideTip('tt3')">mxGraphLayouts</a>.</td></tr><tr><td class=CDLEntry>master</td><td class=CDLDescription>Optional layout that handles moves.&nbsp; If no layout is given then the first layout of the above array is used to handle moves.</td></tr></table></div></div></div>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxCompositeLayout.Variables"></a>Variables</h3></div></div>
3.7.3 release
2017-06-27 11:43:19 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCompositeLayout.layouts"></a>layouts</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCompositeLayout.prototype.layouts</td></tr></table></blockquote><p>Holds the array of <a href="mxGraphLayout-js.html#mxGraphLayout" class=LClass id=link15 onMouseOver="ShowTip(event, 'tt3', 'link15')" onMouseOut="HideTip('tt3')">mxGraphLayouts</a> that this layout contains.</p></div></div></div>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxCompositeLayout.layouts"></a>layouts</h3><div class=CBody><p>Reference to the <a href="mxGraphLayout-js.html#mxGraphLayout" class=LClass id=link16 onMouseOver="ShowTip(event, 'tt3', 'link16')" onMouseOut="HideTip('tt3')">mxGraphLayouts</a> that handles moves.&nbsp; If this is null then the first layout in <a href="#mxCompositeLayout.layouts" class=LVariable id=link17 onMouseOver="ShowTip(event, 'tt2', 'link17')" onMouseOut="HideTip('tt2')">layouts</a> is used.</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxCompositeLayout.Functions"></a>Functions</h3></div></div>
3.7.3 release
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompositeLayout.moveCell"></a>moveCell</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxCompositeLayout.prototype.moveCell = function(</td><td class="PParameter prettyprint " nowrap>cell,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>x,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>y</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Implements <a href="mxGraphLayout-js.html#mxGraphLayout.moveCell" class=LFunction id=link18 onMouseOver="ShowTip(event, 'tt5', 'link18')" onMouseOut="HideTip('tt5')">mxGraphLayout.moveCell</a> by calling move on &lt;master&gt; or the first layout in <a href="#mxCompositeLayout.layouts" class=LVariable id=link19 onMouseOver="ShowTip(event, 'tt2', 'link19')" onMouseOut="HideTip('tt2')">layouts</a>.</p></div></div></div>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
3.7.3 release
2017-06-27 11:43:19 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxCompositeLayout.execute"></a>execute</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxCompositeLayout.prototype.execute = function(</td><td class="PParameter prettyprint " nowrap>parent</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Implements <a href="mxGraphLayout-js.html#mxGraphLayout.execute" class=LFunction id=link20 onMouseOver="ShowTip(event, 'tt7', 'link20')" onMouseOut="HideTip('tt7')">mxGraphLayout.execute</a> by executing all <a href="#mxCompositeLayout.layouts" class=LVariable id=link21 onMouseOver="ShowTip(event, 'tt2', 'link21')" onMouseOut="HideTip('tt2')">layouts</a> in a single transaction.</p></div></div></div>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
</div><!--Content-->
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
3.7.2 release
2017-04-12 12:48:34 +00:00
<div id=Menu><div class=MEntry><div class=MFile><a href="../index-txt.html">API Specification</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Editor</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="../editor/mxDefaultKeyHandler-js.html">mxDefaultKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="../editor/mxDefaultPopupMenu-js.html">mxDefaultPopupMenu</a></div></div><div class=MEntry><div class=MFile><a href="../editor/mxDefaultToolbar-js.html">mxDefaultToolbar</a></div></div><div class=MEntry><div class=MFile><a href="../editor/mxEditor-js.html">mxEditor</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Handler</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="../handler/mxCellHighlight-js.html">mxCellHighlight</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxCellMarker-js.html">mxCellMarker</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxCellTracker-js.html">mxCellTracker</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxConnectionHandler-js.html">mxConnectionHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxConstraintHandler-js.html">mxConstraintHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxEdgeHandler-js.html">mxEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxEdgeSegmentHandler-js.html">mxEdgeSegmentHandler.js</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxElbowEdgeHandler-js.html">mxElbowEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxGraphHandler-js.html">mxGraphHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxHandle-js.html">mxHandle</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxKeyHandler-js.html">mxKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxPanningHandler-js.html">mxPanningHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxPopupMenuHandler-js.html">mxPopupMenuHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxRubberband-js.html">mxRubberband</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxSelectionCellsHandler-js.html">mxSelectionCellsHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxTooltipHandler-js.html">mxTooltipHandler</a></div></div><div class=MEntry><div class=MFile><a href="../handler/mxVertexHandler-js.html">mxVertexHandler</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Io</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="../io/mxCellCodec-js.html">mxCellCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxChildChangeCodec-js.html">mxChildChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxCodec-js.html">mxCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxCodecRegistry-js.html">mxCodecRegistry</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxDefaultKeyHandlerCodec-js.html">mxDefaultKeyHandlerCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxDefaultPopupMenuCodec-js.html">mxDefaultPopupMenuCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxDefaultToolbarCodec-js.html">mxDefaultToolbarCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxEditorCodec-js.html">mxEditorCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxGenericChangeCodec-js.html">mxGenericChangeCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxGraphCodec-js.html">mxGraphCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxGraphViewCodec-js.html">mxGraphViewCodec</a></di
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
var searchPanel = new SearchPanel("searchPanel", "HTML", "../../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Cookies">Cookies</option><option value="Events">Events</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Variables">Variables</option></select></div><script language=JavaScript><!--
HideAllBut([7], 13);// --></script></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
3.7.3 release
2017-06-27 11:43:19 +00:00
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>function mxCompositeLayout(</td><td class="PParameter prettyprint " nowrap>graph,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>layouts,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>master</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Constructs a new layout using the given layouts. </div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxCompositeLayout.prototype.layouts</td></tr></table></blockquote>Holds the array of mxGraphLayouts that this layout contains.</div></div><div class=CToolTip id="tt3"><div class=CClass>Base class for all layout algorithms in mxGraph. </div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxCompositeLayout.prototype.moveCell = function(</td><td class="PParameter prettyprint " nowrap>cell,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>x,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>y</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Implements mxGraphLayout.moveCell by calling move on master or the first layout in layouts.</div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxGraphLayout.prototype.moveCell = function(</td><td class="PParameter prettyprint " nowrap>cell,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>x,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>y</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Notified when a cell is being moved in a parent that has automatic layout to update the cell state (eg. </div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxCompositeLayout.prototype.execute = function(</td><td class="PParameter prettyprint " nowrap>parent</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Implements mxGraphLayout.execute by executing all layouts in a single transaction.</div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mxGraphLayout.prototype.execute = function(</td><td class="PParameter prettyprint " nowrap>parent</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Executes the layout algorithm for the children of the given parent.</div></div><div class=CToolTip id="tt8"><div class=CClass>Extends mxEventSource to implement a graph component for the browser. </div></div><!--END_ND_TOOLTIPS-->
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>