[OpenLayers-Commits] r2294 - sandbox/vector/doc
commits at openlayers.org
commits at openlayers.org
Fri Mar 2 02:52:56 EST 2007
Author: bertil
Date: 2007-03-02 02:52:50 -0500 (Fri, 02 Mar 2007)
New Revision: 2294
Added:
sandbox/vector/doc/Control.EditingMode.PointArraySnapping.txt
sandbox/vector/doc/Control.EditingMode.PointSnapping.txt
sandbox/vector/doc/Control.EditingMode.SegmentSnapping.txt
sandbox/vector/doc/Control.EditingMode.txt
sandbox/vector/doc/Layer.Vector.txt
sandbox/vector/doc/Layer.WFS.txt
sandbox/vector/doc/MouseListener.EditingListener.AddPathPoint.txt
sandbox/vector/doc/MouseListener.EditingListener.DrawLineString.txt
sandbox/vector/doc/MouseListener.EditingListener.DrawLinearRing.txt
sandbox/vector/doc/MouseListener.EditingListener.DrawPoint.txt
sandbox/vector/doc/MouseListener.EditingListener.MovePathPoint.txt
sandbox/vector/doc/MouseListener.EditingListener.PolygonHoleCutter.txt
sandbox/vector/doc/MouseListener.EditingListener.RemovePathPoint.txt
sandbox/vector/doc/MouseListener.EditingListener.Selection.txt
sandbox/vector/doc/MouseListener.EditingListener.txt
sandbox/vector/doc/MouseListener.MeasureArea.txt
sandbox/vector/doc/MouseListener.MeasureDistance.txt
sandbox/vector/doc/MouseListener.MouseDefaults.txt
sandbox/vector/doc/MouseListener.txt
Log:
documentation
Added: sandbox/vector/doc/Control.EditingMode.PointArraySnapping.txt
===================================================================
--- sandbox/vector/doc/Control.EditingMode.PointArraySnapping.txt (rev 0)
+++ sandbox/vector/doc/Control.EditingMode.PointArraySnapping.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,14 @@
+OpenLayers.Control.EditingMode.PointArraySnapping
+
+EditingMode that allows for snapping on vertices on geometries of all features in all available vector layers. Is used by push the crtl key down.
+
+
+* Constructor
+ OpenLayers.Control.EditingMode.PointArraySnapping() -- Creates a new PointArraySnapping. No options available.
+
+* Methods
+ calculatePoint({OpenLayers.Geometry.Point}, {OpenLayers.Geometry}) -- none -- Calculate the position of the point to snap to. Loops on all vector layers to find the closest the vertex using snappingTolerance set for the map.
+ All other methods are inherited from {OpenLayers.Layer.EditingMode}
+
+* Parameters
+ isSnappingTypeMode -- tells if this EditingMode is of "snapping" type, set to true for this EditingMode
\ No newline at end of file
Added: sandbox/vector/doc/Control.EditingMode.PointSnapping.txt
===================================================================
--- sandbox/vector/doc/Control.EditingMode.PointSnapping.txt (rev 0)
+++ sandbox/vector/doc/Control.EditingMode.PointSnapping.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,11 @@
+OpenLayers.Control.EditingMode.PointSnapping
+
+EditingMode to be used in more or less every editing tools. This allows user to snap on geometries vertices for the current vector layer.
+
+
+* Constructor
+ OpenLayers.Control.EditingMode.PointSnapping() -- Creates a new PointSnapping. No options available.
+
+* Methods
+ calculatePoint({OpenLayers.Geometry.Point}, {OpenLayers.Geometry}) -- none -- Calculate the position of the point to snap to, modify the first argument parameters value
+ All other methods are inherited from {OpenLayers.Layer.EditingMode}
\ No newline at end of file
Added: sandbox/vector/doc/Control.EditingMode.SegmentSnapping.txt
===================================================================
--- sandbox/vector/doc/Control.EditingMode.SegmentSnapping.txt (rev 0)
+++ sandbox/vector/doc/Control.EditingMode.SegmentSnapping.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,11 @@
+OpenLayers.Control.EditingMode.SegmentSnapping
+
+EditingMode to be used in more or less every editing tools. This allows user to snap on geometries segments for the current vector layer.
+
+
+* Constructor
+ OpenLayers.Control.EditingMode.SegmentSnapping() -- Creates a new SegmentSnapping. No options available.
+
+* Methods
+ calculatePoint({OpenLayers.Geometry.Point}, {OpenLayers.Geometry}) -- none -- Calculate the position of the point to snap to, modify the first argument parameters value
+ All other methods are inherited from {OpenLayers.Layer.EditingMode}
\ No newline at end of file
Added: sandbox/vector/doc/Control.EditingMode.txt
===================================================================
--- sandbox/vector/doc/Control.EditingMode.txt (rev 0)
+++ sandbox/vector/doc/Control.EditingMode.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,11 @@
+OpenLayers.Control.EditingMode
+
+Control to force the position of the point to draw when using the editing tools. Subclasses may be written to handle specific calculatePoint method. For example this can be used to handle snapping or to force lines to be horizontal or vertical.
+
+
+* Constructor
+ OpenLayers.Control.EditingMode() -- Creates a new control. No options available.
+
+* Methods
+ calculatePoint({OpenLayers.Geometry.Point}, {OpenLayers.Geometry}) -- none -- Calculate the position of the point to snap to, modify the first argument parameters value
+ setMap({OpenLayers.Map}) -- none -- Set the map property of the editingMode
\ No newline at end of file
Added: sandbox/vector/doc/Layer.Vector.txt
===================================================================
--- sandbox/vector/doc/Layer.Vector.txt (rev 0)
+++ sandbox/vector/doc/Layer.Vector.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,26 @@
+OpenLayers.Layer.Vector
+
+
+******* TO BE COMPLETED ***********
+
+This class gives the possibility to add a vector layer to an OpenLayers map. It handles features and geometries and is able to draw them into a renderer. This renderer is created as a VML or SVG node depending on the browser compatibility.
+
+If you wish to change params, you should use mergeNewParams, rather than accessing the parameters directly.
+
+* Constructor
+ OpenLayers.Layer.Vector(name,options) -- Options is a set of options, extending the parameters of the layer.
+
+* Methods
+ setMap(map) -- none -- Set the map property of the layer. Also set the parameters which are inherited from the map. This is also where the tileSize is retrieved from the map. Subclassed from {OpenLayers.Layer}.
+ onMapResize() -- none -- Called when mapresized event triggered, overwrites the inherited {OpenLayers.Layer} method to reset the renderer size.
+ moveTo({OpenLayers.Bounds|bounds}, {Boolean|zoomChanged}, {Boolean|dragging}) -- none -- Function called on dragging or setCenter, to move the Layer to a new geographic location. Adds specific behavior to the {OpenLayers.Layer} inherited class. Reset the extent of the renderer.
+ addFeatures({Array of {OpenLayers.Feature}|features}) -- {Array} -- Adds features to the layer, also draws the corresponding geometries in the renderer
+ removeFeatures({Array of {OpenLayers.Feature}|features}) -- {Array} -- Removes features from the current layer features list.
+ updateFeatures({Array of {OpenLayers.Feature}|features}) -- none -- Changes the features' state to {OpenLayers.State.UPDATE} for editing consideration mainly
+ commit() -- none -- Calls the writer , for WFS-T layers consideration only
+
+ getURL({OpenLayers.Bounds|bounds}) -- {String} -- Returns a WMS URL for the given bounds based on the properties of the layer.
+ All other methods are inherited from {OpenLayers.Layer.Grid}
+
+* Options
+ style -- {OpenLayers.Style} -- Set the style to use to render geometries on the renderer
\ No newline at end of file
Added: sandbox/vector/doc/Layer.WFS.txt
===================================================================
--- sandbox/vector/doc/Layer.WFS.txt (rev 0)
+++ sandbox/vector/doc/Layer.WFS.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,33 @@
+OpenLayers.Layer.WFS
+
+
+******* TO BE COMPLETED ***********
+
+This class gives the possibility to add a WFS layer to an OpenLayers map as a vector layer.
+Features are retrieved from the server, gml is parsed to create OpenLayers.Feature.
+Then, updated, inserted and deleted features can be transactionnaly commited to the server back.
+
+* Constructor
+ OpenLayers.Layer.WFS(name, url, params, options) -- URL is the base URL to the layer. Params is a set of params to be included in the HTTP Request. Options is a set of options, extending the parameters of the layer.
+
+* Methods
+ destroy() -- none --
+ setMap(map) -- none -- Set the map property of the layer. Also set the parameters which are inherited from the map. This is also where the tileSize is retrieved from the map. Subclassed from {OpenLayers.Layer}.
+ onMapResize() -- none -- inherited from OpenLayers.Layer.Vector
+ moveTo({OpenLayers.Bounds|bounds}, {Boolean|zoomChanged}, {Boolean|dragging}) -- none -- inherited from OpenLayer.Layer.Vector
+ addFeatures({Array of {OpenLayers.Feature}|features}) -- {Array} -- inherited from OpenLayer.Layer.Vector
+ removeFeatures({Array of {OpenLayers.Feature}|features}) -- {Array} -- inherited from OpenLayer.Layer.Vector
+ updateFeatures({Array of {OpenLayers.Feature}|features}) -- none -- inherited from OpenLayer.Layer.Vector
+ commit() -- none -- inherited from OpenLayers.Layer.Vector
+ refresh() -- none -- redraws the layer, i.e. clears the features array, relaunch a WFS request and redraws features on the map
+
+ getURL({OpenLayers.Bounds|bounds}) -- {String} -- Returns a WMS URL for the given bounds based on the properties of the layer.
+ All other methods are inherited from {OpenLayers.Layer.Grid}
+
+* Options
+ geometry_column -- {string} -- set the name of the field used for geometry, needed for commits
+ geometryType -- {Object} -- defines the geometry type allowed for the layer, if not set or null, no constraint is available
+ style -- {OpenLayers.Style} -- Set the style to use to render geometries on the renderer
+
+* Params
+ Available params are defined by the WFS service, here are some examples : typename, maxfeatures, maxZoomLevel, propertyname
\ No newline at end of file
Added: sandbox/vector/doc/MouseListener.EditingListener.AddPathPoint.txt
===================================================================
--- sandbox/vector/doc/MouseListener.EditingListener.AddPathPoint.txt (rev 0)
+++ sandbox/vector/doc/MouseListener.EditingListener.AddPathPoint.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,14 @@
+OpenLayers.MouseListener.EditingListener.AddPathPoint
+
+ This mouseListener allows user to add points to the path of a geometry in a vector layer feature
+
+* Constructor
+ OpenLayers.MouseListener.EditingListener.AddPathPoint() -- Creates a new control. No options available.
+
+* Methods
+ mouseDown -- none -- if user click close (distance lower than map.snappingTolerance) to a geometry segment on a current vector layer feature, a new vertex is added
+ mouseUp -- none -- when mouse is up update the feature modified into its layer
+ mouseOver -- none -- calls the movePathPoint mouseOver method
+ _drawVertices({OpenLayers.Geometry}) -- none -- Internal function to draw all the vertices of a geometry
+ _eraseVertices({OpenLayers.Geometry}) -- none -- Internal function to erase all the vertices of a geometry
+ All other methods are inherited from {OpenLayers.MouseListener.EditingListener}
Added: sandbox/vector/doc/MouseListener.EditingListener.DrawLineString.txt
===================================================================
--- sandbox/vector/doc/MouseListener.EditingListener.DrawLineString.txt (rev 0)
+++ sandbox/vector/doc/MouseListener.EditingListener.DrawLineString.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,16 @@
+OpenLayers.MouseListener.EditingListener.AddPathPoint
+
+ This mouseListener allows user to add points to the path of a geometry in a vector layer feature
+
+* Constructor
+ OpenLayers.MouseListener.EditingListener.AddPathPoint() -- Creates a new control. No options available.
+
+* Methods
+ initialize -- none -- Constructor
+ mouseDblClick -- none -- Erase all the temporaries elements and finalize the drawn geometry
+ mouseDown -- none -- if user click close (distance lower than map.snappingTolerance) to a geometry segment on a current vector layer feature, a new vertex is added
+ mouseMove -- none -- if the user is drawing a geometry, a temporary segment is drawn to visualize what the geometry should be.
+ keyDown -- none -- on RETURN key event, the geometry is finalized and on ESC key event, the geometry is cancelled
+ _finalizeGeometry -- none -- internal method to add a new feature to the vector layer
+ _eraseTmpElements -- none -- internal method to erase all the temporaries elements
+ All other methods are inherited from {OpenLayers.MouseListener.EditingListener}
Added: sandbox/vector/doc/MouseListener.EditingListener.DrawLinearRing.txt
===================================================================
--- sandbox/vector/doc/MouseListener.EditingListener.DrawLinearRing.txt (rev 0)
+++ sandbox/vector/doc/MouseListener.EditingListener.DrawLinearRing.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,15 @@
+OpenLayers.MouseListener.EditingListener.DrawLinearRing
+
+ This mouseListener allows the user to draw a linear ring.
+
+* Constructor
+ OpenLayers.MouseListener.EditingListener.AddPathPoint() -- Creates a new control. No options available.
+
+* Methods
+ mouseDblClick -- none -- if user click close (distance lower than map.snappingTolerance) to a geometry segment on a current vector layer feature, a new vertex is added
+ mouseDown -- none -- This event takes place when a mouseDown event occurs on the map.
+ mouseMove -- none -- This event takes place when a mouseMove event occurs on the map.
+ keyDown -- none -- This event takes place when a keyDown event occurs on the map.
+ _finalizeGeometry -- none -- this method is called to update the edited geometry in the selected vector layer
+ _eraseTmpElements -- none -- this method is called to erase all the temporary elements drawn in the interface during the creation of the geometry
+ All other methods are inherited from {OpenLayers.MouseListener.EditingListener}
Added: sandbox/vector/doc/MouseListener.EditingListener.DrawPoint.txt
===================================================================
--- sandbox/vector/doc/MouseListener.EditingListener.DrawPoint.txt (rev 0)
+++ sandbox/vector/doc/MouseListener.EditingListener.DrawPoint.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,14 @@
+OpenLayers.MouseListener.EditingListener.AddPathPoint
+
+ This mouseListener allows user to add points to the path of a geometry in a vector layer feature
+
+* Constructor
+ OpenLayers.MouseListener.EditingListener.AddPathPoint() -- Creates a new control. No options available.
+
+* Methods
+ mouseDown -- none -- place a new point on the layer
+ mouseUp -- none -- when mouse is up add a new feature to the vector layer
+ mouseMove -- none -- replace the new point on the layer
+ keyDown -- none -- on RETURN key event, the geometry is finalized and on ESC key event, the geometry is cancelled
+ _finalizeGeometry -- none -- internal method to add a new feature to the vector layer
+ All other methods are inherited from {OpenLayers.MouseListener.EditingListener}
Added: sandbox/vector/doc/MouseListener.EditingListener.MovePathPoint.txt
===================================================================
--- sandbox/vector/doc/MouseListener.EditingListener.MovePathPoint.txt (rev 0)
+++ sandbox/vector/doc/MouseListener.EditingListener.MovePathPoint.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,15 @@
+OpenLayers.MouseListener.EditingListener.MovePathPoint
+
+ This mouseListener allows user to move points to the path of a geometry in a vector layer feature
+
+* Constructor
+ OpenLayers.MouseListener.EditingListener.MovePathPoint() -- Creates a new control. No options available.
+
+* Methods
+ mouseOver -- none -- when a mouse over event occurs on a displayed geometry, all the concerned vertices are displayed
+ mouseMove -- none -- if a vertex selection is set, all the references are moved with the mouse
+ mouseDown -- none -- if a mouseDown event occurs on a displayed vertex, a reference to the vertex is added to the selection
+ mouseUp -- none -- when a mouse up event occurs, the edited feature is updated into its layer
+ _drawVertices -- none -- internal function to draw all the vertices of a geometry
+ _eraseVertices -- none -- internal function to erase all the vertices of a geometry
+ All other methods are inherited from {OpenLayers.MouseListener.EditingListener}
Added: sandbox/vector/doc/MouseListener.EditingListener.PolygonHoleCutter.txt
===================================================================
--- sandbox/vector/doc/MouseListener.EditingListener.PolygonHoleCutter.txt (rev 0)
+++ sandbox/vector/doc/MouseListener.EditingListener.PolygonHoleCutter.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,20 @@
+OpenLayers.MouseListener.EditingListener.PolygonHoleCutter
+
+ This mouseListener allows the user to create an interior ring into an existing polygon. As a result, the polygon is drawn with a hole.
+
+
+* Constructor
+ OpenLayers.MouseListener.EditingListener.PolygonHoleCutter() -- Creates a new control.
+
+* Methods
+ mouseDblClick -- none -- This event takes place when a dblClick event occurs on the map.
+ mouseDown -- none -- This event takes place when a mouseDown event occurs on the map.
+ mouseMove -- none -- This event takes place when a mouseMove event occurs on the map. If mouse is down, the user can pan the map.
+ mouseUp -- none -- This event takes place when a mouseUp event occurs on the map. If user clicked on an existing polygon, it is hilighted, and next clicks allows to draw the ring.
+ keyDown -- none -- This event takes place when a keyDown event occurs on the map.
+ _finalizeGeometry -- none -- this method is called to update the edited geometry in the selected vector layer
+ _eraseTmpElements -- none -- this method is called to erase all the temporary elements drawn in the interface during the creation of the geometry
+ All other methods are inherited from {OpenLayers.MouseListener.EditingListener}
+
+* Options
+ createIsland -- {Boolean} -- if true, a new feature is created as an island.
\ No newline at end of file
Added: sandbox/vector/doc/MouseListener.EditingListener.RemovePathPoint.txt
===================================================================
--- sandbox/vector/doc/MouseListener.EditingListener.RemovePathPoint.txt (rev 0)
+++ sandbox/vector/doc/MouseListener.EditingListener.RemovePathPoint.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,14 @@
+OpenLayers.MouseListener.EditingListener.RemovePathPoint
+
+ This mouseListener allows user to move points to the path of a geometry in a vector layer feature
+
+* Constructor
+ OpenLayers.MouseListener.EditingListener.RemovePathPoint() -- Creates a new control. No options available.
+
+* Methods
+ mouseOver -- none -- when a mouse over event occurs on a displayed geometry, all the concerned vertices are displayed
+ mouseDown -- none -- if a displayed vertex is under the mouse when the event occurs, the vertex is deleted
+ _drawVertices -- none -- internal function to draw all the vertices of a geometry
+ _eraseVertices -- none -- internal function to erase all the vertices of a geometry
+ _removePathPoint -- none -- internal function to remove a geometry vertex
+ All other methods are inherited from {OpenLayers.MouseListener.EditingListener}
Added: sandbox/vector/doc/MouseListener.EditingListener.Selection.txt
===================================================================
--- sandbox/vector/doc/MouseListener.EditingListener.Selection.txt (rev 0)
+++ sandbox/vector/doc/MouseListener.EditingListener.Selection.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,15 @@
+OpenLayers.MouseListener.EditingListener.AddPathPoint
+
+ This mouseListener allows user to add points to the path of a geometry in a vector layer feature
+
+* Constructor
+ OpenLayers.MouseListener.EditingListener.AddPathPoint() -- Creates a new control.
+
+* Methods
+ mouseDown -- none -- if user click close (distance lower than map.snappingTolerance) to a geometry segment on a current vector layer feature, a new vertex is added
+ mouseUp -- none -- when mouse is up update the feature modified into its layer
+ mouseOver -- none -- calls the movePathPoint mouseOver method
+ All other methods are inherited from {OpenLayers.MouseListener.EditingListener}
+
+* Options
+ deleteConfirmMessage -- none -- Message display to ask for features deletion confirmation, if set, called when user selected feature and presses suppr key on keyboard
Added: sandbox/vector/doc/MouseListener.EditingListener.txt
===================================================================
--- sandbox/vector/doc/MouseListener.EditingListener.txt (rev 0)
+++ sandbox/vector/doc/MouseListener.EditingListener.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,20 @@
+OpenLayers.MouseListener.EditingListener
+
+ This Object Class is used to build MouseListener subclasses for editing functionnalities.
+
+* Constructor
+ OpenLayers.MouseListener.EditingListener() -- Creates a new MouseListener.EditingListener. No options available.
+
+* Methods
+ defaultClick -- none -- Is called when user clicks on the map, sets the event context i.e. adds a matching point to the event
+ mouseDblClick -- none -- Is called when user double clicks on the map, sets the event context i.e. adds a matching point to the event
+ mouseDown -- none -- Is called when mouse is clicked down on the map, sets the event context i.e. adds a matching point to the event
+ mouseMove -- none -- Is called when mouse is clicked up on the map, sets the event context i.e. adds a matching point to the event
+ mouseUp -- none -- Is called when user clicks on the map, sets the event context i.e. adds a matching point to the event
+ mouseOut -- none -- Is called when user clicks on the map, sets the event context i.e. adds a matching point to the event
+ wheelEvent -- none -- Calls the wheelEvent method of mouseDefaults mouseListener
+ wheelUp -- none -- Calls the wheelUp method of mouseDefaults mouseListener
+ wheelDown -- none -- Calls the wheelDown method of mouseDefaults mouseListener
+ keyDown -- none -- Is called when user push some keyboard keys down
+ keyUp -- none -- May revert some values set with keyDown method
+
Added: sandbox/vector/doc/MouseListener.MeasureArea.txt
===================================================================
--- sandbox/vector/doc/MouseListener.MeasureArea.txt (rev 0)
+++ sandbox/vector/doc/MouseListener.MeasureArea.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,9 @@
+OpenLayers.MouseListener.MeasureArea
+
+// TBD
+
+Description here
+
+* Constructor
+
+* Methods
\ No newline at end of file
Added: sandbox/vector/doc/MouseListener.MeasureDistance.txt
===================================================================
--- sandbox/vector/doc/MouseListener.MeasureDistance.txt (rev 0)
+++ sandbox/vector/doc/MouseListener.MeasureDistance.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,9 @@
+OpenLayers.MouseListener.MeasureDistance
+
+// TBD
+
+Description here
+
+* Constructor
+
+* Methods
\ No newline at end of file
Added: sandbox/vector/doc/MouseListener.MouseDefaults.txt
===================================================================
--- sandbox/vector/doc/MouseListener.MouseDefaults.txt (rev 0)
+++ sandbox/vector/doc/MouseListener.MouseDefaults.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,18 @@
+OpenLayers.MouseListener.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.MouseListener.MouseDefaults() -- Creates a new MouseListener.MouseDefaults. 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.
+ mouseDown -- 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.
+ mouseMove -- 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.
+ mouseUp -- 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.
+ mouseOut -- none -- This calls defaultMouseUp, so that when you mouse out of the map div, the events are stopped.
+ wheelUp -- none -- Zooms in one level. Called by onWheelEvent
+ wheelDown -- none -- Zooms out one level. Called by onWheelEvent.
+
Added: sandbox/vector/doc/MouseListener.txt
===================================================================
--- sandbox/vector/doc/MouseListener.txt (rev 0)
+++ sandbox/vector/doc/MouseListener.txt 2007-03-02 07:52:50 UTC (rev 2294)
@@ -0,0 +1,18 @@
+OpenLayers.MouseListener
+
+Description here
+
+* Constructor
+ OpenLayers.MouseListener() -- Creates a new MouseListener. No Options available.
+
+* Methods
+ setMap({OpenLayer.Map}) -- none -- Set the map property for the MouseListener.
+ detroy() -- none -- Destroy is a destructor: this is to alleviate cyclic references which the Javascript garbage cleaner can not take care of on its own.
+ mouseClick({Event}) -- none -- This event takes place when a click event occurs on the map.
+ mouseDblClick({Event}) -- none -- This event takes place when a dblclick event occurs on the map.
+ mouseUp({Event}) -- none -- This event takes place when a mouse up event occurs on the map.
+ mouseDown({Event}) -- none -- This event takes place when a mouse down event occurs on the map.
+ mouseOver({Event}) -- none -- This event takes place when a mouse over event occurs on the map.
+ mouseOut({Event}) -- none -- This event takes place when a mouse out event occurs on the map.
+ mouseMove({Event}) -- none -- This event takes place when a mouse move event occurs on the map.
+ mouseWheel({Event}) -- none -- This event takes place when a mouse wheel event occurs on the map.
\ No newline at end of file
More information about the Commits
mailing list