ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Files
0494b1fc1820edd83ded765b23f8df65537e858c
openlayers/files/OpenLayers/Events-js.html
Tim Schaub 20feef1ae6 commit dev doc example 
git-svn-id: http://svn.openlayers.org/sandbox/tschaub/naturaldocs/doc@3432 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
2007-06-22 22:50:49 +00:00

107 lines
62 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
<html><head><title>OpenLayers.Events - OpenLayers</title><link rel="stylesheet" type="text/css" href="../../styles/main.css"><script language=JavaScript src="../../javascript/main.js"></script></head><body class=UnframedPage onLoad="NDOnLoad()"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.35 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td class=MenuSection valign=top><!--START_ND_MENU--><div class=MTitle>OpenLayers<div class=MSubTitle>JavaScript Mapping Library</div></div><div class=MEntry><div class=MFile><a href="../OpenLayers-js.html">OpenLayers</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent9')">OpenLayers</a><div class=MGroupContent id=MGroupContent9><div class=MEntry><div class=MFile><a href="BaseTypes-js.html">Base Types</a></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('MGroupContent1')">Control</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MFile><a href="Control-js.html">Control</a></div></div><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/ZoomToMaxExtent-js.html">ZoomToMaxExtent</a></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('MGroupContent2')">Feature</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MFile><a href="Feature-js.html">Feature</a></div></div><div class=MEntry><div class=MFile><a href="Feature/WFS-js.html">WFS</a></div></div><div class=MEntry><div class=MFile><a href="Feature/Vector-js.html">Vector</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent3')">Format</a><div class=MGroupContent id=MGroupContent3><div class=MEntry><div class=MFile><a href="Format-js.html">Format</a></div></div><div class=MEntry><div class=MFile><a href="Format/WKT-js.html">WKT</a></div></div></div></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent4')">Geometry</a><div class=MGroupContent id=MGroupContent4><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/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></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent5')">Handler</a><div class=MGroupContent id=MGroupContent5><div class=MEntry><div class=MFile><a href="Handler-js.html">Handler</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/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></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('MGroupContent6')">Layer</a><div class=MGroupContent id=MGroupContent6><div class=MEntry><div class=MFile><a href="Layer-js.html">Layer</a></div></div><div class=MEntry><div class=MFile><a href="Layer/GeoRSS-js.html">Layer.<span class=HB> </span>GeoRSS</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Image-js.html">Layer.<span class=HB> </span>Image</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Markers-js.html">Layer.<span class=HB> </span>Markers</a></div></div><div class=MEntry><div class=MFile><a href="Layer/Vector-js.html">Layer.<span class=HB> </span>Vector</a></div></div><div class=MEntry><div class=MFile><a href="Layer/WMS-js.html">Layer.WMS</a></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('MGroupContent7')">Marker</a><div class=MGroupContent id=MGroupContent7><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=MFile><a href="Popup-js.html">Popup</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent8')">Tile</a><div class=MGroupContent id=MGroupContent8><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></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent10')">Index</a><div class=MGroupContent id=MGroupContent10><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></div></div><script language=JavaScript><!--
if (document.getElementById){for (var menu = 1; menu < 11; menu++){if (menu != 9 && menu != 1){document.getElementById("MGroupContent" + menu).style.display = "none";};};}// --></script><!--END_ND_MENU--></td>
<td class=ContentSection valign=top><div class=CSection id=MainTopic><div class=CTopic><h1 class=CTitle><a name="OpenLayers.Events"></a>OpenLayers.<span class=HB> </span>Events</h1><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><td class=SEntrySize><div class=SMain><div class=SEntry><a href="#OpenLayers.Events" >OpenLayers.<span class=HB> </span>Events</a></div></div></td><td class=SDescriptionSize><div class=SMain><div class=SDescription></div></div></td></tr><tr><td><div class=SClass><div class=SEntry><a href="#OpenLayers.Event" >OpenLayers.<span class=HB> </span>Event</a></div></div></td><td><div class=SClass><div class=SDescription>Utility functions for event handling.</div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.Properties" >Properties</a></div></div></div></td><td><div class=SGroup><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.observers" >observers</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Object} A hashtable cache of the event observers. </div></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.Constants" >Constants</a></div></div></div></td><td><div class=SGroup><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SConstant><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.KEY_BACKSPACE" >KEY_BACKSPACE</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent2>{int}</div></div></div></td></tr><tr><td><div class=SConstant><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.KEY_TAB" >KEY_TAB</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent2>{int}</div></div></div></td></tr><tr class=SMarked><td><div class=SConstant><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.KEY_RETURN" >KEY_RETURN</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent2>{int}</div></div></div></td></tr><tr><td><div class=SConstant><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.KEY_ESC" >KEY_ESC</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent2>{int}</div></div></div></td></tr><tr class=SMarked><td><div class=SConstant><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.KEY_LEFT" >KEY_LEFT</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent2>{int}</div></div></div></td></tr><tr><td><div class=SConstant><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.KEY_UP" >KEY_UP</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent2>{int}</div></div></div></td></tr><tr class=SMarked><td><div class=SConstant><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.KEY_RIGHT" >KEY_RIGHT</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent2>{int}</div></div></div></td></tr><tr><td><div class=SConstant><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.KEY_DOWN" >KEY_DOWN</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent2>{int}</div></div></div></td></tr><tr class=SMarked><td><div class=SConstant><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.KEY_DELETE" >KEY_DELETE</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent2>{int}</div></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.Functions" >Functions</a></div></div></div></td><td><div class=SGroup><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.element" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">element</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Cross browser event element detection.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.isLeftClick" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">isLeftClick</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Determine whether event was caused by a left click.</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.stop" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">stop</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Stops an event from propagating.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.findElement" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">findElement</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2></div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.observe" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">observe</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2></div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.stopObservingElement" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">stopObservingElement</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Given the id of an element to stop observing, cycle through the element&rsquo;s cached observers, calling stopObserving on each one, skipping those entries which can no longer be removed.</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event._removeElementObservers" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">_removeElementObservers</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2><b>Private</b>.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.stopObserving" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">stopObserving</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2></div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Event.unloadCache" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">unloadCache</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Cycle through all the element entries in the events cache and call stopObservingElement on each.</div></div></div></td></tr><tr><td><div class=SClass><div class=SEntry><a href="#OpenLayers.Events" >OpenLayers.<span class=HB> </span>Events</a></div></div></td><td><div class=SClass><div class=SDescription></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.Properties" >Properties</a></div></div></div></td><td><div class=SGroup><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Events.listeners" >listeners</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Object} Hashtable of Array(Function): events listener functions</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Events.object" >object</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Object} the code object issuing application events</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Events.element" >element</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{DOMElement} the DOM element receiving browser events</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Events.eventTypes" >eventTypes</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Array} list of support application events</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Events.eventHandler" >eventHandler</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Function} bound event handler attached to elements</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Events.fallThrough" >fallThrough</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{Boolean}</div></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.Functions" >Functions</a></div></div></div></td><td><div class=SGroup><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Events.OpenLayers.Events" >OpenLayers.<span class=HB> </span>Events</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Construct an OpenLayers.Events object.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Events.destroy" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">destroy</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2></div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Events.attachToElement" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">attachToElement</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2></div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Events.register" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">register</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Register an event on the events object.</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Events.registerPriority" id=link13 onMouseOver="ShowTip(event, 'tt13', 'link13')" onMouseOut="HideTip('tt13')">registerPriority</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2></div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Events.unregister" id=link14 onMouseOver="ShowTip(event, 'tt14', 'link14')" onMouseOut="HideTip('tt14')">unregister</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2></div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Events.remove" id=link15 onMouseOver="ShowTip(event, 'tt15', 'link15')" onMouseOut="HideTip('tt15')">remove</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Remove all listeners for a given event type. </div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Events.triggerEvent" id=link16 onMouseOver="ShowTip(event, 'tt16', 'link16')" onMouseOut="HideTip('tt16')">triggerEvent</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Trigger a specified registered event</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Events.handleBrowserEvent" id=link17 onMouseOver="ShowTip(event, 'tt17', 'link17')" onMouseOut="HideTip('tt17')">handleBrowserEvent</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Basically just a wrapper to the triggerEvent() function, but takes care to set a property &lsquo;xy&rsquo; on the event with the current mouse position.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Events.getMousePosition" id=link18 onMouseOver="ShowTip(event, 'tt18', 'link18')" onMouseOut="HideTip('tt18')">getMousePosition</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2><b>Private</b></div></div></div></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class=CClass><div class=CTopic><h2 class=CTitle><a name="OpenLayers.Event"></a>OpenLayers.<span class=HB> </span>Event</h2><div class=CBody><p class=CParagraph>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><td class=SEntrySize><div class=SGroup><div class=SEntry><a href="#OpenLayers.Event.Properties" >Properties</a></div></div></td><td class=SDescriptionSize><div class=SGroup><div class=SDescription></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.observers" >observers</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent1>{Object} A hashtable cache of the event observers. </div></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><a href="#OpenLayers.Event.Constants" >Constants</a></div></div></td><td><div class=SGroup><div class=SDescription></div></div></td></tr><tr class=SMarked><td><div class=SConstant><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.KEY_BACKSPACE" >KEY_BACKSPACE</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent1>{int}</div></div></div></td></tr><tr><td><div class=SConstant><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.KEY_TAB" >KEY_TAB</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent1>{int}</div></div></div></td></tr><tr class=SMarked><td><div class=SConstant><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.KEY_RETURN" >KEY_RETURN</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent1>{int}</div></div></div></td></tr><tr><td><div class=SConstant><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.KEY_ESC" >KEY_ESC</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent1>{int}</div></div></div></td></tr><tr class=SMarked><td><div class=SConstant><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.KEY_LEFT" >KEY_LEFT</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent1>{int}</div></div></div></td></tr><tr><td><div class=SConstant><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.KEY_UP" >KEY_UP</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent1>{int}</div></div></div></td></tr><tr class=SMarked><td><div class=SConstant><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.KEY_RIGHT" >KEY_RIGHT</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent1>{int}</div></div></div></td></tr><tr><td><div class=SConstant><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.KEY_DOWN" >KEY_DOWN</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent1>{int}</div></div></div></td></tr><tr class=SMarked><td><div class=SConstant><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.KEY_DELETE" >KEY_DELETE</a></div></div></div></td><td><div class=SConstant><div class=SDescription><div class=SIndent1>{int}</div></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><a href="#OpenLayers.Event.Functions" >Functions</a></div></div></td><td><div class=SGroup><div class=SDescription></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.element" id=link19 onMouseOver="ShowTip(event, 'tt1', 'link19')" onMouseOut="HideTip('tt1')">element</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>Cross browser event element detection.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.isLeftClick" id=link20 onMouseOver="ShowTip(event, 'tt2', 'link20')" onMouseOut="HideTip('tt2')">isLeftClick</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>Determine whether event was caused by a left click.</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.stop" id=link21 onMouseOver="ShowTip(event, 'tt3', 'link21')" onMouseOut="HideTip('tt3')">stop</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>Stops an event from propagating.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.findElement" id=link22 onMouseOver="ShowTip(event, 'tt4', 'link22')" onMouseOut="HideTip('tt4')">findElement</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.observe" id=link23 onMouseOver="ShowTip(event, 'tt5', 'link23')" onMouseOut="HideTip('tt5')">observe</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.stopObservingElement" id=link24 onMouseOver="ShowTip(event, 'tt6', 'link24')" onMouseOut="HideTip('tt6')">stopObservingElement</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>Given the id of an element to stop observing, cycle through the element&rsquo;s cached observers, calling stopObserving on each one, skipping those entries which can no longer be removed.</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event._removeElementObservers" id=link25 onMouseOver="ShowTip(event, 'tt7', 'link25')" onMouseOut="HideTip('tt7')">_removeElementObservers</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1><b>Private</b>.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.stopObserving" id=link26 onMouseOver="ShowTip(event, 'tt8', 'link26')" onMouseOut="HideTip('tt8')">stopObserving</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Event.unloadCache" id=link27 onMouseOver="ShowTip(event, 'tt9', 'link27')" onMouseOut="HideTip('tt9')">unloadCache</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>Cycle through all the element entries in the events cache and call stopObservingElement on each.</div></div></div></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.Properties"></a>Properties</h3></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.observers"></a>observers</h3><div class=CBody><p class=CParagraph>{Object} A hashtable cache of the event observers.&nbsp; Keyed by element._eventCacheID</p></div></div></div>
<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.Constants"></a>Constants</h3></div></div>
<div class=CConstant><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_BACKSPACE"></a>KEY_BACKSPACE</h3><div class=CBody><p class=CParagraph>{int}</p></div></div></div>
<div class=CConstant><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_TAB"></a>KEY_TAB</h3><div class=CBody><p class=CParagraph>{int}</p></div></div></div>
<div class=CConstant><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_RETURN"></a>KEY_RETURN</h3><div class=CBody><p class=CParagraph>{int}</p></div></div></div>
<div class=CConstant><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_ESC"></a>KEY_ESC</h3><div class=CBody><p class=CParagraph>{int}</p></div></div></div>
<div class=CConstant><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_LEFT"></a>KEY_LEFT</h3><div class=CBody><p class=CParagraph>{int}</p></div></div></div>
<div class=CConstant><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_UP"></a>KEY_UP</h3><div class=CBody><p class=CParagraph>{int}</p></div></div></div>
<div class=CConstant><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_RIGHT"></a>KEY_RIGHT</h3><div class=CBody><p class=CParagraph>{int}</p></div></div></div>
<div class=CConstant><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_DOWN"></a>KEY_DOWN</h3><div class=CBody><p class=CParagraph>{int}</p></div></div></div>
<div class=CConstant><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.KEY_DELETE"></a>KEY_DELETE</h3><div class=CBody><p class=CParagraph>{int}</p></div></div></div>
<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Event.Functions"></a>Functions</h3></div></div>
<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 class=CParagraph>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 class=CParagraph>{DOMElement} The element that caused the event</p></div></div></div>
<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 class=CParagraph>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 class=CParagraph>{Boolean}</p></div></div></div>
<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 class=CParagraph>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>
<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>Return</h4><p class=CParagraph>{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>
<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>
<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 class=CParagraph>Given the id of an element to stop observing, cycle through the element&rsquo;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>
<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><p class=CParagraph><b>Private</b>.</p><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>
<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><p class=CParagraph>@returns {Boolean} Whether or not the event observer was removed</p></div></div></div>
<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 class=CParagraph>Cycle through all the element entries in the events cache and call stopObservingElement on each.</p></div></div></div>
<div class=CClass><div class=CTopic><h2 class=CTitle><a name="OpenLayers.Events"></a>OpenLayers.<span class=HB> </span>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><td class=SEntrySize><div class=SGroup><div class=SEntry><a href="#OpenLayers.Events.Properties" >Properties</a></div></div></td><td class=SDescriptionSize><div class=SGroup><div class=SDescription></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.listeners" >listeners</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent1>{Object} Hashtable of Array(Function): events listener functions</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.object" >object</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent1>{Object} the code object issuing application events</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.element" >element</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent1>{DOMElement} the DOM element receiving browser events</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.eventTypes" >eventTypes</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent1>{Array} list of support application events</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.eventHandler" >eventHandler</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent1>{Function} bound event handler attached to elements</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.fallThrough" >fallThrough</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent1>{Boolean}</div></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><a href="#OpenLayers.Events.Functions" >Functions</a></div></div></td><td><div class=SGroup><div class=SDescription></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.OpenLayers.Events" >OpenLayers.<span class=HB> </span>Events</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>Construct an OpenLayers.Events object.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.destroy" id=link28 onMouseOver="ShowTip(event, 'tt10', 'link28')" onMouseOut="HideTip('tt10')">destroy</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.attachToElement" id=link29 onMouseOver="ShowTip(event, 'tt11', 'link29')" onMouseOut="HideTip('tt11')">attachToElement</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.register" id=link30 onMouseOver="ShowTip(event, 'tt12', 'link30')" onMouseOut="HideTip('tt12')">register</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>Register an event on the events object.</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.registerPriority" id=link31 onMouseOver="ShowTip(event, 'tt13', 'link31')" onMouseOut="HideTip('tt13')">registerPriority</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.unregister" id=link32 onMouseOver="ShowTip(event, 'tt14', 'link32')" onMouseOut="HideTip('tt14')">unregister</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1></div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.remove" id=link33 onMouseOver="ShowTip(event, 'tt15', 'link33')" onMouseOut="HideTip('tt15')">remove</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>Remove all listeners for a given event type. </div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.triggerEvent" id=link34 onMouseOver="ShowTip(event, 'tt16', 'link34')" onMouseOut="HideTip('tt16')">triggerEvent</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>Trigger a specified registered event</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.handleBrowserEvent" id=link35 onMouseOver="ShowTip(event, 'tt17', 'link35')" onMouseOut="HideTip('tt17')">handleBrowserEvent</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1>Basically just a wrapper to the triggerEvent() function, but takes care to set a property &lsquo;xy&rsquo; on the event with the current mouse position.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Events.getMousePosition" id=link36 onMouseOver="ShowTip(event, 'tt18', 'link36')" onMouseOut="HideTip('tt18')">getMousePosition</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent1><b>Private</b></div></div></div></td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.Properties"></a>Properties</h3></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.listeners"></a>listeners</h3><div class=CBody><p class=CParagraph>{Object} Hashtable of Array(Function): events listener functions</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.object"></a>object</h3><div class=CBody><p class=CParagraph>{Object} the code object issuing application events</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.element"></a>element</h3><div class=CBody><p class=CParagraph>{DOMElement} the DOM element receiving browser events</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.eventTypes"></a>eventTypes</h3><div class=CBody><p class=CParagraph>{Array} list of support application events</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.eventHandler"></a>eventHandler</h3><div class=CBody><p class=CParagraph>{Function} bound event handler attached to elements</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.fallThrough"></a>fallThrough</h3><div class=CBody><p class=CParagraph>{Boolean}</p></div></div></div>
<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.Functions"></a>Functions</h3></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Events.OpenLayers.Events"></a>OpenLayers.<span class=HB> </span>Events</h3><div class=CBody><p class=CParagraph>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} 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></table></div></div></div>
<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>
<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>
<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 class=CParagraph>Register an event on the events object.</p><p class=CParagraph>When the event is triggered, the &lsquo;func&rsquo; function will be called, in the context of &lsquo;obj&rsquo;.&nbsp; Imagine we were to register an event, specifying an OpenLayers.Bounds Object as &lsquo;obj&rsquo;.&nbsp; When the event is triggered, the context in the callback function will be our Bounds object.&nbsp; This means that within our callback function, we can access the properties and methods of the Bounds object through the &ldquo;this&rdquo; variable.&nbsp; So our callback could execute something like:</p><blockquote><pre class=CCode>leftStr = &quot;Left: &quot; + this.left;</pre></blockquote><p class=CParagraph>or</p><blockquote><pre class=CCode>centerStr = &quot;Center: &quot; + 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#.&nbsp; If no object is specified, default is the Events&rsquo;s &lsquo;object&rsquo; property.</td></tr><tr><td class=CDLEntry>func</td><td class=CDLDescription>{Function} The callback function.&nbsp; If no callback is specified, this function does nothing.</td></tr></table></div></div></div>
<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><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#.&nbsp; If no object is specified, default is the Events&rsquo;s &lsquo;object&rsquo; property.</td></tr><tr><td class=CDLEntry>func</td><td class=CDLDescription>{Function} The callback function.&nbsp; If no callback is specified, this function does nothing.</td></tr></table></div></div></div>
<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>
<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 class=CParagraph>Remove all listeners for a given event type.&nbsp; 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>
<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 class=CParagraph>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></div></div></div>
<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 class=CParagraph>Basically just a wrapper to the triggerEvent() function, but takes care to set a property &lsquo;xy&rsquo; on the event with the current mouse position.</p><p class=CParagraph>Private function.</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>
<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><p class=CParagraph><b>Private</b></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><p class=CParagraph>Returns {<a href="BaseTypes-js.html#OpenLayers.Pixel" class=LClass id=link37 onMouseOver="ShowTip(event, 'tt19', 'link37')" onMouseOut="HideTip('tt19')">OpenLayers.Pixel</a>} The current xy coordinate of the mouse, adjusted for offsets</p></div></div></div>
</td>
</tr></table><div class=Footer><!--START_ND_FOOTER-->Generated by <a href="http://www.naturaldocs.org">Natural Docs</a><!--END_ND_FOOTER--></div>
<!--START_ND_TOOLTIPS-->
<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>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="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>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="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>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="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>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&rsquo;s cached observers, calling stopObserving on each one, skipping those entries which can no longer be removed.</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>_removeElementObservers: function(</td><td class=PParameter nowrap>elementObservers</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><b>Private</b>.</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>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="tt9"><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="tt10"><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="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters 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="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class=PBeforeParameters 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="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>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></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>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="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>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="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>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="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>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 &lsquo;xy&rsquo; on the event with the current mouse position.</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>getMousePosition: function (</td><td class=PParameter nowrap>evt</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><b>Private</b></div></div><div class=CToolTip id="tt19"><div class=CClass>This class represents a screen coordinate, in x and y coordinates</div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
Reference in New Issue View Git Blame Copy Permalink