maxGraph/docs/js-api/files/handler/mxElbowEdgeHandler-js.html

61 lines
34 KiB
HTML
Raw Normal View History

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">
<html><head><title>mxElbowEdgeHandler</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><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.5 -->
<!-- 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="mxElbowEdgeHandler"></a>mxElbowEdgeHandler</h1><div class=CBody><p>Graph event handler that reconnects edges and modifies control points and the edge label location.&nbsp; Uses &lt;mxTerminalMarker&gt; for finding and highlighting new source and target vertices.&nbsp; This handler is automatically created in <a href="../view/mxGraph-js.html#mxGraph.createHandler" class=LFunction id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">mxGraph.createHandler</a>.&nbsp; It extends <a href="#mxElbowEdgeHandler.mxEdgeHandler" class=LFunction id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">mxEdgeHandler</a>.</p><!--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="#mxElbowEdgeHandler" >mxElbowEdgeHandler</a></td><td class=SDescription>Graph event handler that reconnects edges and modifies control points and the edge label location. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxElbowEdgeHandler.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxElbowEdgeHandler.mxEdgeHandler" >mxEdgeHandler</a></td><td class=SDescription>Constructs an edge handler for the specified <a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxCellState</a>.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxElbowEdgeHandler.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxElbowEdgeHandler.doubleClickOrientationResource" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">doubleClickOrientationResource</a></td><td class=SDescription>Specifies the resource key for the tooltip to be displayed on the single control point for routed edges. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxElbowEdgeHandler.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxElbowEdgeHandler.createBends" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">createBends</a></td><td class=SDescription>Overrides <a href="mxEdgeHandler-js.html#mxEdgeHandler.createBends" class=LFunction id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">mxEdgeHandler.createBends</a> to create custom bends.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mxElbowEdgeHandler.createVirtualBend" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">createVirtualBend</a></td><td class=SDescription>Creates a virtual bend that supports double clicking and calls <a href="../view/mxGraph-js.html#mxGraph.flipEdge" class=LFunction id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">mxGraph.flipEdge</a>.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxElbowEdgeHandler.getCursorForBend" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">getCursorForBend</a></td><td class=SDescription>Returns the cursor to be used for the bend.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mxElbowEdgeHandler.getTooltipForNode" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">getTooltipForNode</a></td><td class=SDescription>Returns the tooltip for the given node.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxElbowEdgeHandler.convertPoint" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">convertPoint</a></td><td class=SDescription>Converts the given point in-place from screen to unscaled, untranslated graph coordinates
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxElbowEdgeHandler.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxElbowEdgeHandler.mxEdgeHandler"></a>mxEdgeHandler</h3><div class=CBody><p>Constructs an edge handler for the specified <a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link13 onMouseOver="ShowTip(event, 'tt1', 'link13')" onMouseOut="HideTip('tt1')">mxCellState</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>state</td><td class=CDLDescription><a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link14 onMouseOver="ShowTip(event, 'tt1', 'link14')" onMouseOut="HideTip('tt1')">mxCellState</a> of the cell to be modified.</td></tr></table></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxElbowEdgeHandler.Variables"></a>Variables</h3></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxElbowEdgeHandler.doubleClickOrientationResource"></a>doubleClickOrientationResource</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxElbowEdgeHandler.prototype.doubleClickOrientationResource</td></tr></table></blockquote><p>Specifies the resource key for the tooltip to be displayed on the single control point for routed edges.&nbsp; If the resource for this key does not exist then the value is used as the error message.&nbsp; Default is &lsquo;doubleClickOrientation&rsquo;.</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxElbowEdgeHandler.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxElbowEdgeHandler.createBends"></a>createBends</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxElbowEdgeHandler.prototype.createBends = function()</td></tr></table></blockquote><p>Overrides <a href="mxEdgeHandler-js.html#mxEdgeHandler.createBends" class=LFunction id=link15 onMouseOver="ShowTip(event, 'tt4', 'link15')" onMouseOut="HideTip('tt4')">mxEdgeHandler.createBends</a> to create custom bends.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxElbowEdgeHandler.createVirtualBend"></a>createVirtualBend</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxElbowEdgeHandler.prototype.createVirtualBend = function()</td></tr></table></blockquote><p>Creates a virtual bend that supports double clicking and calls <a href="../view/mxGraph-js.html#mxGraph.flipEdge" class=LFunction id=link16 onMouseOver="ShowTip(event, 'tt6', 'link16')" onMouseOut="HideTip('tt6')">mxGraph.flipEdge</a>.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxElbowEdgeHandler.getCursorForBend"></a>getCursorForBend</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxElbowEdgeHandler.prototype.getCursorForBend = function()</td></tr></table></blockquote><p>Returns the cursor to be used for the bend.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxElbowEdgeHandler.getTooltipForNode"></a>getTooltipForNode</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxElbowEdgeHandler.prototype.getTooltipForNode = function(</td><td class=PParameter nowrap>node</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the tooltip for the given node.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxElbowEdgeHandler.convertPoint"></a>convertPoint</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxElbowEdgeHandler.prototype.convertPoint = function(</td><td class=PParameter nowrap>point,</td></tr><tr><td></td><td class=PParameter nowrap>gridEnabled</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Converts the given point in-place from screen to unscaled, untranslated graph coordinates and applies the grid.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>point</td><td class=CDLDescription><a href="../util/mxPoint-js.html#mxPoint" class=LClass id=link17 onMouseOver="ShowTip(event, 'tt13', 'link17')" onMouseOut="HideTip('tt13')">mxPoint</a> to be converted.</td></tr><tr><td class=CDLEntry>gridEnabled</td><td class=CDLDescription>Boolean that specifies if the grid should be applied.</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxElbowEdgeHandler.redrawInnerBends"></a>redrawInnerBends</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxElbowEdgeHandler.prototype.redrawInnerBends = function(</td><td class=PParameter nowrap>p0,</td></tr><tr><td></td><td class=PParameter nowrap>pe</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates and redraws the inner bends.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>p0</td><td class=CDLDescription><a href="../util/mxPoint-js.html#mxPoint" class=LClass id=link18 onMouseOver="ShowTip(event, 'tt13', 'link18')" onMouseOut="HideTip('tt13')">mxPoint</a> that represents the location of the first point.</td></tr><tr><td class=CDLEntry>pe</td><td class=CDLDescription><a href="../util/mxPoint-js.html#mxPoint" class=LClass id=link19 onMouseOver="ShowTip(event, 'tt13', 'link19')" onMouseOut="HideTip('tt13')">mxPoint</a> that represents the location of the last point.</td></tr></table></div></div></div>
</div><!--Content-->
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
2013-11-11 12:31:46 +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="mxCellHighlight-js.html">mxCellHighlight</a></div></div><div class=MEntry><div class=MFile><a href="mxCellMarker-js.html">mxCellMarker</a></div></div><div class=MEntry><div class=MFile><a href="mxCellTracker-js.html">mxCellTracker</a></div></div><div class=MEntry><div class=MFile><a href="mxConnectionHandler-js.html">mxConnectionHandler</a></div></div><div class=MEntry><div class=MFile><a href="mxConstraintHandler-js.html">mxConstraintHandler</a></div></div><div class=MEntry><div class=MFile><a href="mxEdgeHandler-js.html">mxEdgeHandler</a></div></div><div class=MEntry><div class=MFile><a href="mxEdgeSegmentHandler-js.html">mxEdgeSegmentHandler.js</a></div></div><div class=MEntry><div class=MFile id=MSelected>mxElbowEdgeHandler</div></div><div class=MEntry><div class=MFile><a href="mxGraphHandler-js.html">mxGraphHandler</a></div></div><div class=MEntry><div class=MFile><a href="mxKeyHandler-js.html">mxKeyHandler</a></div></div><div class=MEntry><div class=MFile><a href="mxPanningHandler-js.html">mxPanningHandler</a></div></div><div class=MEntry><div class=MFile><a href="mxPopupMenuHandler-js.html">mxPanningHandler</a></div></div><div class=MEntry><div class=MFile><a href="mxRubberband-js.html">mxRubberband</a></div></div><div class=MEntry><div class=MFile><a href="mxSelectionCellsHandler-js.html">mxSelectionCellsHandler</a></div></div><div class=MEntry><div class=MFile><a href="mxTooltipHandler-js.html">mxTooltipHandler</a></div></div><div class=MEntry><div class=MFile><a href="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></div></div><div class=MEntry><div class=MFile><a href="../io/mxModelCodec-js.html">mxModelCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxObjectCodec-js.html">mxObjectCodec</a></div></div><div class=MEntry><div class=MFile><a href="../io/mxRootChangeCodec-js.html">mxRootChangeCode
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([2], 13);// --></script></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CClass>Represents the current state of a cell in a given mxGraphView.</div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxElbowEdgeHandler.prototype.doubleClickOrientationResource</td></tr></table></blockquote>Specifies the resource key for the tooltip to be displayed on the single control point for routed edges. </div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxElbowEdgeHandler.prototype.createBends = function()</td></tr></table></blockquote>Overrides mxEdgeHandler.createBends to create custom bends.</div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.createBends = function()</td></tr></table></blockquote>Creates and returns the bends used for modifying the edge. </div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxElbowEdgeHandler.prototype.createVirtualBend = function()</td></tr></table></blockquote>Creates a virtual bend that supports double clicking and calls mxGraph.flipEdge.</div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.flipEdge = function(</td><td class=PParameter nowrap>edge</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Toggles the style of the given edge between null (or empty) and alternateEdgeStyle. </div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxElbowEdgeHandler.prototype.getCursorForBend = function()</td></tr></table></blockquote>Returns the cursor to be used for the bend.</div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxElbowEdgeHandler.prototype.getTooltipForNode = function(</td><td class=PParameter nowrap>node</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Returns the tooltip for the given node.</div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxElbowEdgeHandler.prototype.convertPoint = function(</td><td class=PParameter nowrap>point,</td></tr><tr><td></td><td class=PParameter nowrap>gridEnabled</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Converts the given point in-place from screen to unscaled, untranslated graph coordinates and applies the grid.</div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxElbowEdgeHandler.prototype.redrawInnerBends = function(</td><td class=PParameter nowrap>p0,</td></tr><tr><td></td><td class=PParameter nowrap>pe</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Updates and redraws the inner bends.</div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>mxGraph.prototype.createHandler = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></ta
<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>