ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Files
0494b1fc1820edd83ded765b23f8df65537e858c
openlayers/files/OpenLayers/Control-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

55 lines
20 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.Control - 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 id=MSelected>Control</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><a href="Events-js.html">Events</a></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 != 1 && menu != 9){document.getElementById("MGroupContent" + menu).style.display = "none";};};}// --></script><!--END_ND_MENU--></td>
<td class=ContentSection valign=top><div class=CClass id=MainTopic><div class=CTopic><h1 class=CTitle><a name="OpenLayers.Control"></a>OpenLayers.<span class=HB> </span>Control</h1><div class=CBody><p class=CParagraph>Controls affect the display or behavior of the map.&nbsp; They allow everything from panning and zooming to displaying a scale indicator.</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=SMain><div class=SEntry><a href="#OpenLayers.Control" >OpenLayers.<span class=HB> </span>Control</a></div></div></td><td class=SDescriptionSize><div class=SMain><div class=SDescription>Controls affect the display or behavior of the map. </div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Control.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.Control.id" >id</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{String}</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Control.map" >map</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{OpenLayers.Map} this gets set in the addControl() function in OpenLayers.Map</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Control.div" >div</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{DOMElement}</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Control.type" >type</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{OpenLayers.Control.TYPES} Controls can have a &lsquo;type&rsquo;. </div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Control.displayClass" >displayClass</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{string} This property is used for CSS related to the drawing of the Control.</div></div></div></td></tr><tr><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Control.active" >active</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{boolean} null</div></div></div></td></tr><tr class=SMarked><td><div class=SProperty><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Control.handler" >handler</a></div></div></div></td><td><div class=SProperty><div class=SDescription><div class=SIndent2>{&lt;OpenLayers.Handler}&gt; null</div></div></div></td></tr><tr><td><div class=SGroup><div class=SEntry><div class=SIndent1><a href="#OpenLayers.Control.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.Control.OpenLayers.Control" >OpenLayers.<span class=HB> </span>Control</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Create an OpenLayers Control.</div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Control.destroy" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">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.Control.setMap" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">setMap</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>Set the map property for the control. </div></div></div></td></tr><tr><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Control.draw" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">draw</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.Control.moveTo" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">moveTo</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.Control.activate" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">activate</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>{Boolean}</div></div></div></td></tr><tr class=SMarked><td><div class=SFunction><div class=SEntry><div class=SIndent2><a href="#OpenLayers.Control.deactivate" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">deactivate</a></div></div></div></td><td><div class=SFunction><div class=SDescription><div class=SIndent2>{Boolean}</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.Control.Properties"></a>Properties</h3></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.id"></a>id</h3><div class=CBody><p class=CParagraph>{String}</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.map"></a>map</h3><div class=CBody><p class=CParagraph>{OpenLayers.Map} this gets set in the addControl() function in OpenLayers.Map</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.div"></a>div</h3><div class=CBody><p class=CParagraph>{DOMElement}</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.type"></a>type</h3><div class=CBody><p class=CParagraph>{OpenLayers.Control.TYPES} Controls can have a &lsquo;type&rsquo;.&nbsp; The type determines the type of interactions which are possible with them when they are placed into a toolbar.</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.displayClass"></a>displayClass</h3><div class=CBody><p class=CParagraph>{string} This property is used for CSS related to the drawing of the Control.</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.active"></a>active</h3><div class=CBody><p class=CParagraph>{boolean} null</p></div></div></div>
<div class=CProperty><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.handler"></a>handler</h3><div class=CBody><p class=CParagraph>{&lt;OpenLayers.Handler}&gt; null</p></div></div></div>
<div class=CGroup><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.Functions"></a>Functions</h3></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.OpenLayers.Control"></a>OpenLayers.<span class=HB> </span>Control</h3><div class=CBody><p class=CParagraph>Create an OpenLayers Control.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>options</td><td class=CDLDescription>{Object}</td></tr></table></div></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.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.Control.setMap"></a>setMap</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>setMap: function(</td><td class=PParameter nowrap>map</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote><p class=CParagraph>Set the map property for the control.&nbsp; This is done through an accessor so that subclasses can override this and take special action once they have their map variable set.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>map</td><td class=CDLDescription>{OpenLayers.Map}</td></tr></table></div></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.draw"></a>draw</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>draw: function (</td><td class=PParameter nowrap>px</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>px</td><td class=CDLDescription>{OpenLayers.Pixel}</td></tr></table><h4 class=CHeading>Return</h4><p class=CParagraph>{DOMElement} A reference to the DIV DOMElement containing the control</p></div></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.moveTo"></a>moveTo</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>moveTo: function (</td><td class=PParameter nowrap>px</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>px</td><td class=CDLDescription>{OpenLayers.Pixel}</td></tr></table></div></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.activate"></a>activate</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>activate: function ()</td></tr></table></blockquote><h4 class=CHeading>Return</h4><p class=CParagraph>{Boolean}</p></div></div></div>
<div class=CFunction><div class=CTopic><h3 class=CTitle><a name="OpenLayers.Control.deactivate"></a>deactivate</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>deactivate: function ()</td></tr></table></blockquote><h4 class=CHeading>Return</h4><p class=CParagraph>{Boolean}</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>destroy: function ()</td></tr></table></blockquote></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>setMap: function(</td><td class=PParameter nowrap>map</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote>Set the map property for the control. </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>draw: function (</td><td class=PParameter nowrap>px</td><td class=PAfterParameters nowrap>)</td></tr></table></td></tr></table></blockquote></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>moveTo: function (</td><td class=PParameter nowrap>px</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>activate: function ()</td></tr></table></blockquote>{Boolean}</div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class=Prototype><tr><td>deactivate: function ()</td></tr></table></blockquote>{Boolean}</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