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

166 lines
106 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>mxEdgeHandler</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 -->
2013-06-28 19:07:06 +00:00
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxEdgeHandler"></a>mxEdgeHandler</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=link77 onMouseOver="ShowTip(event, 'tt69', 'link77')" onMouseOut="HideTip('tt69')">mxGraph.createHandler</a> for each selected edge.</p><h4 class=CHeading>To enable adding/removing control points, the following code can be used</h4><blockquote><pre class="prettyprint">mxEdgeHandler.prototype.addEnabled = true;
mxEdgeHandler.prototype.removeEnabled = true;</pre></blockquote><p>Note: This experimental feature is not recommended for production use.</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="#mxEdgeHandler" >mxEdgeHandler</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="#mxEdgeHandler.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxEdgeHandler.mxEdgeHandler" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxEdgeHandler</a></td><td class=SDescription>Constructs an edge handler for the specified <a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">mxCellState</a>.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxEdgeHandler.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxEdgeHandler.graph" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">graph</a></td><td class=SDescription>Reference to the enclosing <a href="../view/mxGraph-js.html#mxGraph" class=LClass id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">mxGraph</a>.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxEdgeHandler.state" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">state</a></td><td class=SDescription>Reference to the <a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link6 onMouseOver="ShowTip(event, 'tt2', 'link6')" onMouseOut="HideTip('tt2')">mxCellState</a> being modified.</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxEdgeHandler.marker" id=link7 onMouseOver="ShowTip(event, 'tt6', 'link7')" onMouseOut="HideTip('tt6')">marker</a></td><td class=SDescription>Holds the &lt;mxTerminalMarker&gt; which is used for highlighting terminals.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxEdgeHandler.constraintHandler" id=link8 onMouseOver="ShowTip(event, 'tt7', 'link8')" onMouseOut="HideTip('tt7')">constraintHandler</a></td><td class=SDescription>Holds the <a href="mxConstraintHandler-js.html#mxConstraintHandler" class=LClass id=link9 onMouseOver="ShowTip(event, 'tt8', 'link9')" onMouseOut="HideTip('tt8')">mxConstraintHandler</a> used for drawing and highlighting constraints.</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxEdgeHandler.error" id=link10 onMouseOver="ShowTip(event, 'tt9', 'link10')" onMouseOut="HideTip('tt9')">error</a></td><td class=SDescription>Holds the current validation error while a connection is being changed.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxEdgeHandler.shape" id=link11 onMouseOver="ShowTip(event, 'tt10', 'link11')" onMouseOut="HideTip('tt10')">shape</a></td><td class=SDescription>Holds the <a href="../shape/mxShape-js.html#mxShape" class=LClass id=link12 onMouseOver="ShowTip(event, 'tt11', 'link12')" onMouseOut="HideTip('tt11')">mxShape</a> that represents the preview edge.</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxEdgeHandler.bends" id=link13 onMouseOver="ShowTip(event, 'tt12', 'link13')" onMouseOut="HideTip('tt12')">bends</a></td><td class=SDescription>Holds the <a href="../shape/mxShape-js.html#mxShape" class=LClass id=link14 onMouseOver="ShowTip(event, 'tt11', 'link14')" onMouseOut="HideTip('tt11')">mxShapes</a> that represent the points.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxEdgeHandler.labelShape" id=link15 onMouseOver="ShowTip(event, 'tt13', 'link15')" onMouseOut="HideTip('tt13')">labelShape</a></td><td class=SDescription>Holds the <a hr
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.Functions"></a>Functions</h3></div></div>
2013-06-28 19:07:06 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.mxEdgeHandler"></a>mxEdgeHandler</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>function mxEdgeHandler(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs an edge handler for the specified <a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link78 onMouseOver="ShowTip(event, 'tt2', 'link78')" onMouseOut="HideTip('tt2')">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=link79 onMouseOver="ShowTip(event, 'tt2', 'link79')" onMouseOut="HideTip('tt2')">mxCellState</a> of the cell to be handled.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.Variables"></a>Variables</h3></div></div>
2013-06-28 19:07:06 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.graph"></a>graph</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.graph</td></tr></table></blockquote><p>Reference to the enclosing <a href="../view/mxGraph-js.html#mxGraph" class=LClass id=link80 onMouseOver="ShowTip(event, 'tt4', 'link80')" onMouseOut="HideTip('tt4')">mxGraph</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-06-28 19:07:06 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.state"></a>state</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.state</td></tr></table></blockquote><p>Reference to the <a href="../view/mxCellState-js.html#mxCellState" class=LClass id=link81 onMouseOver="ShowTip(event, 'tt2', 'link81')" onMouseOut="HideTip('tt2')">mxCellState</a> being modified.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.marker"></a>marker</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.marker</td></tr></table></blockquote><p>Holds the &lt;mxTerminalMarker&gt; which is used for highlighting terminals.</p></div></div></div>
2013-06-28 19:07:06 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.constraintHandler"></a>constraintHandler</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.constraintHandler</td></tr></table></blockquote><p>Holds the <a href="mxConstraintHandler-js.html#mxConstraintHandler" class=LClass id=link82 onMouseOver="ShowTip(event, 'tt8', 'link82')" onMouseOut="HideTip('tt8')">mxConstraintHandler</a> used for drawing and highlighting constraints.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.error"></a>error</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.error</td></tr></table></blockquote><p>Holds the current validation error while a connection is being changed.</p></div></div></div>
2013-06-28 19:07:06 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.shape"></a>shape</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.shape</td></tr></table></blockquote><p>Holds the <a href="../shape/mxShape-js.html#mxShape" class=LClass id=link83 onMouseOver="ShowTip(event, 'tt11', 'link83')" onMouseOut="HideTip('tt11')">mxShape</a> that represents the preview edge.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-06-28 19:07:06 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.bends"></a>bends</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.bends</td></tr></table></blockquote><p>Holds the <a href="../shape/mxShape-js.html#mxShape" class=LClass id=link84 onMouseOver="ShowTip(event, 'tt11', 'link84')" onMouseOut="HideTip('tt11')">mxShapes</a> that represent the points.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-06-28 19:07:06 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.labelShape"></a>labelShape</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.labelShape</td></tr></table></blockquote><p>Holds the <a href="../shape/mxShape-js.html#mxShape" class=LClass id=link85 onMouseOver="ShowTip(event, 'tt11', 'link85')" onMouseOut="HideTip('tt11')">mxShape</a> that represents the label position.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.cloneEnabled"></a>cloneEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.cloneEnabled</td></tr></table></blockquote><p>Specifies if cloning by control-drag is enabled.&nbsp; Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.addEnabled"></a>addEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.addEnabled</td></tr></table></blockquote><p>Specifies if adding bends by shift-click is enabled.&nbsp; Default is false.&nbsp; Note: This experimental feature is not recommended for production use.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.removeEnabled"></a>removeEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.removeEnabled</td></tr></table></blockquote><p>Specifies if removing bends by shift-click is enabled.&nbsp; Default is false.&nbsp; Note: This experimental feature is not recommended for production use.</p></div></div></div>
2013-06-28 19:07:06 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.preferHtml"></a>preferHtml</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.preferHtml</td></tr></table></blockquote><p>Specifies if bends should be added to the graph container.&nbsp; This is updated in <a href="#mxEdgeHandler.init" class=LFunction id=link86 onMouseOver="ShowTip(event, 'tt24', 'link86')" onMouseOut="HideTip('tt24')">init</a> based on whether the edge or one of its terminals has an HTML label in the container.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.allowHandleBoundsCheck"></a>allowHandleBoundsCheck</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.allowHandleBoundsCheck</td></tr></table></blockquote><p>Specifies if the bounds of handles should be used for hit-detection in IE Default is true.</p></div></div></div>
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.snapToTerminals"></a>snapToTerminals</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.snapToTerminals</td></tr></table></blockquote><p>Specifies if waypoints should snap to the routing centers of terminals.&nbsp; Default is false.</p></div></div></div>
2013-06-28 19:07:06 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.handleImage"></a>handleImage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.handleImage</td></tr></table></blockquote><p>Optional <a href="../util/mxImage-js.html#mxImage" class=LClass id=link87 onMouseOver="ShowTip(event, 'tt21', 'link87')" onMouseOut="HideTip('tt21')">mxImage</a> to be used as handles.&nbsp; Default is null.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-06-28 19:07:06 +00:00
<div class="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.tolerance"></a>tolerance</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.tolerance</td></tr></table></blockquote><p>Optional tolerance for hit-detection in <a href="#mxEdgeHandler.getHandleForEvent" class=LFunction id=link88 onMouseOver="ShowTip(event, 'tt23', 'link88')" onMouseOut="HideTip('tt23')">getHandleForEvent</a>.&nbsp; Default is 0.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.init"></a>init</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.init = function()</td></tr></table></blockquote><p>Initializes the shapes required for this edge handler.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.isAddPointEvent"></a>isAddPointEvent</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>mxEdgeHandler.prototype.isAddPointEvent = function(</td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given event is a trigger to add a new point.&nbsp; This implementation returns true if shift is pressed.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.isRemovePointEvent"></a>isRemovePointEvent</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>mxEdgeHandler.prototype.isRemovePointEvent = function(</td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given event is a trigger to remove a point.&nbsp; This implementation returns true if shift is pressed.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.getSelectionPoints"></a>getSelectionPoints</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>mxEdgeHandler.prototype.getSelectionPoints = function(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the list of points that defines the selection stroke.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.createSelectionShape"></a>createSelectionShape</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>mxEdgeHandler.prototype.createSelectionShape = function(</td><td class=PParameter nowrap>points</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates the shape used to draw the selection border.</p></div></div></div>
2013-06-28 19:07:06 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.getSelectionColor"></a>getSelectionColor</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.getSelectionColor = function()</td></tr></table></blockquote><p>Returns <a href="../util/mxConstants-js.html#mxConstants.EDGE_SELECTION_COLOR" class=LVariable id=link89 onMouseOver="ShowTip(event, 'tt30', 'link89')" onMouseOut="HideTip('tt30')">mxConstants.EDGE_SELECTION_COLOR</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-06-28 19:07:06 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.getSelectionStrokeWidth"></a>getSelectionStrokeWidth</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.getSelectionStrokeWidth = function()</td></tr></table></blockquote><p>Returns <a href="../util/mxConstants-js.html#mxConstants.EDGE_SELECTION_STROKEWIDTH" class=LVariable id=link90 onMouseOver="ShowTip(event, 'tt32', 'link90')" onMouseOut="HideTip('tt32')">mxConstants.EDGE_SELECTION_STROKEWIDTH</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.isSelectionDashed"></a>isSelectionDashed</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.isSelectionDashed = function()</td></tr></table></blockquote><p>Returns &lt;mxConstants.EDGE_SELECTION_DASHED&gt;.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.isConnectableCell"></a>isConnectableCell</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>mxEdgeHandler.prototype.isConnectableCell = function(</td><td class=PParameter nowrap>cell</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given cell is connectable.&nbsp; This is a hook to disable floating connections.&nbsp; This implementation returns true.</p></div></div></div>
2013-06-28 19:07:06 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.createMarker"></a>createMarker</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.createMarker = function()</td></tr></table></blockquote><p>Creates and returns the <a href="mxCellMarker-js.html#mxCellMarker" class=LClass id=link91 onMouseOver="ShowTip(event, 'tt36', 'link91')" onMouseOut="HideTip('tt36')">mxCellMarker</a> used in <a href="#mxEdgeHandler.marker" class=LVariable id=link92 onMouseOver="ShowTip(event, 'tt6', 'link92')" onMouseOut="HideTip('tt6')">marker</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-06-28 19:07:06 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.validateConnection"></a>validateConnection</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>mxEdgeHandler.prototype.validateConnection = function(</td><td class=PParameter nowrap>source,</td></tr><tr><td></td><td class=PParameter nowrap>target</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the error message or an empty string if the connection for the given source, target pair is not valid.&nbsp; Otherwise it returns null.&nbsp; This implementation uses <a href="../view/mxGraph-js.html#mxGraph.getEdgeValidationError" class=LFunction id=link93 onMouseOver="ShowTip(event, 'tt70', 'link93')" onMouseOut="HideTip('tt70')">mxGraph.getEdgeValidationError</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>source</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link94 onMouseOver="ShowTip(event, 'tt71', 'link94')" onMouseOut="HideTip('tt71')">mxCell</a> that represents the source terminal.</td></tr><tr><td class=CDLEntry>target</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link95 onMouseOver="ShowTip(event, 'tt71', 'link95')" onMouseOut="HideTip('tt71')">mxCell</a> that represents the target terminal.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-06-28 19:07:06 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.createBends"></a>createBends</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.createBends = function()</td></tr></table></blockquote><p>Creates and returns the bends used for modifying the edge.&nbsp; This is typically an array of <a href="../shape/mxRectangleShape-js.html#mxRectangleShape" class=LClass id=link96 onMouseOver="ShowTip(event, 'tt72', 'link96')" onMouseOut="HideTip('tt72')">mxRectangleShapes</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.isHandleEnabled"></a>isHandleEnabled</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>mxEdgeHandler.prototype.isHandleEnabled = function(</td><td class=PParameter nowrap>index</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates the shape used to display the given bend.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.isHandleVisible"></a>isHandleVisible</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>mxEdgeHandler.prototype.isHandleVisible = function(</td><td class=PParameter nowrap>index</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the handle at the given index is visible.</p></div></div></div>
2013-06-28 19:07:06 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.createHandleShape"></a>createHandleShape</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>mxEdgeHandler.prototype.createHandleShape = function(</td><td class=PParameter nowrap>index</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Creates the shape used to display the given bend.&nbsp; Note that the index may be null for special cases, such as when called from <a href="mxElbowEdgeHandler-js.html#mxElbowEdgeHandler.createVirtualBend" class=LFunction id=link97 onMouseOver="ShowTip(event, 'tt73', 'link97')" onMouseOut="HideTip('tt73')">mxElbowEdgeHandler.createVirtualBend</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
2013-06-28 19:07:06 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.initBend"></a>initBend</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>mxEdgeHandler.prototype.initBend = function(</td><td class=PParameter nowrap>bend</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Helper method to initialize the given bend.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>bend</td><td class=CDLDescription><a href="../shape/mxShape-js.html#mxShape" class=LClass id=link98 onMouseOver="ShowTip(event, 'tt11', 'link98')" onMouseOut="HideTip('tt11')">mxShape</a> that represents the bend to be initialized.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.getHandleForEvent"></a>getHandleForEvent</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>mxEdgeHandler.prototype.getHandleForEvent = function(</td><td class=PParameter nowrap>me</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the index of the handle for the given event.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.mouseDown"></a>mouseDown</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>mxEdgeHandler.prototype.mouseDown = function(</td><td class=PParameter nowrap>sender,</td></tr><tr><td></td><td class=PParameter nowrap>me</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Handles the event by checking if a special element of the handler was clicked, in which case the index parameter is non-null.&nbsp; The indices may be one of &lt;LABEL_HANDLE&gt; or the number of the respective control point.&nbsp; The source and target points are used for reconnecting the edge.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.start"></a>start</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>mxEdgeHandler.prototype.start = function(</td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y,</td></tr><tr><td></td><td class=PParameter nowrap>index</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Starts the handling of the mouse gesture.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.clonePreviewState"></a>clonePreviewState</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>mxEdgeHandler.prototype.clonePreviewState = function(</td><td class=PParameter nowrap>point,</td></tr><tr><td></td><td class=PParameter nowrap>terminal</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns a clone of the current preview state for the given point and terminal.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.getSnapToTerminalTolerance"></a>getSnapToTerminalTolerance</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.getSnapToTerminalTolerance = function()</td></tr></table></blockquote><p>Returns the tolerance for the guides.&nbsp; Default value is gridSize * scale / 2.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.getPointForEvent"></a>getPointForEvent</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>mxEdgeHandler.prototype.getPointForEvent = function(</td><td class=PParameter nowrap>me</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the point for the given event.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.getPreviewTerminalState"></a>getPreviewTerminalState</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>mxEdgeHandler.prototype.getPreviewTerminalState = function(</td><td class=PParameter nowrap>me</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the given preview state taking into account the state of the constraint handler.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.getPreviewPoints"></a>getPreviewPoints</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>mxEdgeHandler.prototype.getPreviewPoints = function(</td><td class=PParameter nowrap>point</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the given preview state taking into account the state of the constraint handler.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.updatePreviewState"></a>updatePreviewState</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>mxEdgeHandler.prototype.updatePreviewState = function(</td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>point,</td></tr><tr><td></td><td class=PParameter nowrap>terminalState</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the given preview state taking into account the state of the constraint handler.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.mouseMove"></a>mouseMove</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>mxEdgeHandler.prototype.mouseMove = function(</td><td class=PParameter nowrap>sender,</td></tr><tr><td></td><td class=PParameter nowrap>me</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Handles the event by updating the preview.</p></div></div></div>
2013-06-28 19:07:06 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.mouseUp"></a>mouseUp</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>mxEdgeHandler.prototype.mouseUp = function(</td><td class=PParameter nowrap>sender,</td></tr><tr><td></td><td class=PParameter nowrap>me</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Handles the event to applying the previewed changes on the edge by using <a href="#mxEdgeHandler.moveLabel" class=LFunction id=link99 onMouseOver="ShowTip(event, 'tt53', 'link99')" onMouseOut="HideTip('tt53')">moveLabel</a>, <a href="#mxEdgeHandler.connect" class=LFunction id=link100 onMouseOver="ShowTip(event, 'tt54', 'link100')" onMouseOut="HideTip('tt54')">connect</a> or <a href="#mxEdgeHandler.changePoints" class=LFunction id=link101 onMouseOver="ShowTip(event, 'tt55', 'link101')" onMouseOut="HideTip('tt55')">changePoints</a>.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.reset"></a>reset</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.reset = function()</td></tr></table></blockquote><p>Resets the state of this handler.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.setPreviewColor"></a>setPreviewColor</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>mxEdgeHandler.prototype.setPreviewColor = function(</td><td class=PParameter nowrap>color</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Sets the color of the preview to the given value.</p></div></div></div>
2013-06-28 19:07:06 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.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>mxEdgeHandler.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.&nbsp; Returns the given, modified point instance.</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=link102 onMouseOver="ShowTip(event, 'tt74', 'link102')" onMouseOut="HideTip('tt74')">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>
2012-05-21 20:32:26 +00:00
2013-06-28 19:07:06 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.moveLabel"></a>moveLabel</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>mxEdgeHandler.prototype.moveLabel = function(</td><td class=PParameter nowrap>edgeState,</td></tr><tr><td></td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Changes the coordinates for the label of the given edge.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link103 onMouseOver="ShowTip(event, 'tt71', 'link103')" onMouseOut="HideTip('tt71')">mxCell</a> that represents the edge.</td></tr><tr><td class=CDLEntry>x</td><td class=CDLDescription>Integer that specifies the x-coordinate of the new location.</td></tr><tr><td class=CDLEntry>y</td><td class=CDLDescription>Integer that specifies the y-coordinate of the new location.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
2013-06-28 19:07:06 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.connect"></a>connect</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>mxEdgeHandler.prototype.connect = function(</td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>terminal,</td></tr><tr><td></td><td class=PParameter nowrap>isSource,</td></tr><tr><td></td><td class=PParameter nowrap>isClone,</td></tr><tr><td></td><td class=PParameter nowrap>me</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Changes the terminal or terminal point of the given edge in the graph model.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>edge</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link104 onMouseOver="ShowTip(event, 'tt71', 'link104')" onMouseOut="HideTip('tt71')">mxCell</a> that represents the edge to be reconnected.</td></tr><tr><td class=CDLEntry>terminal</td><td class=CDLDescription><a href="../model/mxCell-js.html#mxCell" class=LClass id=link105 onMouseOver="ShowTip(event, 'tt71', 'link105')" onMouseOut="HideTip('tt71')">mxCell</a> that represents the new terminal.</td></tr><tr><td class=CDLEntry>isSource</td><td class=CDLDescription>Boolean indicating if the new terminal is the source or target terminal.</td></tr><tr><td class=CDLEntry>isClone</td><td class=CDLDescription>Boolean indicating if the new connection should be a clone of the old edge.</td></tr><tr><td class=CDLEntry>me</td><td class=CDLDescription><a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link106 onMouseOver="ShowTip(event, 'tt75', 'link106')" onMouseOut="HideTip('tt75')">mxMouseEvent</a> that contains the mouse up event.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.changeTerminalPoint"></a>changeTerminalPoint</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>mxEdgeHandler.prototype.changeTerminalPoint = function(</td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>point,</td></tr><tr><td></td><td class=PParameter nowrap>isSource</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Changes the terminal point of the given edge.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.changePoints"></a>changePoints</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>mxEdgeHandler.prototype.changePoints = function(</td><td class=PParameter nowrap>edge,</td></tr><tr><td></td><td class=PParameter nowrap>points</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Changes the control points of the given edge in the graph model.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.addPoint"></a>addPoint</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>mxEdgeHandler.prototype.addPoint = function(</td><td class=PParameter nowrap>state,</td></tr><tr><td></td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds a control point for the given state and event.</p></div></div></div>
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.addPointAt"></a>addPointAt</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>mxEdgeHandler.prototype.addPointAt = function(</td><td class=PParameter nowrap>state,</td></tr><tr><td></td><td class=PParameter nowrap>x,</td></tr><tr><td></td><td class=PParameter nowrap>y</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Adds a control point at the given point.</p></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.removePoint"></a>removePoint</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>mxEdgeHandler.prototype.removePoint = function(</td><td class=PParameter nowrap>state,</td></tr><tr><td></td><td class=PParameter nowrap>index</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Removes the control point at the given index from the given state.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.getHandleFillColor"></a>getHandleFillColor</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>mxEdgeHandler.prototype.getHandleFillColor = function(</td><td class=PParameter nowrap>index</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the fillcolor for the handle at the given index.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.redraw"></a>redraw</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.redraw = function()</td></tr></table></blockquote><p>Redraws the preview, and the bends- and label control points.</p></div></div></div>
2013-05-23 16:14:48 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.redrawHandles"></a>redrawHandles</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.redrawHandles = function()</td></tr></table></blockquote><p>Redraws the handles.</p></div></div></div>
2013-06-28 19:07:06 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.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>mxEdgeHandler.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=link107 onMouseOver="ShowTip(event, 'tt74', 'link107')" onMouseOut="HideTip('tt74')">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=link108 onMouseOver="ShowTip(event, 'tt74', 'link108')" onMouseOut="HideTip('tt74')">mxPoint</a> that represents the location of the last point.</td></tr></table></div></div></div>
2012-05-21 20:32:26 +00:00
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.drawPreview"></a>drawPreview</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.drawPreview = function()</td></tr></table></blockquote><p>Redraws the preview.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mxEdgeHandler.destroy"></a>destroy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.destroy = function()</td></tr></table></blockquote><p>Destroys the handler and all its resources and DOM nodes.&nbsp; This does normally not need to be called as handlers are destroyed automatically when the corresponding cell is deselected.</p></div></div></div>
</div><!--Content-->
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
2013-12-09 08:35:20 +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 id=MSelected>mxEdgeHandler</div></div><div class=MEntry><div class=MFile><a href="mxEdgeSegmentHandler-js.html">mxEdgeSegmentHandler.js</a></div></div><div class=MEntry><div class=MFile><a href="mxElbowEdgeHandler-js.html">mxElbowEdgeHandler</a></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">mxRootChang
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-->
2013-06-28 19:07:06 +00:00
<div class=CToolTip id="tt1"><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>function mxEdgeHandler(</td><td class=PParameter nowrap>state</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Constructs an edge handler for the specified mxCellState.</div></div><div class=CToolTip id="tt2"><div class=CClass>Represents the current state of a cell in a given mxGraphView.</div></div><div class=CToolTip id="tt3"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.graph</td></tr></table></blockquote>Reference to the enclosing mxGraph.</div></div><div class=CToolTip id="tt4"><div class=CClass>Extends mxEventSource to implement a graph component for the browser. </div></div><div class=CToolTip id="tt5"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.state</td></tr></table></blockquote>Reference to the mxCellState being modified.</div></div><div class=CToolTip id="tt6"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.marker</td></tr></table></blockquote>Holds the mxTerminalMarker which is used for highlighting terminals.</div></div><div class=CToolTip id="tt7"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.constraintHandler</td></tr></table></blockquote>Holds the mxConstraintHandler used for drawing and highlighting constraints.</div></div><div class=CToolTip id="tt8"><div class=CClass>Handles constraints on connection targets. </div></div><div class=CToolTip id="tt9"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.error</td></tr></table></blockquote>Holds the current validation error while a connection is being changed.</div></div><div class=CToolTip id="tt10"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.shape</td></tr></table></blockquote>Holds the mxShape that represents the preview edge.</div></div><div class=CToolTip id="tt11"><div class=CClass>Base class for all shapes. </div></div><div class=CToolTip id="tt12"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.bends</td></tr></table></blockquote>Holds the mxShapes that represent the points.</div></div><div class=CToolTip id="tt13"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.labelShape</td></tr></table></blockquote>Holds the mxShape that represents the label position.</div></div><div class=CToolTip id="tt14"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.cloneEnabled</td></tr></table></blockquote>Specifies if cloning by control-drag is enabled. </div></div><div class=CToolTip id="tt15"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.addEnabled</td></tr></table></blockquote>Specifies if adding bends by shift-click is enabled. </div></div><div class=CToolTip id="tt16"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.removeEnabled</td></tr></table></blockquote>Specifies if removing bends by shift-click is enabled. </div></div><div class=CToolTip id="tt17"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype prettyprint"><tr><td>mxEdgeHandler.prototype.preferHtml</td></tr><
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>