<!-- saved from url=(0026)http://www.naturaldocs.org -->
<divid=Content><divclass="CClass"><divclass=CTopicid=MainTopic><h1class=CTitle><aname="mxTooltipHandler"></a>mxTooltipHandler</h1><divclass=CBody><p>Graph event handler that displays tooltips. <ahref="../view/mxGraph-js.html#mxGraph.getTooltip"class=LFunctionid=link29onMouseOver="ShowTip(event, 'tt26', 'link29')"onMouseOut="HideTip('tt26')">mxGraph.getTooltip</a> is used to get the tooltip for a cell or handle. This handler is built-into <mxGraph.tooltipHandler> and enabled using <ahref="../view/mxGraph-js.html#mxGraph.setTooltips"class=LFunctionid=link30onMouseOver="ShowTip(event, 'tt27', 'link30')"onMouseOut="HideTip('tt27')">mxGraph.setTooltips</a>.</p><h4class=CHeading>Example</h4><p>(code> new mxTooltipHandler(graph); (end)</p><!--START_ND_SUMMARY--><divclass=Summary><divclass=STitle>Summary</div><divclass=SBorder><tableborder=0cellspacing=0cellpadding=0class=STable><trclass="SMain"><tdclass=SEntry><ahref="#mxTooltipHandler">mxTooltipHandler</a></td><tdclass=SDescription>Graph event handler that displays tooltips. </td></tr><trclass="SGroup SIndent1"><tdclass=SEntry><ahref="#mxTooltipHandler.Functions">Functions</a></td><tdclass=SDescription></td></tr><trclass="SFunction SIndent2 SMarked"><tdclass=SEntry><ahref="#mxTooltipHandler.mxTooltipHandler"id=link1onMouseOver="ShowTip(event, 'tt1', 'link1')"onMouseOut="HideTip('tt1')">mxTooltipHandler</a></td><tdclass=SDescription>Constructs an event handler that displays tooltips with the specified delay (in milliseconds). </td></tr><trclass="SGroup SIndent1"><tdclass=SEntry><ahref="#mxTooltipHandler.Variables">Variables</a></td><tdclass=SDescription></td></tr><trclass="SVariable SIndent2 SMarked"><tdclass=SEntry><ahref="#mxTooltipHandler.zIndex"id=link2onMouseOver="ShowTip(event, 'tt2', 'link2')"onMouseOut="HideTip('tt2')">zIndex</a></td><tdclass=SDescription>Specifies the zIndex for the tooltip and its shadow. </td></tr><trclass="SVariable SIndent2"><tdclass=SEntry><ahref="#mxTooltipHandler.graph"id=link3onMouseOver="ShowTip(event, 'tt3', 'link3')"onMouseOut="HideTip('tt3')">graph</a></td><tdclass=SDescription>Reference to the enclosing <ahref="../view/mxGraph-js.html#mxGraph"class=LClassid=link4onMouseOver="ShowTip(event, 'tt4', 'link4')"onMouseOut="HideTip('tt4')">mxGraph</a>.</td></tr><trclass="SVariable SIndent2 SMarked"><tdclass=SEntry><ahref="#mxTooltipHandler.delay"id=link5onMouseOver="ShowTip(event, 'tt5', 'link5')"onMouseOut="HideTip('tt5')">delay</a></td><tdclass=SDescription>Delay to show the tooltip in milliseconds. </td></tr><trclass="SVariable SIndent2"><tdclass=SEntry><ahref="#mxTooltipHandler.ignoreTouchEvents"id=link6onMouseOver="ShowTip(event, 'tt6', 'link6')"onMouseOut="HideTip('tt6')">ignoreTouchEvents</a></td><tdclass=SDescription>Specifies if touch and pen events should be ignored. </td></tr><trclass="SVariable SIndent2 SMarked"><tdclass=SEntry><ahref="#mxTooltipHandler.hideOnHover"id=link7onMouseOver="ShowTip(event, 'tt7', 'link7')"onMouseOut="HideTip('tt7')">hideOnHover</a></td><tdclass=SDescription>Specifies if the tooltip should be hidden if the mouse is moved over the current cell. </td></tr><trclass="SVariable SIndent2"><tdclass=SEntry><ahref="#mxTooltipHandler.destroyed"id=link8onMouseOver="ShowTip(event, 'tt8', 'link8')"onMouseOut="HideTip('tt8')">destroyed</a></td><tdclass=SDescription>True if this handler was destroyed using <ahref="#mxTooltipHandler.destroy"class=LFunctionid=link9onMouseOver="ShowTip(event, 'tt9', 'link9')"onMouseOut="HideTip('tt9')">destroy</a>.</td></tr><trclass="SVariable SIndent2 SMarked"><tdclass=SEntry><ahref="#mxTooltipHandler.enabled"id=link10onMouseOver="ShowTip(event, 'tt10', 'link10')"onMouseOut="HideTip('tt10')">enabled</a></td><tdclass=SDescription>Specifies if events are handled. </td></tr><trclass="SGroup SIndent1"><tdclass=SEntry><ahref="#mxTooltipHandler.Functions">Functions</a></td><tdclass=SDescription></td></tr><trclass="SFunction SIndent2 SMarked"><tdclass=SEntry><ahref
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.mxTooltipHandler"></a>mxTooltipHandler</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass="PBeforeParameters prettyprint "nowrap>function mxTooltipHandler(</td><tdclass="PParameter prettyprint "nowrap>graph,</td></tr><tr><td></td><tdclass="PParameter prettyprint "nowrap>delay</td><tdclass="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs an event handler that displays tooltips with the specified delay (in milliseconds). If no delay is specified then a default delay of 500 ms (0.5 sec) is used.</p><h4class=CHeading>Parameters</h4><tableborder=0cellspacing=0cellpadding=0class=CDescriptionList><tr><tdclass=CDLEntry>graph</td><tdclass=CDLDescription>Reference to the enclosing <ahref="../view/mxGraph-js.html#mxGraph"class=LClassid=link31onMouseOver="ShowTip(event, 'tt4', 'link31')"onMouseOut="HideTip('tt4')">mxGraph</a>.</td></tr><tr><tdclass=CDLEntry>delay</td><tdclass=CDLDescription>Optional delay in milliseconds.</td></tr></table></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.zIndex"></a>zIndex</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.zIndex</td></tr></table></blockquote><p>Specifies the zIndex for the tooltip and its shadow. Default is 10005.</p></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.graph"></a>graph</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.graph</td></tr></table></blockquote><p>Reference to the enclosing <ahref="../view/mxGraph-js.html#mxGraph"class=LClassid=link32onMouseOver="ShowTip(event, 'tt4', 'link32')"onMouseOut="HideTip('tt4')">mxGraph</a>.</p></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.delay"></a>delay</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.delay</td></tr></table></blockquote><p>Delay to show the tooltip in milliseconds. Default is 500.</p></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.ignoreTouchEvents"></a>ignoreTouchEvents</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.ignoreTouchEvents</td></tr></table></blockquote><p>Specifies if touch and pen events should be ignored. Default is true.</p></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.hideOnHover"></a>hideOnHover</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.hideOnHover</td></tr></table></blockquote><p>Specifies if the tooltip should be hidden if the mouse is moved over the current cell. Default is false.</p></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.destroyed"></a>destroyed</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.destroyed</td></tr></table></blockquote><p>True if this handler was destroyed using <ahref="#mxTooltipHandler.destroy"class=LFunctionid=link33onMouseOver="ShowTip(event, 'tt9', 'link33')"onMouseOut="HideTip('tt9')">destroy</a>.</p></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.enabled"></a>enabled</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.enabled</td></tr></table></blockquote><p>Specifies if events are handled. Default is true.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.isEnabled"></a>isEnabled</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.isEnabled = function()</td></tr></table></blockquote><p>Returns true if events are handled. This implementation returns <ahref="#mxTooltipHandler.enabled"class=LVariableid=link34onMouseOver="ShowTip(event, 'tt10', 'link34')"onMouseOut="HideTip('tt10')">enabled</a>.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.setEnabled"></a>setEnabled</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass="PBeforeParameters prettyprint "nowrap>mxTooltipHandler.prototype.setEnabled = function(</td><tdclass="PParameter prettyprint "nowrap>enabled</td><tdclass="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Enables or disables event handling. This implementation updates <ahref="#mxTooltipHandler.enabled"class=LVariableid=link35onMouseOver="ShowTip(event, 'tt10', 'link35')"onMouseOut="HideTip('tt10')">enabled</a>.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.init"></a>init</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.init = function()</td></tr></table></blockquote><p>Initializes the DOM nodes required for this tooltip handler.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.getStateForEvent"></a>getStateForEvent</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass="PBeforeParameters prettyprint "nowrap>mxTooltipHandler.prototype.getStateForEvent = function(</td><tdclass="PParameter prettyprint "nowrap>me</td><tdclass="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the <ahref="../view/mxCellState-js.html#mxCellState"class=LClassid=link38onMouseOver="ShowTip(event, 'tt17', 'link38')"onMouseOut="HideTip('tt17')">mxCellState</a> to be used for showing a tooltip for this event.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.mouseDown"></a>mouseDown</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass="PBeforeParameters prettyprint "nowrap>mxTooltipHandler.prototype.mouseDown = function(</td><tdclass="PParameter prettyprint "nowrap>sender,</td></tr><tr><td></td><tdclass="PParameter prettyprint "nowrap>me</td><tdclass="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Handles the event by initiating a rubberband selection. By consuming the event all subsequent events of the gesture are redirected to this handler.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.mouseMove"></a>mouseMove</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass="PBeforeParameters prettyprint "nowrap>mxTooltipHandler.prototype.mouseMove = function(</td><tdclass="PParameter prettyprint "nowrap>sender,</td></tr><tr><td></td><tdclass="PParameter prettyprint "nowrap>me</td><tdclass="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Handles the event by updating the rubberband selection.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.mouseUp"></a>mouseUp</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass="PBeforeParameters prettyprint "nowrap>mxTooltipHandler.prototype.mouseUp = function(</td><tdclass="PParameter prettyprint "nowrap>sender,</td></tr><tr><td></td><tdclass="PParameter prettyprint "nowrap>me</td><tdclass="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Handles the event by resetting the tooltip timer or hiding the existing tooltip.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.resetTimer"></a>resetTimer</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.resetTimer = function()</td></tr></table></blockquote><p>Resets the timer.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.reset"></a>reset</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass="PBeforeParameters prettyprint "nowrap>mxTooltipHandler.prototype.reset = function(</td><tdclass="PParameter prettyprint "nowrap>me,</td></tr><tr><td></td><tdclass="PParameter prettyprint "nowrap>restart,</td></tr><tr><td></td><tdclass="PParameter prettyprint "nowrap>state</td><tdclass="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Resets and/or restarts the timer to trigger the display of the tooltip.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.hide"></a>hide</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.hide = function()</td></tr></table></blockquote><p>Hides the tooltip and resets the timer.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.hideTooltip"></a>hideTooltip</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.hideTooltip = function()</td></tr></table></blockquote><p>Hides the tooltip.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.show"></a>show</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass="PBeforeParameters prettyprint "nowrap>mxTooltipHandler.prototype.show = function(</td><tdclass="PParameter prettyprint "nowrap>tip,</td></tr><tr><td></td><tdclass="PParameter prettyprint "nowrap>x,</td></tr><tr><td></td><tdclass="PParameter prettyprint "nowrap>y</td><tdclass="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Shows the tooltip for the specified cell and optional index at the specified location (with a vertical offset of 10 pixels).</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxTooltipHandler.destroy"></a>destroy</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.destroy = function()</td></tr></table></blockquote><p>Destroys the handler and all its resources and DOM nodes.</p></div></div></div>
</div><!--Content-->
<divid=Footer><ahref="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
<divclass=CToolTipid="tt1"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass="PBeforeParameters prettyprint "nowrap>function mxTooltipHandler(</td><tdclass="PParameter prettyprint "nowrap>graph,</td></tr><tr><td></td><tdclass="PParameter prettyprint "nowrap>delay</td><tdclass="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Constructs an event handler that displays tooltips with the specified delay (in milliseconds). </div></div><divclass=CToolTipid="tt2"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.zIndex</td></tr></table></blockquote>Specifies the zIndex for the tooltip and its shadow. </div></div><divclass=CToolTipid="tt3"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.graph</td></tr></table></blockquote>Reference to the enclosing mxGraph.</div></div><divclass=CToolTipid="tt4"><divclass=CClass>Extends mxEventSource to implement a graph component for the browser. </div></div><divclass=CToolTipid="tt5"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.delay</td></tr></table></blockquote>Delay to show the tooltip in milliseconds. </div></div><divclass=CToolTipid="tt6"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.ignoreTouchEvents</td></tr></table></blockquote>Specifies if touch and pen events should be ignored. </div></div><divclass=CToolTipid="tt7"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.hideOnHover</td></tr></table></blockquote>Specifies if the tooltip should be hidden if the mouse is moved over the current cell. </div></div><divclass=CToolTipid="tt8"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.destroyed</td></tr></table></blockquote>True if this handler was destroyed using destroy.</div></div><divclass=CToolTipid="tt9"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.destroy = function()</td></tr></table></blockquote>Destroys the handler and all its resources and DOM nodes.</div></div><divclass=CToolTipid="tt10"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.enabled</td></tr></table></blockquote>Specifies if events are handled. </div></div><divclass=CToolTipid="tt11"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.isEnabled = function()</td></tr></table></blockquote>Returns true if events are handled. </div></div><divclass=CToolTipid="tt12"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass="PBeforeParameters prettyprint "nowrap>mxTooltipHandler.prototype.setEnabled = function(</td><tdclass="PParameter prettyprint "nowrap>enabled</td><tdclass="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Enables or disables event handling. </div></div><divclass=CToolTipid="tt13"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype"><tr><tdclass="prettyprint">mxTooltipHandler.prototype.isHideOnHover = function()</td></tr></table></blockquote>Returns hideOnHover.</div></div><divclass=CToolTipid="tt14"><divclass=CFunction><blockquote><tab
