Documentation for Control classes.

git-svn-id: http://svn.openlayers.org/trunk/openlayers@1247 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf

doc/Control.LayerSwitcher.txt

@@ -0,0 +1,14 @@
+OpenLayers.Control.LayerSwitcher
+
+This control will by default display a small image in the upper right corner of the map. When clicked, this image expands into a control which allows one to select between multiple types of layers, seperated into two types: Base Layers and Overlays. Only one base layer can be selected at a time, and is enforced by a radio button control being used. Multiple overlays can be selected at once, and a checkbox control is visible for this functionality.
+* Constructor
+  OpenLayers.Control.LayerSwitcher({Object|options}?) -- Creates a new control.
+
+* Methods
+  maximizeControl() -- none -- Expand the layer switcher control.
+  minimizeControl() -- none -- Close the layer switcher control.
+
+* Parameters
+  position -- (inherited from {OpenLayers.Control}) {OpenLayers.Pixel} to use as the top-left corner of the control div, relative to the map area.
+  activeColor -- The color to use for the background of the layer switcher div.
+

doc/Control.MouseDefaults.txt

@@ -0,0 +1,19 @@
+OpenLayers.Control.MouseDefaults
+
+Control to set up mouse handling. This includes clicks, double clicks, scrollwheel events, and mouse movement. There are a number of functions which act as the default handlers for these events: if you wish to create your own mouse control which behaves differently, you should create a subclass of MouseDefaults, replacing the functions whose behavior you wish to change.
+
+
+* Constructor
+  OpenLayers.Control() -- Creates a new control. No options available. 
+
+* Methods
+  defaultClick -- none -- This event takes place when a click event occurs on the map.
+  defaultDblClick -- none -- This event re-centers the map on the clicked location.
+  defaultMouseDown -- none -- This event starts a dragging event, so that the map can be dragged. If the shift key is held, it starts a 'zoombox' or rubber-band-zoom action instead.
+  defaultMouseMove -- none -- If a mouseDrag is in operation, this function causes the map to move to follow the cursor. If a zoombox is in place, this increases the size of the zoombox element to match the cursor.
+  defaultMouseUp -- none -- This function is called when a mouseup event is received, and either sets the center of the map to be the final location or zooms to the zoombox if enabled.
+  defaultMouseOut -- none -- This calls defaultMouseUp, so that when you mouse out of the map div, the events are stopped.
+  defaultWheelUp -- none -- Zooms in one level. Called by onWheelEvent
+  defaultWheelDown -- none -- Zooms out one level. Called by onWheelEvent.
+  onWheelEvent -- none -- catches the map wheel event, and handles it, zooming appropriately. 
+  

doc/Control.MouseToolbar.txt

@@ -0,0 +1,15 @@
+OpenLayers.Control.MouseDefaults
+
+Control to set up mouse handling. This includes clicks, double clicks, scrollwheel events, and mouse movement. There are a number of functions which act as the default handlers for these events: if you wish to create your own mouse control which behaves differently, you should create a subclass of MouseToolbar, replacing the functions whose behavior you wish to change. Additionally, a toolbar of images can be clicked to start events, as well as using the keyboard shortcuts.
+
+* Constructor
+  OpenLayers.Control.MouseToolbar({OpenLayers.Pixel|position}, {String|direction}) -- Creates a new control. The direction of the control can be either "vertical" or "horizontal". The default is vertical.
+
+* Methods
+  defaultClick -- none -- This event takes place when a click event occurs on the map.
+  defaultDblClick -- none -- This event re-centers the map on the clicked location.
+  defaultMouseDown -- none -- This event starts a dragging event, so that the map can be dragged. If the shift key is held, it starts a 'zoombox' or rubber-band-zoom action instead.
+  defaultMouseMove -- none -- If a mouseDrag is in operation, this function causes the map to move to follow the cursor. If a zoombox is in place, this increases the size of the zoombox element to match the cursor.
+  defaultMouseUp -- none -- This function is called when a mouseup event is received, and either sets the center of the map to be the final location or zooms to the zoombox if enabled.
+  defaultMouseOut -- none -- This calls defaultMouseUp, so that when you mouse out of the map div, the events are stopped.
+  

doc/Control.PanZoom.txt

@@ -0,0 +1,9 @@
+OpenLayers.Control.PanZoom
+
+Creates a small toolset for controlling the location of the map with panning and zooming, including four directional arrows, a zoom in and zoom out, and one button which zooms to the max extent of the map.
+
+* Constructor
+  OpenLayers.Control.PanZoom({Object|options}) -- Creates a new panzoom control.
+
+* Parameters
+  slideFactor -- Number of pixels by which to slide the map when a pan arrow is clicked.

doc/Control.PanZoomBar.txt

@@ -0,0 +1,6 @@
+OpenLayers.Control.PanZoom
+
+Creates a small toolset for controlling the location of the map with panning and zooming, including four directional arrows, a zoom in and zoom out, and a bar on which a slider can be moved to zoom in or out by multiple stops at once.
+
+* Constructor
+  OpenLayers.Control.PanZoomBar() -- Creates a new panzoombar control.

doc/Control.Permalink.txt

@@ -0,0 +1,6 @@
+OpenLayers.Control.Permalink
+
+A small control which updates a "Permalink" to the map every time the viewport changes. This allows users to copy a link to a specfic map view. By default, it places itself in the lower right corner of the map, 
+
+* Constructor
+  OpenLayers.Control.Scale({DOMElement|element}?, {String|base}) -- Creates a new permalink control. The DOMElement is used, if passed, as the element on which the 'href' is set. If you prefer to put this link on an element outside of the map, set this element to an anchor element to have its href updated when the map moves. If you wish to make the link go to some other URL (for example, an editing interface rather than the current URL), the 'base' property can be used, to which the ?lat=&lon=&zoom= will be appended after the map has moved.

doc/Control.Scale.txt

@@ -0,0 +1,6 @@
+OpenLayers.Control.Scale
+
+A small control which displays an informative scale value, a la "1:50K" , by defualt in the lower right of the map viewport.
+
+* Constructor
+  OpenLayers.Control.Scale({DOMElement|element}?) -- Creates a new scale control. The DOMElement is used, if passed, to put the scale inside -- this allows you to have the scale displayed in some location outside the map. 

doc/Control.txt

@@ -0,0 +1,9 @@
+OpenLayers.Control
+
+Base class from which controls are derived. Controls are elements of the map used to control things like zoom, layer status, or to provide information to the user about the status of the map, such as scale or copyright information.
+
+* Constructor
+  OpenLayers.Control({Object|options}?) -- Creates a new control. The options here are used to control parameters of the control. The base control defines only "position", which is designed to be an {OpenLayers.Pixel} which is the top-left of the location of the control relative to the map div. 
+
+* Parameters
+  position -- {OpenLayers.Pixel} to use as the top-left corner of the control div, relative to the map area.