1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
3 <html><head><title>OpenLayers.Event - OpenLayers</title><link rel="stylesheet" type="text/css" href="../../styles/main.css"><script language=JavaScript src="../../javascript/main.js"></script><script language=JavaScript src="../../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
4 if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
6 <!-- Generated by Natural Docs, version 1.4 -->
7 <!-- http://www.naturaldocs.org -->
9 <!-- saved from url=(0026)http://www.naturaldocs.org -->
14 <div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="OpenLayers.Event"></a>OpenLayers.<wbr>Event</h1><div class=CBody><p>Utility functions for event handling.</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="#OpenLayers.Event" >OpenLayers.<wbr>Event</a></td><td class=SDescription>Utility functions for event handling.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Event.Properties" >Properties</a></td><td class=SDescription></td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Event.observers" >observers</a></td><td class=SDescription>{Object} A hashtable cache of the event observers. </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Event.Constants" >Constants</a></td><td class=SDescription></td></tr><tr class="SConstant SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Event.KEY_BACKSPACE" >KEY_BACKSPACE</a></td><td class=SDescription>{int}</td></tr><tr class="SConstant SIndent2"><td class=SEntry><a href="#OpenLayers.Event.KEY_TAB" >KEY_TAB</a></td><td class=SDescription>{int}</td></tr><tr class="SConstant SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Event.KEY_RETURN" >KEY_RETURN</a></td><td class=SDescription>{int}</td></tr><tr class="SConstant SIndent2"><td class=SEntry><a href="#OpenLayers.Event.KEY_ESC" >KEY_ESC</a></td><td class=SDescription>{int}</td></tr><tr class="SConstant SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Event.KEY_LEFT" >KEY_LEFT</a></td><td class=SDescription>{int}</td></tr><tr class="SConstant SIndent2"><td class=SEntry><a href="#OpenLayers.Event.KEY_UP" >KEY_UP</a></td><td class=SDescription>{int}</td></tr><tr class="SConstant SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Event.KEY_RIGHT" >KEY_RIGHT</a></td><td class=SDescription>{int}</td></tr><tr class="SConstant SIndent2"><td class=SEntry><a href="#OpenLayers.Event.KEY_DOWN" >KEY_DOWN</a></td><td class=SDescription>{int}</td></tr><tr class="SConstant SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Event.KEY_DELETE" >KEY_DELETE</a></td><td class=SDescription>{int}</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Event.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Event.element" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">element</a></td><td class=SDescription>Cross browser event element detection.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Event.isLeftClick" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">isLeftClick</a></td><td class=SDescription>Determine whether event was caused by a left click.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Event.isRightClick" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">isRightClick</a></td><td class=SDescription>Determine whether event was caused by a right mouse click.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Event.stop" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">stop</a></td><td class=SDescription>Stops an event from propagating.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Event.findElement" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">findElement</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Event.observe" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">observe</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Event.stopObservingElement" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">stopObservingElement</a></td><td class=SDescription>Given the id of an element to stop observing, cycle through the element’s cached observers, calling stopObserving on each one, skipping those entries which can no longer be removed.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Event._removeElementObservers" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">_removeElementObservers</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Event.stopObserving" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">stopObserving</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Event.unloadCache" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">unloadCache</a></td><td class=SDescription>Cycle through all the element entries in the events cache and call stopObservingElement on each.</td></tr><tr class="SClass"><td class=SEntry><a href="#OpenLayers.Events" >OpenLayers.<wbr>Events</a></td><td class=SDescription></td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Events.Constants" >Constants</a></td><td class=SDescription></td></tr><tr class="SConstant SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Events.BROWSER_EVENTS" >BROWSER_EVENTS</a></td><td class=SDescription>{Array(String)} supported events</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Events.Properties" >Properties</a></td><td class=SDescription></td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Events.listeners" >listeners</a></td><td class=SDescription>{Object} Hashtable of Array(Function): events listener functions</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Events.object" >object</a></td><td class=SDescription>{Object} the code object issuing application events</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Events.element" >element</a></td><td class=SDescription>{DOMElement} the DOM element receiving browser events</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Events.eventTypes" >eventTypes</a></td><td class=SDescription>{Array(String)} list of support application events</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Events.eventHandler" >eventHandler</a></td><td class=SDescription>{Function} bound event handler attached to elements</td></tr><tr class="SProperty SIndent2"><td class=SEntry><a href="#OpenLayers.Events.fallThrough" >fallThrough</a></td><td class=SDescription>{Boolean}</td></tr><tr class="SProperty SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Events.includeXY" >includeXY</a></td><td class=SDescription>{Boolean} Should the .xy property automatically be created for browser mouse events? </td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Events.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Events.clearMouseListener" >clearMouseListener</a></td><td class=SDescription>A version of <a href="#OpenLayers.Events.clearMouseCache" class=LFunction id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">clearMouseCache</a> that is bound to this instance so that it can be used with <a href="#OpenLayers.Event.observe" class=LFunction id=link12 onMouseOver="ShowTip(event, 'tt6', 'link12')" onMouseOut="HideTip('tt6')">OpenLayers.Event.observe</a> and <a href="#OpenLayers.Event.stopObserving" class=LFunction id=link13 onMouseOver="ShowTip(event, 'tt9', 'link13')" onMouseOut="HideTip('tt9')">OpenLayers.Event.stopObserving</a>.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Events.Constructor" >Constructor</a></td><td class=SDescription></td></tr><tr class="SConstructor SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Events.OpenLayers.Events" >OpenLayers.<wbr>Events</a></td><td class=SDescription>Construct an OpenLayers.Events object.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#OpenLayers.Events.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Events.destroy" id=link14 onMouseOver="ShowTip(event, 'tt12', 'link14')" onMouseOut="HideTip('tt12')">destroy</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Events.addEventType" id=link15 onMouseOver="ShowTip(event, 'tt13', 'link15')" onMouseOut="HideTip('tt13')">addEventType</a></td><td class=SDescription>Add a new event type to this events object. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Events.attachToElement" id=link16 onMouseOver="ShowTip(event, 'tt14', 'link16')" onMouseOut="HideTip('tt14')">attachToElement</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Events.on" id=link17 onMouseOver="ShowTip(event, 'tt15', 'link17')" onMouseOut="HideTip('tt15')">on</a></td><td class=SDescription>Convenience method for registering listeners with a common scope.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Events.register" id=link18 onMouseOver="ShowTip(event, 'tt16', 'link18')" onMouseOut="HideTip('tt16')">register</a></td><td class=SDescription>Register an event on the events object.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Events.registerPriority" id=link19 onMouseOver="ShowTip(event, 'tt17', 'link19')" onMouseOut="HideTip('tt17')">registerPriority</a></td><td class=SDescription>Same as register() but adds the new listener to the <b>front</b> of the events queue instead of to the end.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Events.un" id=link20 onMouseOver="ShowTip(event, 'tt18', 'link20')" onMouseOut="HideTip('tt18')">un</a></td><td class=SDescription>Convenience method for unregistering listeners with a common scope.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Events.unregister" id=link21 onMouseOver="ShowTip(event, 'tt19', 'link21')" onMouseOut="HideTip('tt19')">unregister</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Events.remove" id=link22 onMouseOver="ShowTip(event, 'tt20', 'link22')" onMouseOut="HideTip('tt20')">remove</a></td><td class=SDescription>Remove all listeners for a given event type. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Events.triggerEvent" id=link23 onMouseOver="ShowTip(event, 'tt21', 'link23')" onMouseOut="HideTip('tt21')">triggerEvent</a></td><td class=SDescription>Trigger a specified registered event.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Events.handleBrowserEvent" id=link24 onMouseOver="ShowTip(event, 'tt22', 'link24')" onMouseOut="HideTip('tt22')">handleBrowserEvent</a></td><td class=SDescription>Basically just a wrapper to the triggerEvent() function, but takes care to set a property ‘xy’ on the event with the current mouse position.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#OpenLayers.Events.clearMouseCache" id=link25 onMouseOver="ShowTip(event, 'tt11', 'link25')" onMouseOut="HideTip('tt11')">clearMouseCache</a></td><td class=SDescription>Clear cached data about the mouse position. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#OpenLayers.Events.getMousePosition" id=link26 onMouseOver="ShowTip(event, 'tt23', 'link26')" onMouseOut="HideTip('tt23')">getMousePosition</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
16 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.Properties"></a>Properties</h3></div></div>
18 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.observers"></a>observers</h3><div class=CBody><p>{Object} A hashtable cache of the event observers. Keyed by element._eventCacheID</p></div></div></div>
20 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.Constants"></a>Constants</h3></div></div>
22 <div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_BACKSPACE"></a>KEY_BACKSPACE</h3><div class=CBody><p>{int}</p></div></div></div>
24 <div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_TAB"></a>KEY_TAB</h3><div class=CBody><p>{int}</p></div></div></div>
26 <div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_RETURN"></a>KEY_RETURN</h3><div class=CBody><p>{int}</p></div></div></div>
28 <div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_ESC"></a>KEY_ESC</h3><div class=CBody><p>{int}</p></div></div></div>
30 <div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_LEFT"></a>KEY_LEFT</h3><div class=CBody><p>{int}</p></div></div></div>
32 <div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_UP"></a>KEY_UP</h3><div class=CBody><p>{int}</p></div></div></div>
34 <div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_RIGHT"></a>KEY_RIGHT</h3><div class=CBody><p>{int}</p></div></div></div>
36 <div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_DOWN"></a>KEY_DOWN</h3><div class=CBody><p>{int}</p></div></div></div>
38 <div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_DELETE"></a>KEY_DELETE</h3><div class=CBody><p>{int}</p></div></div></div>
40 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.Functions"></a>Functions</h3></div></div>
42 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.element"></a>element</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 nowrap>element: function(</td><td class=PParameter nowrap>event</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Cross browser event element detection.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>event</td><td class=CDLDescription>{Event}</td></tr></table><h4 class=CHeading>Returns</h4><p>{DOMElement} The element that caused the event</p></div></div></div>
44 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.isLeftClick"></a>isLeftClick</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 nowrap>isLeftClick: function(</td><td class=PParameter nowrap>event</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Determine whether event was caused by a left click.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>event</td><td class=CDLDescription>{Event}</td></tr></table><h4 class=CHeading>Returns</h4><p>{Boolean}</p></div></div></div>
46 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.isRightClick"></a>isRightClick</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 nowrap>isRightClick: function(</td><td class=PParameter nowrap>event</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Determine whether event was caused by a right mouse click.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>event</td><td class=CDLDescription>{Event}</td></tr></table><h4 class=CHeading>Returns</h4><p>{Boolean}</p></div></div></div>
48 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.stop"></a>stop</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 nowrap>stop: function(</td><td class=PParameter nowrap>event,</td></tr><tr><td></td><td class=PParameter nowrap>allowDefault</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Stops an event from propagating.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>event</td><td class=CDLDescription>{Event}</td></tr><tr><td class=CDLEntry>allowDefault</td><td class=CDLDescription>{Boolean} If true, we stop the event chain but still allow the default browser behaviour (text selection, radio-button clicking, etc) Default false</td></tr></table></div></div></div>
50 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.findElement"></a>findElement</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 nowrap>findElement: function(</td><td class=PParameter nowrap>event,</td></tr><tr><td></td><td class=PParameter nowrap>tagName</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>event</td><td class=CDLDescription>{Event}</td></tr><tr><td class=CDLEntry>tagName</td><td class=CDLDescription>{String}</td></tr></table><h4 class=CHeading>Returns</h4><p>{DOMElement} The first node with the given tagName, starting from the node the event was triggered on and traversing the DOM upwards</p></div></div></div>
52 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.observe"></a>observe</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 nowrap>observe: function(</td><td class=PParameter nowrap>elementParam,</td></tr><tr><td></td><td class=PParameter nowrap>name,</td></tr><tr><td></td><td class=PParameter nowrap>observer,</td></tr><tr><td></td><td class=PParameter nowrap>useCapture</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>elementParam</td><td class=CDLDescription>{DOMElement || String}</td></tr><tr><td class=CDLEntry>name</td><td class=CDLDescription>{String}</td></tr><tr><td class=CDLEntry>observer</td><td class=CDLDescription>{function}</td></tr><tr><td class=CDLEntry>useCapture</td><td class=CDLDescription>{Boolean}</td></tr></table></div></div></div>
54 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.stopObservingElement"></a>stopObservingElement</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 nowrap>stopObservingElement: function(</td><td class=PParameter nowrap>elementParam</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Given the id of an element to stop observing, cycle through the element’s cached observers, calling stopObserving on each one, skipping those entries which can no longer be removed.</p><h4 class=CHeading>parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>elementParam</td><td class=CDLDescription>{DOMElement || String}</td></tr></table></div></div></div>
56 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event._removeElementObservers"></a>_removeElementObservers</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 nowrap>_removeElementObservers: function(</td><td class=PParameter nowrap>elementObservers</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>elementObservers</td><td class=CDLDescription>{Array(Object)} Array of (element, name, observer, usecapture) objects, taken directly from hashtable</td></tr></table></div></div></div>
58 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.stopObserving"></a>stopObserving</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 nowrap>stopObserving: function(</td><td class=PParameter nowrap>elementParam,</td></tr><tr><td></td><td class=PParameter nowrap>name,</td></tr><tr><td></td><td class=PParameter nowrap>observer,</td></tr><tr><td></td><td class=PParameter nowrap>useCapture</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>elementParam</td><td class=CDLDescription>{DOMElement || String}</td></tr><tr><td class=CDLEntry>name</td><td class=CDLDescription>{String}</td></tr><tr><td class=CDLEntry>observer</td><td class=CDLDescription>{function}</td></tr><tr><td class=CDLEntry>useCapture</td><td class=CDLDescription>{Boolean}</td></tr></table><h4 class=CHeading>Returns</h4><p>{Boolean} Whether or not the event observer was removed</p></div></div></div>
60 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.unloadCache"></a>unloadCache</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>unloadCache: function()</td></tr></table></blockquote><p>Cycle through all the element entries in the events cache and call stopObservingElement on each.</p></div></div></div>
62 <div class="CClass"><div class=CTopic><h2 class=CTitle><a name="OpenLayers.Events"></a>OpenLayers.<wbr>Events</h2><div class=CBody><!--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="SGroup"><td class=SEntry><a href="#OpenLayers.Events.Constants" >Constants</a></td><td class=SDescription></td></tr><tr class="SConstant SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Events.BROWSER_EVENTS" >BROWSER_EVENTS</a></td><td class=SDescription>{Array(String)} supported events</td></tr><tr class="SGroup"><td class=SEntry><a href="#OpenLayers.Events.Properties" >Properties</a></td><td class=SDescription></td></tr><tr class="SProperty SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Events.listeners" >listeners</a></td><td class=SDescription>{Object} Hashtable of Array(Function): events listener functions</td></tr><tr class="SProperty SIndent1"><td class=SEntry><a href="#OpenLayers.Events.object" >object</a></td><td class=SDescription>{Object} the code object issuing application events</td></tr><tr class="SProperty SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Events.element" >element</a></td><td class=SDescription>{DOMElement} the DOM element receiving browser events</td></tr><tr class="SProperty SIndent1"><td class=SEntry><a href="#OpenLayers.Events.eventTypes" >eventTypes</a></td><td class=SDescription>{Array(String)} list of support application events</td></tr><tr class="SProperty SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Events.eventHandler" >eventHandler</a></td><td class=SDescription>{Function} bound event handler attached to elements</td></tr><tr class="SProperty SIndent1"><td class=SEntry><a href="#OpenLayers.Events.fallThrough" >fallThrough</a></td><td class=SDescription>{Boolean}</td></tr><tr class="SProperty SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Events.includeXY" >includeXY</a></td><td class=SDescription>{Boolean} Should the .xy property automatically be created for browser mouse events? </td></tr><tr class="SGroup"><td class=SEntry><a href="#OpenLayers.Events.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Events.clearMouseListener" >clearMouseListener</a></td><td class=SDescription>A version of <a href="#OpenLayers.Events.clearMouseCache" class=LFunction id=link27 onMouseOver="ShowTip(event, 'tt11', 'link27')" onMouseOut="HideTip('tt11')">clearMouseCache</a> that is bound to this instance so that it can be used with <a href="#OpenLayers.Event.observe" class=LFunction id=link28 onMouseOver="ShowTip(event, 'tt6', 'link28')" onMouseOut="HideTip('tt6')">OpenLayers.Event.observe</a> and <a href="#OpenLayers.Event.stopObserving" class=LFunction id=link29 onMouseOver="ShowTip(event, 'tt9', 'link29')" onMouseOut="HideTip('tt9')">OpenLayers.Event.stopObserving</a>.</td></tr><tr class="SGroup"><td class=SEntry><a href="#OpenLayers.Events.Constructor" >Constructor</a></td><td class=SDescription></td></tr><tr class="SConstructor SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Events.OpenLayers.Events" >OpenLayers.<wbr>Events</a></td><td class=SDescription>Construct an OpenLayers.Events object.</td></tr><tr class="SGroup"><td class=SEntry><a href="#OpenLayers.Events.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Events.destroy" id=link30 onMouseOver="ShowTip(event, 'tt12', 'link30')" onMouseOut="HideTip('tt12')">destroy</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#OpenLayers.Events.addEventType" id=link31 onMouseOver="ShowTip(event, 'tt13', 'link31')" onMouseOut="HideTip('tt13')">addEventType</a></td><td class=SDescription>Add a new event type to this events object. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Events.attachToElement" id=link32 onMouseOver="ShowTip(event, 'tt14', 'link32')" onMouseOut="HideTip('tt14')">attachToElement</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#OpenLayers.Events.on" id=link33 onMouseOver="ShowTip(event, 'tt15', 'link33')" onMouseOut="HideTip('tt15')">on</a></td><td class=SDescription>Convenience method for registering listeners with a common scope.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Events.register" id=link34 onMouseOver="ShowTip(event, 'tt16', 'link34')" onMouseOut="HideTip('tt16')">register</a></td><td class=SDescription>Register an event on the events object.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#OpenLayers.Events.registerPriority" id=link35 onMouseOver="ShowTip(event, 'tt17', 'link35')" onMouseOut="HideTip('tt17')">registerPriority</a></td><td class=SDescription>Same as register() but adds the new listener to the <b>front</b> of the events queue instead of to the end.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Events.un" id=link36 onMouseOver="ShowTip(event, 'tt18', 'link36')" onMouseOut="HideTip('tt18')">un</a></td><td class=SDescription>Convenience method for unregistering listeners with a common scope.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#OpenLayers.Events.unregister" id=link37 onMouseOver="ShowTip(event, 'tt19', 'link37')" onMouseOut="HideTip('tt19')">unregister</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Events.remove" id=link38 onMouseOver="ShowTip(event, 'tt20', 'link38')" onMouseOut="HideTip('tt20')">remove</a></td><td class=SDescription>Remove all listeners for a given event type. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#OpenLayers.Events.triggerEvent" id=link39 onMouseOver="ShowTip(event, 'tt21', 'link39')" onMouseOut="HideTip('tt21')">triggerEvent</a></td><td class=SDescription>Trigger a specified registered event.</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Events.handleBrowserEvent" id=link40 onMouseOver="ShowTip(event, 'tt22', 'link40')" onMouseOut="HideTip('tt22')">handleBrowserEvent</a></td><td class=SDescription>Basically just a wrapper to the triggerEvent() function, but takes care to set a property ‘xy’ on the event with the current mouse position.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#OpenLayers.Events.clearMouseCache" id=link41 onMouseOver="ShowTip(event, 'tt11', 'link41')" onMouseOut="HideTip('tt11')">clearMouseCache</a></td><td class=SDescription>Clear cached data about the mouse position. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#OpenLayers.Events.getMousePosition" id=link42 onMouseOver="ShowTip(event, 'tt23', 'link42')" onMouseOut="HideTip('tt23')">getMousePosition</a></td><td class=SDescription></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
64 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.Constants"></a>Constants</h3></div></div>
66 <div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.BROWSER_EVENTS"></a>BROWSER_EVENTS</h3><div class=CBody><p>{Array(String)} supported events</p></div></div></div>
68 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.Properties"></a>Properties</h3></div></div>
70 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.listeners"></a>listeners</h3><div class=CBody><p>{Object} Hashtable of Array(Function): events listener functions</p></div></div></div>
72 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.object"></a>object</h3><div class=CBody><p>{Object} the code object issuing application events</p></div></div></div>
74 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.element"></a>element</h3><div class=CBody><p>{DOMElement} the DOM element receiving browser events</p></div></div></div>
76 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.eventTypes"></a>eventTypes</h3><div class=CBody><p>{Array(String)} list of support application events</p></div></div></div>
78 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.eventHandler"></a>eventHandler</h3><div class=CBody><p>{Function} bound event handler attached to elements</p></div></div></div>
80 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.fallThrough"></a>fallThrough</h3><div class=CBody><p>{Boolean}</p></div></div></div>
82 <div class="CProperty"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.includeXY"></a>includeXY</h3><div class=CBody><p>{Boolean} Should the .xy property automatically be created for browser mouse events? In general, this should be false. If it is true, then mouse events will automatically generate a ‘.xy’ property on the event object that is passed. (Prior to OpenLayers 2.7, this was true by default.) Otherwise, you can call the getMousePosition on the relevant events handler on the object available via the ‘evt.object’ property of the evt object. So, for most events, you can call: function named(evt) { this.xy = this.object.events.getMousePosition(evt) }</p><h4 class=CHeading>This option typically defaults to false for performance reasons</h4><p>when creating an events object whose primary purpose is to manage relatively positioned mouse events within a div, it may make sense to set it to true.</p><p>This option is also used to control whether the events object caches offsets. If this is false, it will not: the reason for this is that it is only expected to be called many times if the includeXY property is set to true. If you set this to true, you are expected to clear the offset cache manually (using this.clearMouseCache()) if: the border of the element changes the location of the element in the page changes</p></div></div></div>
84 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.Functions"></a>Functions</h3></div></div>
86 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.clearMouseListener"></a>clearMouseListener</h3><div class=CBody><p>A version of <a href="#OpenLayers.Events.clearMouseCache" class=LFunction id=link43 onMouseOver="ShowTip(event, 'tt11', 'link43')" onMouseOut="HideTip('tt11')">clearMouseCache</a> that is bound to this instance so that it can be used with <a href="#OpenLayers.Event.observe" class=LFunction id=link44 onMouseOver="ShowTip(event, 'tt6', 'link44')" onMouseOut="HideTip('tt6')">OpenLayers.Event.observe</a> and <a href="#OpenLayers.Event.stopObserving" class=LFunction id=link45 onMouseOver="ShowTip(event, 'tt9', 'link45')" onMouseOut="HideTip('tt9')">OpenLayers.Event.stopObserving</a>.</p></div></div></div>
88 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.Constructor"></a>Constructor</h3></div></div>
90 <div class="CConstructor"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.OpenLayers.Events"></a>OpenLayers.<wbr>Events</h3><div class=CBody><p>Construct an OpenLayers.Events object.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>object</td><td class=CDLDescription>{Object} The js object to which this Events object is being</td></tr><tr><td class=CDLEntry>added element</td><td class=CDLDescription>{DOMElement} A dom element to respond to browser events</td></tr><tr><td class=CDLEntry>eventTypes</td><td class=CDLDescription>{Array(String)} Array of custom application events</td></tr><tr><td class=CDLEntry>fallThrough</td><td class=CDLDescription>{Boolean} Allow events to fall through after these have been handled?</td></tr><tr><td class=CDLEntry>options</td><td class=CDLDescription>{Object} Options for the events object.</td></tr></table></div></div></div>
92 <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.Functions"></a>Functions</h3></div></div>
94 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.destroy"></a>destroy</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>destroy: function ()</td></tr></table></blockquote></div></div></div>
96 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.addEventType"></a>addEventType</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 nowrap>addEventType: function(</td><td class=PParameter nowrap>eventName</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Add a new event type to this events object. If the event type has already been added, do nothing.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>eventName</td><td class=CDLDescription>{String}</td></tr></table></div></div></div>
98 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.attachToElement"></a>attachToElement</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 nowrap>attachToElement: function (</td><td class=PParameter nowrap>element</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>element</td><td class=CDLDescription>{HTMLDOMElement} a DOM element to attach browser events to</td></tr></table></div></div></div>
100 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.on"></a>on</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 nowrap>on: function(</td><td class=PParameter nowrap>object</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Convenience method for registering listeners with a common scope.</p><h4 class=CHeading>Example use</h4><blockquote><pre>events.on({
101 "loadstart": loadStartListener,
102 "loadend": loadEndListener,
104 });</pre></blockquote></div></div></div>
106 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.register"></a>register</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 nowrap>register: function (</td><td class=PParameter nowrap>type,</td></tr><tr><td></td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>func</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Register an event on the events object.</p><p>When the event is triggered, the ‘func’ function will be called, in the context of ‘obj’. Imagine we were to register an event, specifying an OpenLayers.Bounds Object as ‘obj’. When the event is triggered, the context in the callback function will be our Bounds object. This means that within our callback function, we can access the properties and methods of the Bounds object through the “this” variable. So our callback could execute something like:</p><blockquote><pre>leftStr = "Left: " + this.left;</pre></blockquote><p>or</p><blockquote><pre>centerStr = "Center: " + this.getCenterLonLat();</pre></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>type</td><td class=CDLDescription>{String} Name of the event to register</td></tr><tr><td class=CDLEntry>obj</td><td class=CDLDescription>{Object} The object to bind the context to for the callback#. If no object is specified, default is the Events’s ‘object’ property.</td></tr><tr><td class=CDLEntry>func</td><td class=CDLDescription>{Function} The callback function. If no callback is specified, this function does nothing.</td></tr></table></div></div></div>
108 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.registerPriority"></a>registerPriority</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 nowrap>registerPriority: function (</td><td class=PParameter nowrap>type,</td></tr><tr><td></td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>func</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Same as register() but adds the new listener to the <b>front</b> of the events queue instead of to the end.</p><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>TODO: get rid of this in 3.0</td><td class=CDLDescription>Decide whether listeners should be called in the order they were registered or in reverse order.</td></tr></table><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>type</td><td class=CDLDescription>{String} Name of the event to register</td></tr><tr><td class=CDLEntry>obj</td><td class=CDLDescription>{Object} The object to bind the context to for the callback#. If no object is specified, default is the Events’s ‘object’ property.</td></tr><tr><td class=CDLEntry>func</td><td class=CDLDescription>{Function} The callback function. If no callback is specified, this function does nothing.</td></tr></table></div></div></div>
110 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.un"></a>un</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 nowrap>un: function(</td><td class=PParameter nowrap>object</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Convenience method for unregistering listeners with a common scope.</p><h4 class=CHeading>Example use</h4><blockquote><pre>events.un({
111 "loadstart": loadStartListener,
112 "loadend": loadEndListener,
114 });</pre></blockquote></div></div></div>
116 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.unregister"></a>unregister</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 nowrap>unregister: function (</td><td class=PParameter nowrap>type,</td></tr><tr><td></td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>func</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>type</td><td class=CDLDescription>{String}</td></tr><tr><td class=CDLEntry>obj</td><td class=CDLDescription>{Object} If none specified, defaults to this.object</td></tr><tr><td class=CDLEntry>func</td><td class=CDLDescription>{Function}</td></tr></table></div></div></div>
118 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.remove"></a>remove</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 nowrap>remove: function(</td><td class=PParameter nowrap>type</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Remove all listeners for a given event type. If type is not registered, does nothing.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>type</td><td class=CDLDescription>{String}</td></tr></table></div></div></div>
120 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.triggerEvent"></a>triggerEvent</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 nowrap>triggerEvent: function (</td><td class=PParameter nowrap>type,</td></tr><tr><td></td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Trigger a specified registered event.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>type</td><td class=CDLDescription>{String}</td></tr><tr><td class=CDLEntry>evt</td><td class=CDLDescription>{Event}</td></tr></table><h4 class=CHeading>Returns</h4><p>{Boolean} The last listener return. If a listener returns false, the chain of listeners will stop getting called.</p></div></div></div>
122 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.handleBrowserEvent"></a>handleBrowserEvent</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 nowrap>handleBrowserEvent: function (</td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p>Basically just a wrapper to the triggerEvent() function, but takes care to set a property ‘xy’ on the event with the current mouse position.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>evt</td><td class=CDLDescription>{Event}</td></tr></table></div></div></div>
124 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.clearMouseCache"></a>clearMouseCache</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>clearMouseCache: function()</td></tr></table></blockquote><p>Clear cached data about the mouse position. This should be called any time the element that events are registered on changes position within the page.</p></div></div></div>
126 <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.getMousePosition"></a>getMousePosition</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 nowrap>getMousePosition: function (</td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>evt</td><td class=CDLDescription>{Event}</td></tr></table><h4 class=CHeading>Returns</h4><p>{<a href="BaseTypes/Pixel-js.html#OpenLayers.Pixel" class=LClass id=link46 onMouseOver="ShowTip(event, 'tt24', 'link46')" onMouseOut="HideTip('tt24')">OpenLayers.Pixel</a>} The current xy coordinate of the mouse, adjusted for offsets</p></div></div></div>
131 <div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
134 <div id=Menu><div class=MTitle>OpenLayers<div class=MSubTitle>JavaScript Mapping Library</div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent29')">OpenLayers</a><div class=MGroupContent id=MGroupContent29><div class=MEntry><div class=MFile><a href="../OpenLayers-js.html">OpenLayers</a></div></div><div class=MEntry><div class=MFile><a href="Ajax-js.html">Ajax</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">BaseTypes</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="BaseTypes-js.html">Base Types</a></div></div><div class=MEntry><div class=MFile><a href="BaseTypes/Bounds-js.html">Bounds</a></div></div><div class=MEntry><div class=MFile><a href="BaseTypes/Class-js.html">Class</a></div></div><div class=MEntry><div class=MFile><a href="BaseTypes/Element-js.html">Element</a></div></div><div class=MEntry><div class=MFile><a href="BaseTypes/LonLat-js.html">LonLat</a></div></div><div class=MEntry><div class=MFile><a href="BaseTypes/Pixel-js.html">Pixel</a></div></div><div class=MEntry><div class=MFile><a href="BaseTypes/Size-js.html">Size</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Console-js.html">Console</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Control</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="Control-js.html">Control</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Control</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="Control/ArgParser-js.html">ArgParser</a></div></div><div class=MEntry><div class=MFile><a href="Control/Attribution-js.html">Attribution</a></div></div><div class=MEntry><div class=MFile><a href="Control/Button-js.html">Button</a></div></div><div class=MEntry><div class=MFile><a href="Control/DragFeature-js.html">DragFeature</a></div></div><div class=MEntry><div class=MFile><a href="Control/DragPan-js.html">DragPan</a></div></div><div class=MEntry><div class=MFile><a href="Control/DrawFeature-js.html">DrawFeature</a></div></div><div class=MEntry><div class=MFile><a href="Control/EditingToolbar-js.html">EditingToolbar</a></div></div><div class=MEntry><div class=MFile><a href="Control/GetFeature-js.html">GetFeature</a></div></div><div class=MEntry><div class=MFile><a href="Control/KeyboardDefaults-js.html">KeyboardDefaults</a></div></div><div class=MEntry><div class=MFile><a href="Control/LayerSwitcher-js.html">LayerSwitcher</a></div></div><div class=MEntry><div class=MFile><a href="Control/Measure-js.html">Measure</a></div></div><div class=MEntry><div class=MFile><a href="Control/ModifyFeature-js.html">ModifyFeature</a></div></div><div class=MEntry><div class=MFile><a href="Control/MouseDefaults-js.html">MouseDefaults</a></div></div><div class=MEntry><div class=MFile><a href="Control/MousePosition-js.html">MousePosition</a></div></div><div class=MEntry><div class=MFile><a href="Control/MouseToolbar-js.html">MouseToolbar</a></div></div><div class=MEntry><div class=MFile><a href="Control/Navigation-js.html">Navigation</a></div></div><div class=MEntry><div class=MFile><a href="Control/NavigationHistory-js.html">NavigationHistory</a></div></div><div class=MEntry><div class=MFile><a href="Control/NavToolbar-js.html">NavToolbar</a></div></div><div class=MEntry><div class=MFile><a href="Control/OverviewMap-js.html">OverviewMap</a></div></div><div class=MEntry><div class=MFile><a href="Control/Pan-js.html">Pan</a></div></div><div class=MEntry><div class=MFile><a href="Control/Panel-js.html">Panel</a></div></div><div class=MEntry><div class=MFile><a href="Control/PanPanel-js.html">PanPanel</a></div></div><div class=MEntry><div class=MFile><a href="Control/PanZoom-js.html">PanZoom</a></div></div><div class=MEntry><div class=MFile><a href="Control/PanZoomBar-js.html">PanZoomBar</a></div></div><div class=MEntry><div class=MFile><a href="Control/Permalink-js.html">Permalink</a></div></div><div class=MEntry><div class=MFile><a href="Control/Scale-js.html">Scale</a></div></div><div class=MEntry><div class=MFile><a href="Control/ScaleLine-js.html">ScaleLine</a></div></div><div class=MEntry><div class=MFile><a href="Control/SelectFeature-js.html">SelectFeature</a></div></div><div class=MEntry><div class=MFile><a href="Control/Snapping-js.html">Snapping</a></div></div><div class=MEntry><div class=MFile><a href="Control/Split-js.html">Split</a></div></div><div class=MEntry><div class=MFile><a href="Control/WMSGetFeatureInfo-js.html">WMSGetFeatureInfo</a></div></div><div class=MEntry><div class=MFile><a href="Control/ZoomBox-js.html">ZoomBox</a></div></div><div class=MEntry><div class=MFile><a href="Control/ZoomIn-js.html">ZoomIn</a></div></div><div class=MEntry><div class=MFile><a href="Control/ZoomOut-js.html">ZoomOut</a></div></div><div class=MEntry><div class=MFile><a href="Control/ZoomPanel-js.html">ZoomPanel</a></div></div><div class=MEntry><div class=MFile><a href="Control/ZoomToMaxExtent-js.html">ZoomToMaxExtent</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MFile id=MSelected>Events</div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent4')">Feature</a><div class=MGroupContent id=MGroupContent4><div class=MEntry><div class=MFile><a href="Feature-js.html">Feature</a></div></div><div class=MEntry><div class=MFile><a href="Feature/Vector-js.html">Vector</a></div></div><div class=MEntry><div class=MFile><a href="Feature/WFS-js.html">WFS</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent5')">Filter</a><div class=MGroupContent id=MGroupContent5><div class=MEntry><div class=MFile><a href="Filter-js.html">Filter</a></div></div><div class=MEntry><div class=MFile><a href="Filter/Comparison-js.html">Comparison</a></div></div><div class=MEntry><div class=MFile><a href="Filter/FeatureId-js.html">FeatureId</a></div></div><div class=MEntry><div class=MFile><a href="Filter/Logical-js.html">Logical</a></div></div><div class=MEntry><div class=MFile><a href="Filter/Spatial-js.html">Spatial</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent14')">Format</a><div class=MGroupContent id=MGroupContent14><div class=MEntry><div class=MFile><a href="Format-js.html">Format</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent6')">Filter</a><div class=MGroupContent id=MGroupContent6><div class=MEntry><div class=MFile><a href="Format/Filter-js.html">Filter</a></div></div><div class=MEntry><div class=MFile><a href="Format/Filter/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="Format/Filter/v1_0_0-js.html">v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="Format/Filter/v1_1_0-js.html">v1_1_0</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent7')">GML</a><div class=MGroupContent id=MGroupContent7><div class=MEntry><div class=MFile><a href="Format/GML-js.html">GML</a></div></div><div class=MEntry><div class=MFile><a href="Format/GML/Base-js.html">Base</a></div></div><div class=MEntry><div class=MFile><a href="Format/GML/v2-js.html">v2</a></div></div><div class=MEntry><div class=MFile><a href="Format/GML/v3-js.html">v3</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent8')">SLD</a><div class=MGroupContent id=MGroupContent8><div class=MEntry><div class=MFile><a href="Format/SLD-js.html">SLD</a></div></div><div class=MEntry><div class=MFile><a href="Format/SLD/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="Format/SLD/v1_0_0-js.html">v1_0_0</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent9')">WMC</a><div class=MGroupContent id=MGroupContent9><div class=MEntry><div class=MFile><a href="Format/WMC-js.html">WMC</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMC/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMC/v1_0_0-js.html">v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMC/v1_1_0-js.html">v1_1_0</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent13')">Format</a><div class=MGroupContent id=MGroupContent13><div class=MEntry><div class=MFile><a href="Format/ArcXML-js.html">ArcXML</a></div></div><div class=MEntry><div class=MFile><a href="Format/ArcXML/Features-js.html">ArcXML.<wbr>Features</a></div></div><div class=MEntry><div class=MFile><a href="Format/GeoJSON-js.html">GeoJSON</a></div></div><div class=MEntry><div class=MFile><a href="Format/GeoRSS-js.html">GeoRSS</a></div></div><div class=MEntry><div class=MFile><a href="Format/GPX-js.html">GPX</a></div></div><div class=MEntry><div class=MFile><a href="Format/JSON-js.html">JSON</a></div></div><div class=MEntry><div class=MFile><a href="Format/KML-js.html">KML</a></div></div><div class=MEntry><div class=MFile><a href="Format/OSM-js.html">OSM</a></div></div><div class=MEntry><div class=MFile><a href="Format/Text-js.html">Text</a></div></div><div class=MEntry><div class=MFile><a href="Format/WFS-js.html">WFS</a></div></div><div class=MEntry><div class=MFile><a href="Format/WFSCapabilities-js.html">WFSCapabilities</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent10')">WFSCapabilities</a><div class=MGroupContent id=MGroupContent10><div class=MEntry><div class=MFile><a href="Format/WFSCapabilities/v1-js.html">WFSCapabilities.v1</a></div></div><div class=MEntry><div class=MFile><a href="Format/WFSCapabilities/v1_0_0-js.html">WFSCapabilities/<wbr>v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="Format/WFSCapabilities/v1_1_0-js.html">WFSCapabilities/<wbr>v1_1_0</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Format/WFSDescribeFeatureType-js.html">WFSDescribeFeatureType.js</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent11')">WFST</a><div class=MGroupContent id=MGroupContent11><div class=MEntry><div class=MFile><a href="Format/WFST-js.html">WFST</a></div></div><div class=MEntry><div class=MFile><a href="Format/WFST/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="Format/WFST/v1_0_0-js.html">v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="Format/WFST/v1_1_0-js.html">v1_1_0</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Format/WKT-js.html">WKT</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMSCapabilities-js.html">WMSCapabilities</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent12')">WMSCapabilities</a><div class=MGroupContent id=MGroupContent12><div class=MEntry><div class=MFile><a href="Format/WMSCapabilities/v1_1-js.html">WMSCapabilities.v1_1</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMSCapabilities/v1_1_0-js.html">WMSCapabilities/<wbr>v1_1_0</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMSCapabilities/v1_1_1-js.html">WMSCapabilities/<wbr>v1_1_1</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Format/WMSDescribeLayer-js.html">WMSDescribeLayer</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMSDescribeLayer/v1_1-js.html">WMSDescribeLayer.v1_1</a></div></div><div class=MEntry><div class=MFile><a href="Format/WMSGetFeatureInfo-js.html">WMSGetFeatureInfo</a></div></div><div class=MEntry><div class=MFile><a href="Format/XML-js.html">XML</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent15')">Geometry</a><div class=MGroupContent id=MGroupContent15><div class=MEntry><div class=MFile><a href="Geometry-js.html">Geometry</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/Collection-js.html">Collection</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/Curve-js.html">Curve</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/LinearRing-js.html">LinearRing</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/LineString-js.html">LineString</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/MultiLineString-js.html">MultiLineString</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/MultiPoint-js.html">MultiPoint</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/MultiPolygon-js.html">MultiPolygon</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/Point-js.html">Point</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/Polygon-js.html">Polygon</a></div></div><div class=MEntry><div class=MFile><a href="Geometry/Rectangle-js.html">Rectangle</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent16')">Handler</a><div class=MGroupContent id=MGroupContent16><div class=MEntry><div class=MFile><a href="Handler-js.html">Handler</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Box-js.html">Box</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Click-js.html">Click</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Drag-js.html">Drag</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Feature-js.html">Feature</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Hover-js.html">Hover</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Keyboard-js.html">Keyboard</a></div></div><div class=MEntry><div class=MFile><a href="Handler/MouseWheel-js.html">MouseWheel</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Path-js.html">Path</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Point-js.html">Point</a></div></div><div class=MEntry><div class=MFile><a href="Handler/Polygon-js.html">Polygon</a></div></div><div class=MEntry><div class=MFile><a href="Handler/RegularPolygon-js.html">RegularPolygon</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Icon-js.html">Icon</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent17')">Lang</a><div class=MGroupContent id=MGroupContent17><div class=MEntry><div class=MFile><a href="Lang-js.html">Lang</a></div></div><div class=MEntry><div class=MFile><a href="Lang/ca-js.html">ca</a></div></div><div class=MEntry><div class=MFile><a href="Lang/cs-CZ-js.html">cs-CZ</a></div></div><div class=MEntry><div class=MFile><a href="Lang/da-DK-js.html">da-DK</a></div></div><div class=MEntry><div class=MFile><a href="Lang/de-js.html">de</a></div></div><div class=MEntry><div class=MFile><a href="Lang/en-js.html">en</a></div></div><div class=MEntry><div class=MFile><a href="Lang/en-CA-js.html">en-CA</a></div></div><div class=MEntry><div class=MFile><a href="Lang/es-js.html">es</a></div></div><div class=MEntry><div class=MFile><a href="Lang/fr-js.html">fr</a></div></div><div class=MEntry><div class=MFile><a href="Lang/it-js.html">it</a></div></div><div class=MEntry><div class=MFile><a href="Lang/nb-js.html">nb</a></div></div><div class=MEntry><div class=MFile><a href="Lang/nl-js.html">nl</a></div></div><div class=MEntry><div class=MFile><a href="Lang/pt-BR-js.html">pt-BR</a></div></div><div class=MEntry><div class=MFile><a href="Lang/sv-SE-js.html">sv-SE</a></div></div><div class=MEntry><div class=MFile><a href="Lang/zh-CN-js.html">zh-CN</a></div></div><div class=MEntry><div class=MFile><a href="Lang/zh-TW-js.html">zh-TW</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent19')">Layer</a><div class=MGroupContent id=MGroupContent19><div class=MEntry><div class=MFile><a href="Layer-js.html">Layer</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent18')">Layer</a><div class=MGroupContent id=MGroupContent18><div class=MEntry><div class=MFile><a href="Layer/ArcGIS93Rest-js.html">ArcGIS93Rest</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Boxes-js.html">Boxes</a></div></div><div class=MEntry><div class=MFile><a href="Layer/EventPane-js.html">EventPane</a></div></div><div class=MEntry><div class=MFile><a href="Layer/FixedZoomLevels-js.html">FixedZoomLevels</a></div></div><div class=MEntry><div class=MFile><a href="Layer/GeoRSS-js.html">GeoRSS</a></div></div><div class=MEntry><div class=MFile><a href="Layer/GML-js.html">GML</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Google-js.html">Google</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Grid-js.html">Grid</a></div></div><div class=MEntry><div class=MFile><a href="Layer/HTTPRequest-js.html">HTTPRequest</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Image-js.html">Image</a></div></div><div class=MEntry><div class=MFile><a href="Layer/KaMap-js.html">KaMap</a></div></div><div class=MEntry><div class=MFile><a href="Layer/KaMapCache-js.html">KaMapCache</a></div></div><div class=MEntry><div class=MFile><a href="Layer/MapGuide-js.html">MapGuide</a></div></div><div class=MEntry><div class=MFile><a href="Layer/MapServer-js.html">MapServer</a></div></div><div class=MEntry><div class=MFile><a href="Layer/MapServer/Untiled-js.html">MapServer.<wbr>Untiled</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Markers-js.html">Markers</a></div></div><div class=MEntry><div class=MFile><a href="Layer/MultiMap-js.html">MultiMap</a></div></div><div class=MEntry><div class=MFile><a href="Layer/PointTrack-js.html">PointTrack</a></div></div><div class=MEntry><div class=MFile><a href="Layer/SphericalMercator-js.html">SphericalMercator</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Text-js.html">Text</a></div></div><div class=MEntry><div class=MFile><a href="Layer/TileCache-js.html">TileCache</a></div></div><div class=MEntry><div class=MFile><a href="Layer/TMS-js.html">TMS</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Vector-js.html">Vector</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Vector/RootContainer-js.html">Vector.<wbr>RootContainer</a></div></div><div class=MEntry><div class=MFile><a href="Layer/VirtualEarth-js.html">VirtualEarth</a></div></div><div class=MEntry><div class=MFile><a href="Layer/WFS-js.html">WFS</a></div></div><div class=MEntry><div class=MFile><a href="Layer/WMS-js.html">WMS</a></div></div><div class=MEntry><div class=MFile><a href="Layer/WMS/Untiled-js.html">WMS.<wbr>Untiled</a></div></div><div class=MEntry><div class=MFile><a href="Layer/WorldWind-js.html">WorldWind</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Yahoo-js.html">Yahoo</a></div></div><div class=MEntry><div class=MFile><a href="Layer/ArcIMS-js.html">ArcIMS</a></div></div><div class=MEntry><div class=MFile><a href="Layer/XYZ-js.html">XYZ</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Map-js.html">Map</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent20')">Marker</a><div class=MGroupContent id=MGroupContent20><div class=MEntry><div class=MFile><a href="Marker-js.html">Marker</a></div></div><div class=MEntry><div class=MFile><a href="Marker/Box-js.html">Box</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent21')">Popup</a><div class=MGroupContent id=MGroupContent21><div class=MEntry><div class=MFile><a href="Popup-js.html">Popup</a></div></div><div class=MEntry><div class=MFile><a href="Popup/Anchored-js.html">Anchored</a></div></div><div class=MEntry><div class=MFile><a href="Popup/AnchoredBubble-js.html">AnchoredBubble</a></div></div><div class=MEntry><div class=MFile><a href="Popup/Framed-js.html">Framed</a></div></div><div class=MEntry><div class=MFile><a href="Popup/FramedCloud-js.html">FramedCloud</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Projection-js.html">Projection</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent24')">Protocol</a><div class=MGroupContent id=MGroupContent24><div class=MEntry><div class=MFile><a href="Protocol-js.html">Protocol</a></div></div><div class=MEntry><div class=MFile><a href="Protocol/HTTP-js.html">HTTP</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent22')">SQL</a><div class=MGroupContent id=MGroupContent22><div class=MEntry><div class=MFile><a href="Protocol/SQL-js.html">SQL</a></div></div><div class=MEntry><div class=MFile><a href="Protocol/SQL/Gears-js.html">Gears</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent23')">WFS</a><div class=MGroupContent id=MGroupContent23><div class=MEntry><div class=MFile><a href="Protocol/WFS-js.html">WFS</a></div></div><div class=MEntry><div class=MFile><a href="Protocol/WFS/v1-js.html">v1</a></div></div><div class=MEntry><div class=MFile><a href="Protocol/WFS/v1_0_0-js.html">v1_0_0</a></div></div><div class=MEntry><div class=MFile><a href="Protocol/WFS/v1_1_0-js.html">v1_1_0</a></div></div></div></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent25')">Renderer</a><div class=MGroupContent id=MGroupContent25><div class=MEntry><div class=MFile><a href="Renderer-js.html">Renderer</a></div></div><div class=MEntry><div class=MFile><a href="Renderer/Canvas-js.html">Canvas</a></div></div><div class=MEntry><div class=MFile><a href="Renderer/Elements-js.html">Elements</a></div></div><div class=MEntry><div class=MFile><a href="Renderer/SVG-js.html">SVG</a></div></div><div class=MEntry><div class=MFile><a href="Renderer/VML-js.html">VML</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent26')">Request</a><div class=MGroupContent id=MGroupContent26><div class=MEntry><div class=MFile><a href="Request-js.html">Request</a></div></div><div class=MEntry><div class=MFile><a href="Request/XMLHttpRequest-js.html">XMLHttpRequest</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Rule-js.html">Rule</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent27')">Strategy</a><div class=MGroupContent id=MGroupContent27><div class=MEntry><div class=MFile><a href="Strategy-js.html">Strategy</a></div></div><div class=MEntry><div class=MFile><a href="Strategy/BBOX-js.html">BBOX</a></div></div><div class=MEntry><div class=MFile><a href="Strategy/Cluster-js.html">Cluster</a></div></div><div class=MEntry><div class=MFile><a href="Strategy/Fixed-js.html">Fixed</a></div></div><div class=MEntry><div class=MFile><a href="Strategy/Paging-js.html">Paging</a></div></div><div class=MEntry><div class=MFile><a href="Strategy/Save-js.html">Save</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Style-js.html">Style</a></div></div><div class=MEntry><div class=MFile><a href="StyleMap-js.html">StyleMap</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent28')">Tile</a><div class=MGroupContent id=MGroupContent28><div class=MEntry><div class=MFile><a href="Tile-js.html">Tile</a></div></div><div class=MEntry><div class=MFile><a href="Tile/Image-js.html">Image</a></div></div><div class=MEntry><div class=MFile><a href="Tile/WFS-js.html">WFS</a></div></div></div></div></div><div class=MEntry><div class=MFile><a href="Tween-js.html">Tween</a></div></div><div class=MEntry><div class=MFile><a href="Util-js.html">Util</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent30')">Index</a><div class=MGroupContent id=MGroupContent30><div class=MEntry><div class=MIndex><a href="../../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Constants.html">Constants</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Properties.html">Properties</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../../index/Constructor.html">Constructor</a></div></div></div></div></div><script type="text/javascript"><!--
135 var searchPanel = new SearchPanel("searchPanel", "HTML", "../../search");
136 --></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="Constants">Constants</option><option value="Constructor">Constructor</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Properties">Properties</option></select></div><script language=JavaScript><!--
137 HideAllBut([29], 31);// --></script></div><!--Menu-->
141 <!--START_ND_TOOLTIPS-->
142 <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 nowrap>element: function(</td><td class=PParameter nowrap>event</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Cross browser event element detection.</div></div><div class=CToolTip id="tt2"><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 nowrap>isLeftClick: function(</td><td class=PParameter nowrap>event</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Determine whether event was caused by a left click.</div></div><div class=CToolTip id="tt3"><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 nowrap>isRightClick: function(</td><td class=PParameter nowrap>event</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Determine whether event was caused by a right mouse click.</div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>stop: function(</td><td class=PParameter nowrap>event,</td></tr><tr><td></td><td class=PParameter nowrap>allowDefault</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Stops an event from propagating.</div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>findElement: function(</td><td class=PParameter nowrap>event,</td></tr><tr><td></td><td class=PParameter nowrap>tagName</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>observe: function(</td><td class=PParameter nowrap>elementParam,</td></tr><tr><td></td><td class=PParameter nowrap>name,</td></tr><tr><td></td><td class=PParameter nowrap>observer,</td></tr><tr><td></td><td class=PParameter nowrap>useCapture</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters nowrap>stopObservingElement: function(</td><td class=PParameter nowrap>elementParam</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Given the id of an element to stop observing, cycle through the element’s cached observers, calling stopObserving on each one, skipping those entries which can no longer be removed.</div></div><div class=CToolTip id="tt8"><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 nowrap>_removeElementObservers: function(</td><td class=PParameter nowrap>elementObservers</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></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 nowrap>stopObserving: function(</td><td class=PParameter nowrap>elementParam,</td></tr><tr><td></td><td class=PParameter nowrap>name,</td></tr><tr><td></td><td class=PParameter nowrap>observer,</td></tr><tr><td></td><td class=PParameter nowrap>useCapture</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>unloadCache: function()</td></tr></table></blockquote>Cycle through all the element entries in the events cache and call stopObservingElement on each.</div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>clearMouseCache: function()</td></tr></table></blockquote>Clear cached data about the mouse position. </div></div><div class=CToolTip id="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>destroy: function ()</td></tr></table></blockquote></div></div><div class=CToolTip id="tt13"><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 nowrap>addEventType: function(</td><td class=PParameter nowrap>eventName</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Add a new event type to this events object. </div></div><div class=CToolTip id="tt14"><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 nowrap>attachToElement: function (</td><td class=PParameter nowrap>element</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt15"><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 nowrap>on: function(</td><td class=PParameter nowrap>object</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Convenience method for registering listeners with a common scope.</div></div><div class=CToolTip id="tt16"><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 nowrap>register: function (</td><td class=PParameter nowrap>type,</td></tr><tr><td></td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>func</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Register an event on the events object.</div></div><div class=CToolTip id="tt17"><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 nowrap>registerPriority: function (</td><td class=PParameter nowrap>type,</td></tr><tr><td></td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>func</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Same as register() but adds the new listener to the <b>front</b> of the events queue instead of to the end.</div></div><div class=CToolTip id="tt18"><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 nowrap>un: function(</td><td class=PParameter nowrap>object</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Convenience method for unregistering listeners with a common scope.</div></div><div class=CToolTip id="tt19"><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 nowrap>unregister: function (</td><td class=PParameter nowrap>type,</td></tr><tr><td></td><td class=PParameter nowrap>obj,</td></tr><tr><td></td><td class=PParameter nowrap>func</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt20"><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 nowrap>remove: function(</td><td class=PParameter nowrap>type</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Remove all listeners for a given event type. </div></div><div class=CToolTip id="tt21"><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 nowrap>triggerEvent: function (</td><td class=PParameter nowrap>type,</td></tr><tr><td></td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Trigger a specified registered event.</div></div><div class=CToolTip id="tt22"><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 nowrap>handleBrowserEvent: function (</td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Basically just a wrapper to the triggerEvent() function, but takes care to set a property ‘xy’ on the event with the current mouse position.</div></div><div class=CToolTip id="tt23"><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 nowrap>getMousePosition: function (</td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></div></div><div class=CToolTip id="tt24"><div class=CClass>This class represents a screen coordinate, in x and y coordinates</div></div><!--END_ND_TOOLTIPS-->
147 <div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
150 <script language=JavaScript><!--
151 if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
projects / syp.git / blob