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

89 lines
54 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>mxConstraintHandler</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 -->
3.7.0.1 release
2017-01-29 09:00:22 +00:00
<div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="mxConstraintHandler"></a>mxConstraintHandler</h1><div class=CBody><p>Handles constraints on connection targets.&nbsp; This class is in charge of showing fixed points when the mouse is over a vertex and handles constraints to establish new connections.</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="#mxConstraintHandler" >mxConstraintHandler</a></td><td class=SDescription>Handles constraints on connection targets. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxConstraintHandler.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxConstraintHandler.mxConstraintHandler" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">mxConstraintHandler</a></td><td class=SDescription>Constructs an new constraint handler.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxConstraintHandler.Variables" >Variables</a></td><td class=SDescription></td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxConstraintHandler.pointImage" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">pointImage</a></td><td class=SDescription><a href="../util/mxImage-js.html#mxImage" class=LClass id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">mxImage</a> to be used as the image for fixed connection points.</td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxConstraintHandler.graph" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">graph</a></td><td class=SDescription>Reference to the enclosing <a href="../view/mxGraph-js.html#mxGraph" class=LClass id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">mxGraph</a>.</td></tr><tr class="SVariable SIndent2 SMarked"><td class=SEntry><a href="#mxConstraintHandler.enabled" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">enabled</a></td><td class=SDescription>Specifies if events are handled. </td></tr><tr class="SVariable SIndent2"><td class=SEntry><a href="#mxConstraintHandler.highlightColor" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">highlightColor</a></td><td class=SDescription>Specifies the color for the highlight. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#mxConstraintHandler.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxConstraintHandler.isEnabled" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">isEnabled</a></td><td class=SDescription>Returns true if events are handled. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mxConstraintHandler.setEnabled" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">setEnabled</a></td><td class=SDescription>Enables or disables event handling. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxConstraintHandler.reset" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">reset</a></td><td class=SDescription>Resets the state of this handler.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mxConstraintHandler.getTolerance" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">getTolerance</a></td><td class=SDescription>Returns the tolerance to be used for intersecting connection points. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mxConstraintHandler.getImageForConstraint" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">getImageForConstraint</a></td><td class=SDescription>Returns the tolerance to be used for in
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="mxConstraintHandler.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="mxConstraintHandler.mxConstraintHandler"></a>mxConstraintHandler</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 mxConstraintHandler(</td><td class="PParameter prettyprint " nowrap>graph</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs an new constraint handler.</p><h4 class=CHeading>Parameters</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=link28 onMouseOver="ShowTip(event, 'tt5', 'link28')" onMouseOut="HideTip('tt5')">mxGraph</a>.</td></tr><tr><td class=CDLEntry>factoryMethod</td><td class=CDLDescription>Optional function to create the edge.&nbsp; The function takes the source and target <a href="../model/mxCell-js.html#mxCell" class=LClass id=link29 onMouseOver="ShowTip(event, 'tt26', 'link29')" onMouseOut="HideTip('tt26')">mxCell</a> as the first and second argument and returns the <a href="../model/mxCell-js.html#mxCell" class=LClass id=link30 onMouseOver="ShowTip(event, 'tt26', 'link30')" onMouseOut="HideTip('tt26')">mxCell</a> that represents the new edge.</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="mxConstraintHandler.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="mxConstraintHandler.pointImage"></a>pointImage</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConstraintHandler.prototype.pointImage</td></tr></table></blockquote><p><a href="../util/mxImage-js.html#mxImage" class=LClass id=link31 onMouseOver="ShowTip(event, 'tt3', 'link31')" onMouseOut="HideTip('tt3')">mxImage</a> to be used as the image for fixed connection points.</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="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxConstraintHandler.graph"></a>graph</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConstraintHandler.prototype.graph</td></tr></table></blockquote><p>Reference to the enclosing <a href="../view/mxGraph-js.html#mxGraph" class=LClass id=link32 onMouseOver="ShowTip(event, 'tt5', 'link32')" onMouseOut="HideTip('tt5')">mxGraph</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="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxConstraintHandler.enabled"></a>enabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConstraintHandler.prototype.enabled</td></tr></table></blockquote><p>Specifies if events are handled.&nbsp; Default is true.</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="CVariable"><div class=CTopic><h3 class=CTitle><a name="mxConstraintHandler.highlightColor"></a>highlightColor</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConstraintHandler.prototype.highlightColor</td></tr></table></blockquote><p>Specifies the color for the highlight.&nbsp; Default is <a href="../util/mxConstants-js.html#mxConstants.DEFAULT_VALID_COLOR" class=LVariable id=link33 onMouseOver="ShowTip(event, 'tt27', 'link33')" onMouseOut="HideTip('tt27')">mxConstants.DEFAULT_VALID_COLOR</a>.</p></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="mxConstraintHandler.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="mxConstraintHandler.isEnabled"></a>isEnabled</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConstraintHandler.prototype.isEnabled = function()</td></tr></table></blockquote><p>Returns true if events are handled.&nbsp; This implementation returns <a href="#mxConstraintHandler.enabled" class=LVariable id=link34 onMouseOver="ShowTip(event, 'tt6', 'link34')" onMouseOut="HideTip('tt6')">enabled</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="mxConstraintHandler.setEnabled"></a>setEnabled</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>mxConstraintHandler.prototype.setEnabled = function(</td><td class="PParameter prettyprint " nowrap>enabled</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Enables or disables event handling.&nbsp; This implementation updates <a href="#mxConstraintHandler.enabled" class=LVariable id=link35 onMouseOver="ShowTip(event, 'tt6', 'link35')" onMouseOut="HideTip('tt6')">enabled</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>enabled</td><td class=CDLDescription>Boolean that specifies the new enabled state.</td></tr></table></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="mxConstraintHandler.reset"></a>reset</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConstraintHandler.prototype.reset = function()</td></tr></table></blockquote><p>Resets the state of this handler.</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="mxConstraintHandler.getTolerance"></a>getTolerance</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>mxConstraintHandler.prototype.getTolerance = function(</td><td class="PParameter prettyprint " nowrap>me</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the tolerance to be used for intersecting connection points.&nbsp; This implementation returns <a href="../view/mxGraph-js.html#mxGraph.tolerance" class=LVariable id=link36 onMouseOver="ShowTip(event, 'tt28', 'link36')" onMouseOut="HideTip('tt28')">mxGraph.tolerance</a>.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>me</td><td class=CDLDescription><a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link37 onMouseOver="ShowTip(event, 'tt14', 'link37')" onMouseOut="HideTip('tt14')">mxMouseEvent</a> whose tolerance should be returned.</td></tr></table></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="mxConstraintHandler.getImageForConstraint"></a>getImageForConstraint</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>mxConstraintHandler.prototype.getImageForConstraint = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>constraint,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>point</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the tolerance to be used for intersecting connection points.</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="mxConstraintHandler.isEventIgnored"></a>isEventIgnored</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>mxConstraintHandler.prototype.isEventIgnored = function(</td><td class="PParameter prettyprint " nowrap>me,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>source</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given <a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link38 onMouseOver="ShowTip(event, 'tt14', 'link38')" onMouseOut="HideTip('tt14')">mxMouseEvent</a> should be ignored in <a href="#mxConstraintHandler.update" class=LFunction id=link39 onMouseOver="ShowTip(event, 'tt15', 'link39')" onMouseOut="HideTip('tt15')">update</a>.&nbsp; This implementation always returns false.</p></div></div></div>
1.10.4.1 release
2012-12-18 13:09:38 +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="mxConstraintHandler.isStateIgnored"></a>isStateIgnored</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>mxConstraintHandler.prototype.isStateIgnored = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>source</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given state should be ignored.&nbsp; This always returns false.</p></div></div></div>
1.13.0.0 release
2013-05-03 13:17:05 +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="mxConstraintHandler.destroyIcons"></a>destroyIcons</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConstraintHandler.prototype.destroyIcons = function()</td></tr></table></blockquote><p>Destroys the &lt;focusIcons&gt; if they exist.</p></div></div></div>
2.0.0.1 release
2013-05-23 16:14:48 +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="mxConstraintHandler.destroyFocusHighlight"></a>destroyFocusHighlight</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConstraintHandler.prototype.destroyFocusHighlight = function()</td></tr></table></blockquote><p>Destroys the &lt;focusHighlight&gt; if one exists.</p></div></div></div>
2.0.0.1 release
2013-05-23 16:14:48 +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="mxConstraintHandler.isKeepFocusEvent"></a>isKeepFocusEvent</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>mxConstraintHandler.prototype.isKeepFocusEvent = function(</td><td class="PParameter prettyprint " nowrap>me</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the current focused state should not be changed for the given event.&nbsp; This returns true if shift and alt are pressed.</p></div></div></div>
3.1.2.1 release
2015-01-05 14:01:01 +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="mxConstraintHandler.getCellForEvent"></a>getCellForEvent</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>mxConstraintHandler.prototype.getCellForEvent = function(</td><td class="PParameter prettyprint " nowrap>me,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>point</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the cell for the given event.</p></div></div></div>
3.3.1.0 release
2015-06-18 15:23:41 +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="mxConstraintHandler.update"></a>update</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>mxConstraintHandler.prototype.update = function(</td><td class="PParameter prettyprint " nowrap>me,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>source,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>existingEdge,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>point</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Updates the state of this handler based on the given <a href="../util/mxMouseEvent-js.html#mxMouseEvent" class=LClass id=link40 onMouseOver="ShowTip(event, 'tt14', 'link40')" onMouseOut="HideTip('tt14')">mxMouseEvent</a>.&nbsp; Source is a boolean indicating if the cell is a source or target.</p></div></div></div>
3.7.0.1 release
2017-01-29 09:00:22 +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="mxConstraintHandler.redraw"></a>redraw</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConstraintHandler.prototype.redraw = function()</td></tr></table></blockquote><p>Transfers the focus to the given state as a source or target terminal.&nbsp; If the handler is not enabled then the outline is painted, but the constraints are ignored.</p></div></div></div>
3.4.0.0 release
2015-08-28 13:41:48 +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="mxConstraintHandler.setFocus"></a>setFocus</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>mxConstraintHandler.prototype.setFocus = function(</td><td class="PParameter prettyprint " nowrap>me,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>source</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Transfers the focus to the given state as a source or target terminal.&nbsp; If the handler is not enabled then the outline is painted, but the constraints are ignored.</p></div></div></div>
3.4.1.0 release
2015-12-11 09:22:19 +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="mxConstraintHandler.createHighlightShape"></a>createHighlightShape</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConstraintHandler.prototype.createHighlightShape = function()</td></tr></table></blockquote><p>Create the shape used to paint the highlight.</p><p>Returns true if the given icon intersects the given point.</p></div></div></div>
3.4.1.0 release
2015-12-11 09:22:19 +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="mxConstraintHandler.intersects"></a>intersects</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>mxConstraintHandler.prototype.intersects = function(</td><td class="PParameter prettyprint " nowrap>icon,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>mouse,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>source,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>existingEdge</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns true if the given icon intersects the given rectangle.</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="mxConstraintHandler.destroy"></a>destroy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConstraintHandler.prototype.destroy = function()</td></tr></table></blockquote><p>Destroy this handler.</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="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 id=MSelected>mxConstraintHandler</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><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="mxHandle-js.html">mxHandle</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">mxPopupMenuHandler</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 c
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([2], 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 mxConstraintHandler(</td><td class="PParameter prettyprint " nowrap>graph</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Constructs an new constraint handler.</div></div><div class=CToolTip id="tt2"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConstraintHandler.prototype.pointImage</td></tr></table></blockquote>mxImage to be used as the image for fixed connection points.</div></div><div class=CToolTip id="tt3"><div class=CClass>Encapsulates the URL, width and height of an image.</div></div><div class=CToolTip id="tt4"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConstraintHandler.prototype.graph</td></tr></table></blockquote>Reference to the enclosing mxGraph.</div></div><div class=CToolTip id="tt5"><div class=CClass>Extends mxEventSource to implement a graph component for the browser. </div></div><div class=CToolTip id="tt6"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConstraintHandler.prototype.enabled</td></tr></table></blockquote>Specifies if events are handled. </div></div><div class=CToolTip id="tt7"><div class=CVariable><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConstraintHandler.prototype.highlightColor</td></tr></table></blockquote>Specifies the color for the highlight. </div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConstraintHandler.prototype.isEnabled = function()</td></tr></table></blockquote>Returns true if events are handled. </div></div><div class=CToolTip id="tt9"><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>mxConstraintHandler.prototype.setEnabled = function(</td><td class="PParameter prettyprint " nowrap>enabled</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Enables or disables event handling. </div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mxConstraintHandler.prototype.reset = function()</td></tr></table></blockquote>Resets the state of this handler.</div></div><div class=CToolTip id="tt11"><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>mxConstraintHandler.prototype.getTolerance = function(</td><td class="PParameter prettyprint " nowrap>me</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Returns the tolerance to be used for intersecting connection points. </div></div><div class=CToolTip id="tt12"><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>mxConstraintHandler.prototype.getImageForConstraint = function(</td><td class="PParameter prettyprint " nowrap>state,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>constraint,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>point</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Returns the tolerance to be used for intersecting connection points.</div></div><div class=CToolTip id="tt13"><di
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>