ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge branch 'master' into osm

Browse Source 
Conflicts:
	apidoc_config/Menu.txt
This commit is contained in:
Éric Lemoine
2012-01-12 21:27:39 +01:00
parent 3cbd7b4b40 e1ea3471e0
commit 2f700bd894
81 changed files with 562 additions and 225 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
lib/OpenLayers/Control/ArgParser.js
View File

@@ -22,19 +22,19 @@
OpenLayers.Control.ArgParser = OpenLayers.Class(OpenLayers.Control, {
/**
* Parameter: center
* Property: center
* {<OpenLayers.LonLat>}
*/
center: null,
/**
* Parameter: zoom
* Property: zoom
* {int}
*/
zoom: null,
/**
* Parameter: layers
* Property: layers
* {Array(<OpenLayers.Layer>)}
*/
layers: null,

2
lib/OpenLayers/Control/DragPan.js
View File

@@ -47,7 +47,7 @@ OpenLayers.Control.DragPan = OpenLayers.Class(OpenLayers.Control, {
/**
* Property: kinetic
* {OpenLayers.Kinetic} The OpenLayers.Kinetic object.
* {<OpenLayers.Kinetic>} The OpenLayers.Kinetic object.
*/
kinetic: null,

2
lib/OpenLayers/Control/Graticule.js
View File

@@ -98,7 +98,7 @@ OpenLayers.Control.Graticule = OpenLayers.Class(OpenLayers.Control, {
/**
* Property: gratLayer
* {OpenLayers.Layer.Vector} vector layer used to draw the graticule on
* {<OpenLayers.Layer.Vector>} vector layer used to draw the graticule on
*/
gratLayer: null,

2
lib/OpenLayers/Control/KeyboardDefaults.js
View File

@@ -59,7 +59,7 @@ OpenLayers.Control.KeyboardDefaults = OpenLayers.Class(OpenLayers.Control, {
* http://unixpapa.com/js/key.html
*
* Parameters:
* code - {Integer}
* evt - {Event}
*/
defaultKeyPress: function (evt) {
switch(evt.keyCode) {

15
lib/OpenLayers/Control/LayerSwitcher.js
View File

@@ -68,7 +68,7 @@ OpenLayers.Control.LayerSwitcher =
/**
* Property: baseLayers
* {Array(<OpenLayers.Layer>)}
* {Array(Object)}
*/
baseLayers: null,
@@ -87,7 +87,7 @@ OpenLayers.Control.LayerSwitcher =
/**
* Property: dataLayers
* {Array(<OpenLayers.Layer>)}
* {Array(Object)}
*/
dataLayers: null,
@@ -372,10 +372,13 @@ OpenLayers.Control.LayerSwitcher =
* Parameters:
* e - {Event}
*
* Context:
* - {DOMElement} inputElem
* - {<OpenLayers.Control.LayerSwitcher>} layerSwitcher
* - {<OpenLayers.Layer>} layer
* Context:
* - {Object}
*
* Object structure:
* inputElem - {DOMElement}
* layerSwitcher - {<OpenLayers.Control.LayerSwitcher>}
* layer - {<OpenLayers.Layer>}
*/
onInputClick: function(e) {

4
lib/OpenLayers/Control/OverviewMap.js
View File

@@ -17,7 +17,7 @@
* the lower right corner of the main map. Create a new overview map with the
* <OpenLayers.Control.OverviewMap> constructor.
*
* Inerits from:
* Inherits from:
* - <OpenLayers.Control>
*/
OpenLayers.Control.OverviewMap = OpenLayers.Class(OpenLayers.Control, {
@@ -132,7 +132,7 @@ OpenLayers.Control.OverviewMap = OpenLayers.Class(OpenLayers.Control, {
* Create a new overview map
*
* Parameters:
* object - {Object} Properties of this object will be set on the overview
* options - {Object} Properties of this object will be set on the overview
* map object. Note, to set options on the map object contained in this
* control, set <mapOptions> as one of the options properties.
*/

2
lib/OpenLayers/Control/PanZoomBar.js
View File

@@ -190,7 +190,7 @@ OpenLayers.Control.PanZoomBar = OpenLayers.Class(OpenLayers.Control.PanZoom, {
* Method: _addZoomBar
*
* Parameters:
* location - {<OpenLayers.Pixel>} where zoombar drawing is to start.
* centered - {<OpenLayers.Pixel>} where zoombar drawing is to start.
*/
_addZoomBar:function(centered) {
var imgLocation = OpenLayers.Util.getImageLocation("slider.png");

6
lib/OpenLayers/Control/Panel.js
View File

@@ -330,7 +330,7 @@ OpenLayers.Control.Panel = OpenLayers.Class(OpenLayers.Control, {
* APIMethod: getControlsBy
* Get a list of controls with properties matching the given criteria.
*
* Parameter:
* Parameters:
* property - {String} A control property to be matched.
* match - {String | Object} A string to match. Can also be a regular
* expression literal or object. In addition, it can be any object
@@ -355,7 +355,7 @@ OpenLayers.Control.Panel = OpenLayers.Class(OpenLayers.Control, {
* APIMethod: getControlsByName
* Get a list of contorls with names matching the given name.
*
* Parameter:
* Parameters:
* match - {String | Object} A control name. The name can also be a regular
* expression literal or object. In addition, it can be any object
* with a method named test. For reqular expressions or other, if
@@ -375,7 +375,7 @@ OpenLayers.Control.Panel = OpenLayers.Class(OpenLayers.Control, {
* APIMethod: getControlsByClass
* Get a list of controls of a given type (CLASS_NAME).
*
* Parameter:
* Parameters:
* match - {String | Object} A control class name. The type can also be a
* regular expression literal or object. In addition, it can be any
* object with a method named test. For reqular expressions or other,

3
lib/OpenLayers/Control/SLDSelect.js
View File

@@ -183,6 +183,9 @@ OpenLayers.Control.SLDSelect = OpenLayers.Class(OpenLayers.Control, {
* layer visibility. So if the source layer is turned off, the
* selection layer is also turned off.
*
* Context:
* - {<OpenLayers.Layer>}
*
* Parameters:
* evt - {Object}
*/

2
lib/OpenLayers/Control/Scale.js
View File

@@ -20,7 +20,7 @@
OpenLayers.Control.Scale = OpenLayers.Class(OpenLayers.Control, {
/**
* Parameter: element
* Property: element
* {DOMElement}
*/
element: null,

8
lib/OpenLayers/Control/Snapping.js
View File

@@ -115,7 +115,7 @@ OpenLayers.Control.Snapping = OpenLayers.Class(OpenLayers.Control, {
* the control.
*
* Valid options:
* layer - {OpenLayers.Layer.Vector} The editable layer. Features from this
* layer - {<OpenLayers.Layer.Vector>} The editable layer. Features from this
* layer that are digitized or modified may have vertices snapped to
* features from any of the target layers.
* targets - {Array(Object | OpenLayers.Layer.Vector)} A list of objects for
@@ -141,7 +141,7 @@ OpenLayers.Control.Snapping = OpenLayers.Class(OpenLayers.Control, {
* continues after an eligible feature is found in a target layer.
*
* Valid target properties:
* layer - {OpenLayers.Layer.Vector} A target layer. Features from this
* layer - {<OpenLayers.Layer.Vector>} A target layer. Features from this
* layer will be eligible to act as snapping target for the editable
* layer.
* tolerance - {Float} The distance (in pixels) at which snapping may occur.
@@ -159,7 +159,7 @@ OpenLayers.Control.Snapping = OpenLayers.Class(OpenLayers.Control, {
* edgeTolerance - {Float} Optional distance at which snapping may occur
* for edges specifically. If none is provided, <tolerance> will be
* used.
* filter - {OpenLayers.Filter} Optional filter to evaluate to determine if
* filter - {<OpenLayers.Filter>} Optional filter to evaluate to determine if
* feature is eligible for snapping. If filter evaluates to true for a
* target feature a vertex may be snapped to the feature.
* minResolution - {Number} If a minResolution is provided, snapping to this
@@ -198,7 +198,7 @@ OpenLayers.Control.Snapping = OpenLayers.Class(OpenLayers.Control, {
* layer is set.
*
* Parameters:
* layer - {OpenLayers.Layer.Vector} The new editable layer.
* layer - {<OpenLayers.Layer.Vector>} The new editable layer.
*/
setLayer: function(layer) {
if(this.active) {

42
lib/OpenLayers/Control/Split.js
View File

@@ -106,7 +106,7 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, {
/**
* APIProperty: targetFilter
* {OpenLayers.Filter} Optional filter that will be evaluated
* {<OpenLayers.Filter>} Optional filter that will be evaluated
* to determine if a feature from the target layer is eligible for
* splitting.
*/
@@ -114,7 +114,7 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, {
/**
* APIProperty: sourceFilter
* {OpenLayers.Filter} Optional filter that will be evaluated
* {<OpenLayers.Filter>} Optional filter that will be evaluated
* to determine if a feature from the target layer is eligible for
* splitting.
*/
@@ -141,10 +141,10 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, {
* the control.
*
* Valid options:
* layer - {OpenLayers.Layer.Vector} The target layer. Features from this
* layer - {<OpenLayers.Layer.Vector>} The target layer. Features from this
* layer will be split by new or modified features on the source layer
* or temporary sketch layer.
* source - {OpenLayers.Layer.Vector} Optional source layer. If provided
* source - {<OpenLayers.Layer.Vector>} Optional source layer. If provided
* newly created features or modified features will be used to split
* features on the target layer. If not provided, a temporary sketch
* layer will be created for drawing lines.
@@ -158,10 +158,10 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, {
* mutual - {Boolean} If source and target are the same, split source
* features and target features where they intersect. Default is
* true. If false, only target features will be split.
* targetFilter - {OpenLayers.Filter} Optional filter that will be evaluated
* targetFilter - {<OpenLayers.Filter>} Optional filter that will be evaluated
* to determine if a feature from the target layer is eligible for
* splitting.
* sourceFilter - {OpenLayers.Filter} Optional filter that will be evaluated
* sourceFilter - {<OpenLayers.Filter>} Optional filter that will be evaluated
* to determine if a feature from the target layer is eligible for
* splitting.
*/
@@ -180,7 +180,7 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, {
* Set the source layer for edits layer.
*
* Parameters:
* layer - {OpenLayers.Layer.Vector} The new source layer layer. If
* layer - {<OpenLayers.Layer.Vector>} The new source layer layer. If
* null, a temporary sketch layer will be created.
*/
setSource: function(layer) {
@@ -277,8 +277,7 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, {
afterFeatureModified: function(event) {
if(event.modified) {
var feature = event.feature;
if(feature.geometry instanceof OpenLayers.Geometry.LineString ||
feature.geometry instanceof OpenLayers.Geometry.MultiLineString) {
if (typeof feature.geometry.split === "function") {
this.feature = event.feature;
this.considerSplit(event.feature);
}
@@ -313,17 +312,20 @@ OpenLayers.Control.Split = OpenLayers.Class(OpenLayers.Control, {
* {Boolean} The target is eligible for splitting.
*/
isEligible: function(target) {
return (
target.state !== OpenLayers.State.DELETE
) && (
target.geometry instanceof OpenLayers.Geometry.LineString ||
target.geometry instanceof OpenLayers.Geometry.MultiLineString
) && (
this.feature !== target
) && (
!this.targetFilter ||
this.targetFilter.evaluate(target.attributes)
);
if (!target.geometry) {
return false;
} else {
return (
target.state !== OpenLayers.State.DELETE
) && (
typeof target.geometry.split === "function"
) && (
this.feature !== target
) && (
!this.targetFilter ||
this.targetFilter.evaluate(target.attributes)
);
}
},
/**

2
lib/OpenLayers/Feature/Vector.js
View File

@@ -297,7 +297,7 @@ OpenLayers.Feature.Vector = OpenLayers.Class(OpenLayers.Feature, {
* Moves the feature and redraws it at its new location
*
* Parameters:
* state - {OpenLayers.LonLat or OpenLayers.Pixel} the
* location - {<OpenLayers.LonLat> or <OpenLayers.Pixel>} the
* location to which to move the feature.
*/
move: function(location) {

2
lib/OpenLayers/Filter/Comparison.js
View File

@@ -11,7 +11,7 @@
* Class: OpenLayers.Filter.Comparison
* This class represents a comparison filter.
*
* Inherits from
* Inherits from:
* - <OpenLayers.Filter>
*/
OpenLayers.Filter.Comparison = OpenLayers.Class(OpenLayers.Filter, {

2
lib/OpenLayers/Filter/FeatureId.js
View File

@@ -13,7 +13,7 @@
* This class represents a ogc:FeatureId Filter, as being used for rule-based SLD
* styling
*
* Inherits from
* Inherits from:
* - <OpenLayers.Filter>
*/
OpenLayers.Filter.FeatureId = OpenLayers.Class(OpenLayers.Filter, {

2
lib/OpenLayers/Filter/Function.js
View File

@@ -14,7 +14,7 @@
* filters that can contain filter functions as values.
* Nesting function as other functions parameter is supported.
*
* Inherits from
* Inherits from:
* - <OpenLayers.Filter>
*/
OpenLayers.Filter.Function = OpenLayers.Class(OpenLayers.Filter, {

2
lib/OpenLayers/Filter/Logical.js
View File

@@ -12,7 +12,7 @@
* Class: OpenLayers.Filter.Logical
* This class represents ogc:And, ogc:Or and ogc:Not rules.
*
* Inherits from
* Inherits from:
* - <OpenLayers.Filter>
*/
OpenLayers.Filter.Logical = OpenLayers.Class(OpenLayers.Filter, {

2
lib/OpenLayers/Filter/Spatial.js
View File

@@ -12,7 +12,7 @@
* This class represents a spatial filter.
* Currently implemented: BBOX, DWithin and Intersects
*
* Inherits from
* Inherits from:
* - <OpenLayers.Filter>
*/
OpenLayers.Filter.Spatial = OpenLayers.Class(OpenLayers.Filter, {

10
lib/OpenLayers/Format/ArcXML.js
View File

@@ -17,7 +17,7 @@
* constructor.
*
* Inherits from:
* - <OpenLayers.Format>
* - <OpenLayers.Format.XML>
*/
OpenLayers.Format.ArcXML = OpenLayers.Class(OpenLayers.Format.XML, {
@@ -135,7 +135,7 @@ OpenLayers.Format.ArcXML = OpenLayers.Class(OpenLayers.Format.XML, {
*
* Parameters:
* imsize - {Object} An ArcXML imagesize object.
* olsize - {OpenLayers.Size} The image size to set.
* olsize - {<OpenLayers.Size>} The image size to set.
*/
addImageSize: function(imsize, olsize) {
if (olsize !== null) {
@@ -152,7 +152,7 @@ OpenLayers.Format.ArcXML = OpenLayers.Class(OpenLayers.Format.XML, {
*
* Parameters:
* featOrFilt - {Object} A featurecoordsys or filtercoordsys ArcXML structure.
* fsys - {String} or {OpenLayers.Projection} or {filtercoordsys} or
* fsys - {String} or {<OpenLayers.Projection>} or {filtercoordsys} or
* {featurecoordsys} A projection representation. If it's a {String},
* the value is assumed to be the SRID. If it's a {OpenLayers.Projection}
* AND Proj4js is available, the projection number and name are extracted
@@ -205,7 +205,7 @@ OpenLayers.Format.ArcXML = OpenLayers.Class(OpenLayers.Format.XML, {
* data - {String} or {DOMElement} data to read/parse.
*
* Returns:
* {OpenLayers.Format.ArcXML.Response} An ArcXML response. Note that this response
* {<OpenLayers.Format.ArcXML.Response>} An ArcXML response. Note that this response
* data may change in the future.
*/
read: function(data) {
@@ -873,7 +873,7 @@ OpenLayers.Format.ArcXML = OpenLayers.Class(OpenLayers.Format.XML, {
* node - {<DOMElement>} An element to parse <COORDS> or <POINT> arcxml data from.
*
* Returns:
* {OpenLayers.Geometry.LinearRing} A linear ring represented by the node's points.
* {<OpenLayers.Geometry.LinearRing>} A linear ring represented by the node's points.
*/
parsePointGeometry: function(node) {
var ringPoints = [];

5
lib/OpenLayers/Format/Atom.js
View File

@@ -76,7 +76,7 @@ OpenLayers.Format.Atom = OpenLayers.Class(OpenLayers.Format.XML, {
* doc - {Element} or {String}
*
* Returns:
* An Array of <OpenLayers.Feature.Vector>s
* Array({<OpenLayers.Feature.Vector>})
*/
read: function(doc) {
if (typeof doc == "string") {
@@ -90,8 +90,7 @@ OpenLayers.Format.Atom = OpenLayers.Class(OpenLayers.Format.XML, {
* Serialize or more feature nodes to Atom documents.
*
* Parameters:
* features - a single {<OpenLayers.Feature.Vector>} or an
* Array({<OpenLayers.Feature.Vector>}).
* features - {<OpenLayers.Feature.Vector>} or Array({<OpenLayers.Feature.Vector>})
*
* Returns:
* {String} an Atom entry document if passed one feature node, or a feed

3
lib/OpenLayers/Format/Context.js
View File

@@ -10,6 +10,9 @@
/**
* Class: OpenLayers.Format.Context
* Base class for both Format.WMC and Format.OWSContext
*
* Inherits from:
* - <OpenLayers.Format.XML.VersionedOGC>
*/
OpenLayers.Format.Context = OpenLayers.Class(OpenLayers.Format.XML.VersionedOGC, {

3
lib/OpenLayers/Format/Filter/v1_1_0.js
View File

@@ -19,7 +19,8 @@
* - writes matchCase attribute from comparison filters of type EQUAL_TO,
* NOT_EQUAL_TO and LIKE.
*
* Inherits from:
* Inherits from:
* - <OpenLayers.Format.GML.v3>
* - <OpenLayers.Format.Filter.v1>
*/
OpenLayers.Format.Filter.v1_1_0 = OpenLayers.Class(

8
lib/OpenLayers/Format/GML.js
View File

@@ -20,11 +20,11 @@
* constructor. Supports the GML simple features profile.
*
* Inherits from:
* - <OpenLayers.Format>
* - <OpenLayers.Format.XML>
*/
OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format.XML, {
/*
/**
* APIProperty: featureNS
* {String} Namespace used for feature attributes. Default is
* "http://mapserver.gis.umn.edu/mapserver".
@@ -38,13 +38,13 @@ OpenLayers.Format.GML = OpenLayers.Class(OpenLayers.Format.XML, {
*/
featurePrefix: "feature",
/*
/**
* APIProperty: featureName
* {String} Element name for features. Default is "featureMember".
*/
featureName: "featureMember",
/*
/**
* APIProperty: layerName
* {String} Name of data layer. Default is "features".
*/

8
lib/OpenLayers/Format/GPX.js
View File

@@ -281,7 +281,7 @@ OpenLayers.Format.GPX = OpenLayers.Class(OpenLayers.Format.XML, {
*
* Parameters:
* trknode
* geometry - {OpenLayers.Geometry}
* geometry - {<OpenLayers.Geometry>}
*/
buildTrkSegNode: function(geometry) {
var node,
@@ -311,7 +311,7 @@ OpenLayers.Format.GPX = OpenLayers.Class(OpenLayers.Format.XML, {
* Builds a trkpt node given a point
*
* Parameters:
* line - {OpenLayers.Geometry.Point}
* point - {<OpenLayers.Geometry.Point>}
*
* Returns:
* {DOMElement} A trkpt node
@@ -328,7 +328,7 @@ OpenLayers.Format.GPX = OpenLayers.Class(OpenLayers.Format.XML, {
* Builds a wpt node given a point
*
* Parameters:
* feature - {OpenLayers.Feature.Vector}
* feature - {<OpenLayers.Feature.Vector>}
*
* Returns:
* {DOMElement} A wpt node
@@ -347,7 +347,7 @@ OpenLayers.Format.GPX = OpenLayers.Class(OpenLayers.Format.XML, {
*
* Parameters:
* node - {DOMElement} the node to append the attribute nodes to.
* feature - {OpenLayers.Feature.Vector}
* feature - {<OpenLayers.Feature.Vector>}
*/
appendAttributesNode: function(node, feature) {
var name = this.createElementNS(this.gpxns, 'name');

2
lib/OpenLayers/Format/GeoJSON.js
View File

@@ -635,7 +635,7 @@ OpenLayers.Format.GeoJSON = OpenLayers.Class(OpenLayers.Format.JSON, {
* Return an array of linestring arrays from a linestring.
*
* Parameters:
* linestring - {<OpenLayers.Geometry.MultiLineString>}
* multilinestring - {<OpenLayers.Geometry.MultiLineString>}
*
* Returns:
* {Array} An array of linestring arrays representing

2
lib/OpenLayers/Format/KML.js
View File

@@ -1393,7 +1393,7 @@ OpenLayers.Format.KML = OpenLayers.Class(OpenLayers.Format.XML, {
* Parameters:
* geometry - {<OpenLayers.Geometry>}
*
* Return:
* Returns:
* {DOMElement}
*/
buildCoordinatesNode: function(geometry) {

8
lib/OpenLayers/Format/OSM.js
View File

@@ -87,7 +87,7 @@ OpenLayers.Format.OSM = OpenLayers.Class(OpenLayers.Format.XML, {
* Return a list of features from a OSM doc
* Parameters:
* data - {Element}
* doc - {Element}
*
* Returns:
* An Array of <OpenLayers.Feature.Vector>s
@@ -176,7 +176,7 @@ OpenLayers.Format.OSM = OpenLayers.Class(OpenLayers.Format.XML, {
* Return the node items from a doc.
*
* Parameters:
* node - {DOMElement} node to parse tags from
* doc - {DOMElement} node to parse tags from
*/
getNodes: function(doc) {
var node_list = doc.getElementsByTagName("node");
@@ -198,7 +198,7 @@ OpenLayers.Format.OSM = OpenLayers.Class(OpenLayers.Format.XML, {
* Return the way items from a doc.
*
* Parameters:
* node - {DOMElement} node to parse tags from
* doc - {DOMElement} node to parse tags from
*/
getWays: function(doc) {
var way_list = doc.getElementsByTagName("way");
@@ -229,7 +229,7 @@ OpenLayers.Format.OSM = OpenLayers.Class(OpenLayers.Format.XML, {
* Return the tags list attached to a specific DOM element.
*
* Parameters:
* node - {DOMElement} node to parse tags from
* dom_node - {DOMElement} node to parse tags from
* interesting_tags - {Boolean} whether the return from this function should
* return a boolean indicating that it has 'interesting tags' --
* tags like attribution and source are ignored. (To change the list

3
lib/OpenLayers/Format/OWSCommon/v1.js
View File

@@ -10,6 +10,9 @@
/**
* Class: OpenLayers.Format.OWSCommon.v1
* Common readers and writers for OWSCommon v1.X formats
*
* Inherits from:
* - <OpenLayers.Format.XML>
*/
OpenLayers.Format.OWSCommon.v1 = OpenLayers.Class(OpenLayers.Format.XML, {

3
lib/OpenLayers/Format/OWSCommon/v1_0_0.js
View File

@@ -10,6 +10,9 @@
/**
* Class: OpenLayers.Format.OWSCommon.v1_0_0
* Parser for OWS Common version 1.0.0.
*
* Inherits from:
* - <OpenLayers.Format.OWSCommon.v1>
*/
OpenLayers.Format.OWSCommon.v1_0_0 = OpenLayers.Class(OpenLayers.Format.OWSCommon.v1, {

3
lib/OpenLayers/Format/OWSCommon/v1_1_0.js
View File

@@ -10,6 +10,9 @@
/**
* Class: OpenLayers.Format.OWSCommon.v1_1_0
* Parser for OWS Common version 1.1.0.
*
* Inherits from:
* - <OpenLayers.Format.OWSCommon.v1>
*/
OpenLayers.Format.OWSCommon.v1_1_0 = OpenLayers.Class(OpenLayers.Format.OWSCommon.v1, {

3
lib/OpenLayers/Format/OWSContext.js
View File

@@ -15,6 +15,9 @@
* Web Map Context (WMC), since it is more generic and more types of layers
* can be stored. Also, nesting of layers is supported since version 0.3.1.
* For more information see: http://www.ogcnetwork.net/context
*
* Inherits from:
* - <OpenLayers.Format.Context>
*/
OpenLayers.Format.OWSContext = OpenLayers.Class(OpenLayers.Format.Context,{

2
lib/OpenLayers/Format/OWSContext/v0_3_1.js
View File

@@ -228,7 +228,7 @@ OpenLayers.Format.OWSContext.v0_3_1 = OpenLayers.Class(OpenLayers.Format.XML, {
*
* Parameters:
* layerArray - {Array({Object})} Array of layerContext objects
* layerContext - {Object} layerContext object
* layer - {Object} layerContext object
*/
processLayer: function(layerArray, layer) {
if (layer.layersContext) {

2
lib/OpenLayers/Format/Text.js
View File

@@ -69,7 +69,7 @@ OpenLayers.Format.Text = OpenLayers.Class(OpenLayers.Format, {
* Return a list of features from a Tab Seperated Values text string.
*
* Parameters:
* data - {String}
* text - {String}
*
* Returns:
* An Array of <OpenLayers.Feature.Vector>s

6
lib/OpenLayers/Format/WFS.js
View File

@@ -20,20 +20,23 @@ OpenLayers.Format.WFS = OpenLayers.Class(OpenLayers.Format.GML, {
/**
* Property: layer
* {<OpenLayers.Layer>}
*/
layer: null,
/**
* APIProperty: wfsns
* {String}
*/
wfsns: "http://www.opengis.net/wfs",
/**
* Property: ogcns
* {String}
*/
ogcns: "http://www.opengis.net/ogc",
/*
/**
* Constructor: OpenLayers.Format.WFS
* Create a WFS-T formatter. This requires a layer: that layer should
* have two properties: geometry_column and typename. The parser
@@ -45,7 +48,6 @@ OpenLayers.Format.WFS = OpenLayers.Class(OpenLayers.Format.GML, {
* options - {Object}
* layer - {<OpenLayers.Layer>}
*/
initialize: function(options, layer) {
OpenLayers.Format.GML.prototype.initialize.apply(this, [options]);
this.layer = layer;

12
lib/OpenLayers/Format/WKT.js
View File

@@ -270,7 +270,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, {
/**
* Return a multipoint feature given a multipoint WKT fragment.
* @param {String} A WKT fragment representing the multipoint
* @param {String} str A WKT fragment representing the multipoint
* @returns {OpenLayers.Feature.Vector} A multipoint feature
* @private
*/
@@ -289,7 +289,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, {
/**
* Return a linestring feature given a linestring WKT fragment.
* @param {String} A WKT fragment representing the linestring
* @param {String} str A WKT fragment representing the linestring
* @returns {OpenLayers.Feature.Vector} A linestring feature
* @private
*/
@@ -306,7 +306,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, {
/**
* Return a multilinestring feature given a multilinestring WKT fragment.
* @param {String} A WKT fragment representing the multilinestring
* @param {String} str A WKT fragment representing the multilinestring
* @returns {OpenLayers.Feature.Vector} A multilinestring feature
* @private
*/
@@ -325,7 +325,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, {
/**
* Return a polygon feature given a polygon WKT fragment.
* @param {String} A WKT fragment representing the polygon
* @param {String} str A WKT fragment representing the polygon
* @returns {OpenLayers.Feature.Vector} A polygon feature
* @private
*/
@@ -346,7 +346,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, {
/**
* Return a multipolygon feature given a multipolygon WKT fragment.
* @param {String} A WKT fragment representing the multipolygon
* @param {String} str A WKT fragment representing the multipolygon
* @returns {OpenLayers.Feature.Vector} A multipolygon feature
* @private
*/
@@ -365,7 +365,7 @@ OpenLayers.Format.WKT = OpenLayers.Class(OpenLayers.Format, {
/**
* Return an array of features given a geometrycollection WKT fragment.
* @param {String} A WKT fragment representing the geometrycollection
* @param {String} str A WKT fragment representing the geometrycollection
* @returns {Array} An array of OpenLayers.Feature.Vector
* @private
*/

4
lib/OpenLayers/Format/WMC.js
View File

@@ -13,7 +13,7 @@
* Read and write Web Map Context documents.
*
* Inherits from:
* - <OpenLayers.Format.XML>
* - <OpenLayers.Format.Context>
*/
OpenLayers.Format.WMC = OpenLayers.Class(OpenLayers.Format.Context, {
@@ -37,7 +37,7 @@ OpenLayers.Format.WMC = OpenLayers.Class(OpenLayers.Format.Context, {
* Create a layer context object given a wms layer object.
*
* Parameters:
* obj - {<OpenLayers.Layer.WMS>} The layer.
* layer - {<OpenLayers.Layer.WMS>} The layer.
*
* Returns:
* {Object} A layer context object.

4
lib/OpenLayers/Format/WMC/v1.js
View File

@@ -1011,7 +1011,7 @@ OpenLayers.Format.WMC.v1 = OpenLayers.Class(OpenLayers.Format.XML, {
* null or undefined, null will be returned.
*
* Parameters:
* object - {Object} An object.
* obj - {Object} An object.
* prop - {String} A property.
*
* Returns:
@@ -1143,7 +1143,7 @@ OpenLayers.Format.WMC.v1 = OpenLayers.Class(OpenLayers.Format.XML, {
* Create a StyleList node given a layer context.
*
* Parameters:
* context - {Object} Layer context object.
* layer - {Object} Layer context object.
*
* Returns:
* {Element} A WMC StyleList element node.

3
lib/OpenLayers/Geometry.js
View File

@@ -67,10 +67,11 @@ OpenLayers.Geometry = OpenLayers.Class({
},
/**
* Method: setBounds
* Set the bounds for this Geometry.
*
* Parameters:
* object - {<OpenLayers.Bounds>}
* bounds - {<OpenLayers.Bounds>}
*/
setBounds: function(bounds) {
if (bounds) {

6
lib/OpenLayers/Geometry/Collection.js
View File

@@ -22,7 +22,7 @@
*
* Create a new instance with the <OpenLayers.Geometry.Collection> constructor.
*
* Inerhits from:
* Inherits from:
* - <OpenLayers.Geometry>
*/
OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
@@ -407,7 +407,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
* ratio - {Float} Optional x:y ratio for resizing. Default ratio is 1.
*
* Returns:
* {OpenLayers.Geometry} - The current geometry.
* {<OpenLayers.Geometry>} - The current geometry.
*/
resize: function(scale, origin, ratio) {
for(var i=0; i<this.components.length; ++i) {
@@ -468,7 +468,7 @@ OpenLayers.Geometry.Collection = OpenLayers.Class(OpenLayers.Geometry, {
* are considered equivalent if all components have the same coordinates.
*
* Parameters:
* geom - {<OpenLayers.Geometry>} The geometry to test.
* geometry - {<OpenLayers.Geometry>} The geometry to test.
*
* Returns:
* {Boolean} The supplied geometry is equivalent to this geometry.

4
lib/OpenLayers/Geometry/LinearRing.js
View File

@@ -53,7 +53,7 @@ OpenLayers.Geometry.LinearRing = OpenLayers.Class(
* be overridden by calling the method with a non-null index as the
* second argument.
*
* Parameter:
* Parameters:
* point - {<OpenLayers.Geometry.Point>}
* index - {Integer} Index into the array to insert the component
*
@@ -153,7 +153,7 @@ OpenLayers.Geometry.LinearRing = OpenLayers.Class(
* ratio - {Float} Optional x:y ratio for resizing. Default ratio is 1.
*
* Returns:
* {OpenLayers.Geometry} - The current geometry.
* {<OpenLayers.Geometry>} - The current geometry.
*/
resize: function(scale, origin, ratio) {
for(var i=0, len=this.components.length; i<len - 1; ++i) {

2
lib/OpenLayers/Geometry/MultiLineString.js
View File

@@ -42,7 +42,7 @@ OpenLayers.Geometry.MultiLineString = OpenLayers.Class(
* Use this geometry (the source) to attempt to split a target geometry.
*
* Parameters:
* target - {<OpenLayers.Geometry>} The target geometry.
* geometry - {<OpenLayers.Geometry>} The target geometry.
* options - {Object} Properties of this object will be used to determine
* how the split is conducted.
*

2
lib/OpenLayers/Geometry/Point.js
View File

@@ -212,7 +212,7 @@ OpenLayers.Geometry.Point = OpenLayers.Class(OpenLayers.Geometry, {
* ratio - {Float} Optional x:y ratio for resizing. Default ratio is 1.
*
* Returns:
* {OpenLayers.Geometry} - The current geometry.
* {<OpenLayers.Geometry>} - The current geometry.
*/
resize: function(scale, origin, ratio) {
ratio = (ratio == undefined) ? 1 : ratio;

3
lib/OpenLayers/Handler/Feature.js
View File

@@ -16,6 +16,9 @@
*
* This handler stops event propagation for mousedown and mouseup if those
* browser events target features that can be selected.
*
* Inherits from:
* - <OpenLayers.Handler>
*/
OpenLayers.Handler.Feature = OpenLayers.Class(OpenLayers.Handler, {

11
lib/OpenLayers/Handler/Path.js
View File

@@ -30,8 +30,7 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, {
* APIProperty: maxVertices
* {Number} The maximum number of vertices which can be drawn by this
* handler. When the number of vertices reaches maxVertices, the
* geometry is automatically finalized. This property doesn't
* apply if freehand is set. Default is null.
* geometry is automatically finalized. Default is null.
*/
maxVertices: null,
@@ -446,7 +445,13 @@ OpenLayers.Handler.Path = OpenLayers.Class(OpenLayers.Handler.Point, {
if(this.persist) {
this.destroyPersistedFeature();
}
this.addPoint(evt.xy);
if(this.maxVertices && this.line &&
this.line.geometry.components.length === this.maxVertices) {
this.removePoint()
this.finalize();
} else {
this.addPoint(evt.xy);
}
return false;
}
if (!this.touch && (!this.mouseDown || this.stoppedDown)) {

2
lib/OpenLayers/Handler/Polygon.js
View File

@@ -35,7 +35,7 @@ OpenLayers.Handler.Polygon = OpenLayers.Class(OpenLayers.Handler.Path, {
drawingHole: false,
/**
* Parameter: polygon
* Property: polygon
* {<OpenLayers.Feature.Vector>}
*/
polygon: null,

4
lib/OpenLayers/Handler/RegularPolygon.js
View File

@@ -168,7 +168,7 @@ OpenLayers.Handler.RegularPolygon = OpenLayers.Class(OpenLayers.Handler.Drag, {
* APIMethod: activate
* Turn on the handler.
*
* Return:
* Returns:
* {Boolean} The handler was successfully activated
*/
activate: function() {
@@ -195,7 +195,7 @@ OpenLayers.Handler.RegularPolygon = OpenLayers.Class(OpenLayers.Handler.Drag, {
* APIMethod: deactivate
* Turn off the handler.
*
* Return:
* Returns:
* {Boolean} The handler was successfully deactivated
*/
deactivate: function() {

2
lib/OpenLayers/Icon.js
View File

@@ -41,7 +41,7 @@ OpenLayers.Icon = OpenLayers.Class({
/**
* Property: calculateOffset
* {<OpenLayers.Pixel>} Function to calculate the offset (based on the size)
* {Function} Function to calculate the offset (based on the size)
*/
calculateOffset: null,

6
lib/OpenLayers/Layer.js
View File

@@ -975,7 +975,7 @@ OpenLayers.Layer = OpenLayers.Class({
* Parameters:
* props - {Object} Properties
*
* Return:
* Returns:
* {Array({Number})} Array of resolutions.
*/
calculateResolutions: function(props) {
@@ -1124,7 +1124,7 @@ OpenLayers.Layer = OpenLayers.Class({
/**
* APIMethod: getResolutionForZoom
*
* Parameter:
* Parameters:
* zoom - {Float}
*
* Returns:
@@ -1265,7 +1265,7 @@ OpenLayers.Layer = OpenLayers.Class({
* APIMethod: setOpacity
* Sets the opacity for the entire layer (all images)
*
* Parameter:
* Parameters:
* opacity - {Float}
*/
setOpacity: function(opacity) {

2
lib/OpenLayers/Layer/ArcGISCache.js
View File

@@ -363,7 +363,7 @@ OpenLayers.Layer.ArcGISCache = OpenLayers.Class(OpenLayers.Layer.XYZ, {
* Get this layer's maximum extent.
*
* Returns:
* {OpenLayers.Bounds}
* {<OpenLayers.Bounds>}
*/
getMaxExtent: function() {
var resolution = this.map.getResolution();

9
lib/OpenLayers/Layer/Bing.js
View File

@@ -21,6 +21,13 @@
*/
OpenLayers.Layer.Bing = OpenLayers.Class(OpenLayers.Layer.XYZ, {
/**
* Property: key
* {String} API key for Bing maps, get your own key
* at http://bingmapsportal.com/ .
*/
key: null,
/**
* Property: serverResolutions
* {Array} the resolutions provided by the Bing servers.
@@ -82,7 +89,7 @@ OpenLayers.Layer.Bing = OpenLayers.Class(OpenLayers.Layer.XYZ, {
* (end)
*
* Parameters:
* config - {Object} Configuration properties for the layer.
* options - {Object} Configuration properties for the layer.
*
* Required configuration properties:
* key - {String} Bing Maps API key for your application. Get one at

1
lib/OpenLayers/Layer/GeoRSS.js
View File

@@ -15,7 +15,6 @@
*
* Inherits from:
* - <OpenLayers.Layer.Markers>
* - <OpenLayers.Layer>
*/
OpenLayers.Layer.GeoRSS = OpenLayers.Class(OpenLayers.Layer.Markers, {

2
lib/OpenLayers/Layer/Google.js
View File

@@ -205,7 +205,7 @@ OpenLayers.Layer.Google = OpenLayers.Class(
* APIMethod: setOpacity
* Sets the opacity for the entire layer (all images)
*
* Parameter:
* Parameters:
* opacity - {Float}
*/
setOpacity: function(opacity) {

2
lib/OpenLayers/Layer/Grid.js
View File

@@ -817,7 +817,7 @@ OpenLayers.Layer.Grid = OpenLayers.Class(OpenLayers.Layer.HTTPRequest, {
* potential specific implementations in sub-classes.)
*
* Returns:
* {OpenLayers.Bounds}
* {<OpenLayers.Bounds>}
*/
getMaxExtent: function() {
return this.maxExtent;

5
lib/OpenLayers/Layer/Image.js
View File

@@ -12,7 +12,10 @@
* Class: OpenLayers.Layer.Image
* Instances of OpenLayers.Layer.Image are used to display data from a web
* accessible image as a map layer. Create a new image layer with the
* <OpenLayers.Layer.Image> constructor. Inherits from <OpenLayers.Layer>.
* <OpenLayers.Layer.Image> constructor.
*
* Inherits from:
* - <OpenLayers.Layer>
*/
OpenLayers.Layer.Image = OpenLayers.Class(OpenLayers.Layer, {

2
lib/OpenLayers/Layer/MapServer.js
View File

@@ -114,7 +114,7 @@ OpenLayers.Layer.MapServer = OpenLayers.Class(OpenLayers.Layer.Grid, {
* Method: getFullRequestString
* combine the layer's url with its params and these newParams.
*
* Parameter:
* Parameters:
* newParams - {Object} New parameters that should be added to the
* request string.
* altUrl - {String} (optional) Replace the URL in the full request

2
lib/OpenLayers/Layer/Markers.js
View File

@@ -64,7 +64,7 @@ OpenLayers.Layer.Markers = OpenLayers.Class(OpenLayers.Layer, {
* APIMethod: setOpacity
* Sets the opacity for all the markers.
*
* Parameter:
* Parameters:
* opacity - {Float}
*/
setOpacity: function(opacity) {

2
lib/OpenLayers/Layer/PointGrid.js
View File

@@ -69,7 +69,7 @@ OpenLayers.Layer.PointGrid = OpenLayers.Class(OpenLayers.Layer.Vector, {
/**
* APIProperty: origin
* {OpenLayers.LonLat} Grid origin. The grid lattice will be aligned with
* {<OpenLayers.LonLat>} Grid origin. The grid lattice will be aligned with
* the origin. If not set at construction, the center of the map's maximum
* extent is used. Read-only. Use the <setOrigin> method to modify this
* value.

3
lib/OpenLayers/Layer/Text.js
View File

@@ -234,6 +234,9 @@ OpenLayers.Layer.Text = OpenLayers.Class(OpenLayers.Layer.Markers, {
*
* Parameters:
* evt - {Event}
*
* Context:
* - {<OpenLayers.Feature>}
*/
markerClick: function(evt) {
var sameMarkerClicked = (this == this.layer.selectedFeature);

18
lib/OpenLayers/Map.js
View File

@@ -359,7 +359,7 @@ OpenLayers.Map = OpenLayers.Class({
/**
* Property: panTween
* {OpenLayers.Tween} Animated panning tween object, see panTo()
* {<OpenLayers.Tween>} Animated panning tween object, see panTo()
*/
panTween: null,
@@ -776,7 +776,7 @@ OpenLayers.Map = OpenLayers.Class({
* APIMethod: getLayersBy
* Get a list of layers with properties matching the given criteria.
*
* Parameter:
* Parameters:
* property - {String} A layer property to be matched.
* match - {String | Object} A string to match. Can also be a regular
* expression literal or object. In addition, it can be any object
@@ -797,7 +797,7 @@ OpenLayers.Map = OpenLayers.Class({
* APIMethod: getLayersByName
* Get a list of layers with names matching the given name.
*
* Parameter:
* Parameters:
* match - {String | Object} A layer name. The name can also be a regular
* expression literal or object. In addition, it can be any object
* with a method named test. For reqular expressions or other, if
@@ -817,7 +817,7 @@ OpenLayers.Map = OpenLayers.Class({
* APIMethod: getLayersByClass
* Get a list of layers of a given class (CLASS_NAME).
*
* Parameter:
* Parameters:
* match - {String | Object} A layer class name. The match can also be a
* regular expression literal or object. In addition, it can be any
* object with a method named test. For reqular expressions or other,
@@ -837,7 +837,7 @@ OpenLayers.Map = OpenLayers.Class({
* APIMethod: getControlsBy
* Get a list of controls with properties matching the given criteria.
*
* Parameter:
* Parameters:
* property - {String} A control property to be matched.
* match - {String | Object} A string to match. Can also be a regular
* expression literal or object. In addition, it can be any object
@@ -858,7 +858,7 @@ OpenLayers.Map = OpenLayers.Class({
* APIMethod: getControlsByClass
* Get a list of controls of a given class (CLASS_NAME).
*
* Parameter:
* Parameters:
* match - {String | Object} A control class name. The match can also be a
* regular expression literal or object. In addition, it can be any
* object with a method named test. For reqular expressions or other,
@@ -887,7 +887,7 @@ OpenLayers.Map = OpenLayers.Class({
* APIMethod: getLayer
* Get a layer based on its id
*
* Parameter:
* Parameters:
* id - {String} A layer id
*
* Returns:
@@ -2159,7 +2159,7 @@ OpenLayers.Map = OpenLayers.Class({
/**
* APIMethod: getResolutionForZoom
*
* Parameter:
* Parameters:
* zoom - {Float}
*
* Returns:
@@ -2177,7 +2177,7 @@ OpenLayers.Map = OpenLayers.Class({
/**
* APIMethod: getZoomForResolution
*
* Parameter:
* Parameters:
* resolution - {Float}
* closest - {Boolean} Find the zoom level that corresponds to the absolute
* closest resolution, which may result in a zoom whose corresponding

4
lib/OpenLayers/Popup/Anchored.js
View File

@@ -18,7 +18,7 @@ OpenLayers.Popup.Anchored =
OpenLayers.Class(OpenLayers.Popup, {
/**
* Parameter: relativePosition
* Property: relativePosition
* {String} Relative position of the popup ("br", "tr", "tl" or "bl").
*/
relativePosition: null,
@@ -38,7 +38,7 @@ OpenLayers.Popup.Anchored =
keepInMap: true,
/**
* Parameter: anchor
* Property: anchor
* {Object} Object to which we'll anchor the popup. Must expose a
* 'size' (<OpenLayers.Size>) and 'offset' (<OpenLayers.Pixel>).
*/

15
lib/OpenLayers/Protocol.js
View File

@@ -36,7 +36,7 @@ OpenLayers.Protocol = OpenLayers.Class({
/**
* Property: defaultFilter
* {OpenLayers.Filter} Optional default filter to read requests
* {<OpenLayers.Filter>} Optional default filter to read requests
*/
defaultFilter: null,
@@ -59,7 +59,7 @@ OpenLayers.Protocol = OpenLayers.Class({
* Merge filter passed to the read method with the default one
*
* Parameters:
* filter - {OpenLayers.Filter}
* filter - {<OpenLayers.Filter>}
*/
mergeWithDefaultFilter: function(filter) {
var merged;
@@ -231,10 +231,19 @@ OpenLayers.Protocol.Response = OpenLayers.Class({
/**
* Property: features
* {Array({<OpenLayers.Feature.Vector>})} or {<OpenLayers.Feature.Vector>}
* The features returned in the response by the server.
* The features returned in the response by the server. Depending on the
* protocol's read payload, either features or data will be populated.
*/
features: null,
/**
* Property: data
* {Object}
* The data returned in the response by the server. Depending on the
* protocol's read payload, either features or data will be populated.
*/
data: null,
/**
* Property: reqFeatures
* {Array({<OpenLayers.Feature.Vector>})} or {<OpenLayers.Feature.Vector>}

30
lib/OpenLayers/Protocol/CSW.js Normal file
View File

@@ -0,0 +1,30 @@
/* Copyright (c) 2006-2012 by OpenLayers Contributors (see authors.txt for
* full list of contributors). Published under the Clear BSD license.
* See http://svn.openlayers.org/trunk/openlayers/license.txt for the
* full text of the license. */
/**
* @requires OpenLayers/Protocol.js
*/
/**
* Class: OpenLayers.Protocol.CSW
* Used to create a versioned CSW protocol. Default version is 2.0.2.
*/
OpenLayers.Protocol.CSW = function(options) {
options = OpenLayers.Util.applyDefaults(
options, OpenLayers.Protocol.CSW.DEFAULTS
);
var cls = OpenLayers.Protocol.CSW["v"+options.version.replace(/\./g, "_")];
if(!cls) {
throw "Unsupported CSW version: " + options.version;
}
return new cls(options);
};
/**
* Constant: OpenLayers.Protocol.CSW.DEFAULTS
*/
OpenLayers.Protocol.CSW.DEFAULTS = {
"version": "2.0.2"
};

144
lib/OpenLayers/Protocol/CSW/v2_0_2.js Normal file
View File

@@ -0,0 +1,144 @@
/* Copyright (c) 2006-2012 by OpenLayers Contributors (see authors.txt for
* full list of contributors). Published under the Clear BSD license.
* See http://svn.openlayers.org/trunk/openlayers/license.txt for the
* full text of the license. */
/**
* @requires OpenLayers/Protocol/CSW.js
* @requires OpenLayers/Format/CSWGetRecords/v2_0_2.js
*/
/**
* Class: OpenLayers.Protocol.CSW.v2_0_2
* CS-W (Catalogue services for the Web) version 2.0.2 protocol.
*
* Inherits from:
* - <OpenLayers.Protocol>
*/
OpenLayers.Protocol.CSW.v2_0_2 = OpenLayers.Class(OpenLayers.Protocol, {
/**
* Property: formatOptions
* {Object} Optional options for the format. If a format is not provided,
* this property can be used to extend the default format options.
*/
formatOptions: null,
/**
* Constructor: OpenLayers.Protocol.CSW.v2_0_2
* A class for CSW version 2.0.2 protocol management.
*
* Parameters:
* options - {Object} Optional object whose properties will be set on the
* instance.
*/
initialize: function(options) {
OpenLayers.Protocol.prototype.initialize.apply(this, [options]);
if(!options.format) {
this.format = new OpenLayers.Format.CSWGetRecords.v2_0_2(OpenLayers.Util.extend({
}, this.formatOptions));
}
},
/**
* APIMethod: destroy
* Clean up the protocol.
*/
destroy: function() {
if(this.options && !this.options.format) {
this.format.destroy();
}
this.format = null;
OpenLayers.Protocol.prototype.destroy.apply(this);
},
/**
* Method: createCallback
* Returns a function that applies the given public method with resp and
* options arguments.
*
* Parameters:
* method - {Function} The method to be applied by the callback.
* response - {<OpenLayers.Protocol.Response>} The protocol response object.
* options - {Object} Options sent to the protocol method (read, create,
* update, or delete).
*/
createCallback: function(method, response, options) {
return OpenLayers.Function.bind(function() {
method.apply(this, [response, options]);
}, this);
},
/**
* Method: read
* Construct a request for reading new records from the Catalogue.
*/
read: function(options) {
options = OpenLayers.Util.extend({}, options);
OpenLayers.Util.applyDefaults(options, this.options || {});
var response = new OpenLayers.Protocol.Response({requestType: "read"});
var data = this.format.write(options.params);
response.priv = OpenLayers.Request.POST({
url: options.url,
callback: this.createCallback(this.handleRead, response, options),
params: options.params,
headers: options.headers,
data: data
});
return response;
},
/**
* Method: handleRead
* Deal with response from the read request.
*
* Parameters:
* response - {<OpenLayers.Protocol.Response>} The response object to pass
* to the user callback.
* This response is given a code property, and optionally a data property.
* The latter represents the CSW records as returned by the call to
* the CSW format read method.
* options - {Object} The user options passed to the read call.
*/
handleRead: function(response, options) {
if(options.callback) {
var request = response.priv;
if(request.status >= 200 && request.status < 300) {
// success
response.data = this.parseData(request);
response.code = OpenLayers.Protocol.Response.SUCCESS;
} else {
// failure
response.code = OpenLayers.Protocol.Response.FAILURE;
}
options.callback.call(options.scope, response);
}
},
/**
* Method: parseData
* Read HTTP response body and return records
*
* Parameters:
* request - {XMLHttpRequest} The request object
*
* Returns:
* {Object} The CSW records as returned by the call to the format read method.
*/
parseData: function(request) {
var doc = request.responseXML;
if(!doc || !doc.documentElement) {
doc = request.responseText;
}
if(!doc || doc.length <= 0) {
return null;
}
return this.format.read(doc);
},
CLASS_NAME: "OpenLayers.Protocol.CSW.v2_0_2"
});

2
lib/OpenLayers/Protocol/WFS/v1.js
View File

@@ -384,7 +384,7 @@ OpenLayers.Protocol.WFS.v1 = OpenLayers.Class(OpenLayers.Protocol, {
* Send a request that deletes all features by their filter.
*
* Parameters:
* filter - {OpenLayers.Filter} filter
* filter - {<OpenLayers.Filter>} filter
*/
filterDelete: function(filter, options) {
options = OpenLayers.Util.extend({}, options);

8
lib/OpenLayers/Renderer/Elements.js
View File

@@ -420,9 +420,11 @@ OpenLayers.Renderer.Elements = OpenLayers.Class(OpenLayers.Renderer, {
*
* Parameters:
* containerID - {String}
* options - {Object} options for this renderer. Supported options are:
* * yOrdering - {Boolean} Whether to use y-ordering
* * zIndexing - {Boolean} Whether to use z-indexing. Will be ignored
* options - {Object} options for this renderer.
*
* Supported options are:
* yOrdering - {Boolean} Whether to use y-ordering
* zIndexing - {Boolean} Whether to use z-indexing. Will be ignored
* if yOrdering is set to true.
*/
initialize: function(containerID, options) {

2
lib/OpenLayers/Renderer/SVG.js
View File

@@ -452,7 +452,7 @@ OpenLayers.Renderer.SVG = OpenLayers.Class(OpenLayers.Renderer.Elements, {
/**
* Method: createRoot
*
* Parameter:
* Parameters:
* suffix - {String} suffix to append to the id
*
* Returns:

2
lib/OpenLayers/Renderer/SVG2.js
View File

@@ -387,7 +387,7 @@ OpenLayers.Renderer.SVG2 = OpenLayers.Class(OpenLayers.Renderer.NG, {
/**
* Method: createRoot
*
* Parameter:
* Parameters:
* suffix - {String} suffix to append to the id
*
* Returns:

2
lib/OpenLayers/Strategy/Fixed.js
View File

@@ -105,7 +105,7 @@ OpenLayers.Strategy.Fixed = OpenLayers.Class(OpenLayers.Strategy, {
* Add all features to the layer.
*
* Parameters:
* mapProjection - {OpenLayers.Projection} the map projection
* mapProjection - {<OpenLayers.Projection>} the map projection
* resp - {Object} options to pass to protocol read.
*/
merge: function(mapProjection, resp) {

4
lib/OpenLayers/Style.js
View File

@@ -111,7 +111,7 @@ OpenLayers.Style = OpenLayers.Class({
* rules - {Array(<OpenLayers.Rule>)} List of rules to be added to the
* style.
*
* Return:
* Returns:
* {<OpenLayers.Style>}
*/
initialize: function(style, options) {
@@ -202,7 +202,7 @@ OpenLayers.Style = OpenLayers.Class({
* Method: applySymbolizer
*
* Parameters:
* rule - {OpenLayers.Rule}
* rule - {<OpenLayers.Rule>}
* style - {Object}
* feature - {<OpenLayer.Feature.Vector>}
*

2
lib/OpenLayers/Style2.js
View File

@@ -70,7 +70,7 @@ OpenLayers.Style2 = OpenLayers.Class({
* config - {Object} An object containing properties to be set on the
* style. Any documented properties may be set at construction.
*
* Return:
* Returns:
* {<OpenLayers.Style2>} A new style object.
*/
initialize: function(config) {

2
lib/OpenLayers/StyleMap.js
View File

@@ -16,7 +16,7 @@ OpenLayers.StyleMap = OpenLayers.Class({
/**
* Property: styles
* Hash of {<OpenLayers.Style>}, keyed by names of well known
* {Object} Hash of {<OpenLayers.Style>}, keyed by names of well known
* rendering intents (e.g. "default", "temporary", "select", "delete").
*/
styles: null,

2
lib/OpenLayers/Tile.js
View File

@@ -9,7 +9,7 @@
* @requires OpenLayers/Util.js
*/
/*
/**
* Class: OpenLayers.Tile
* This is a class designed to designate a single tile, however
* it is explicitly designed to do relatively little. Tiles store

21
lib/OpenLayers/Util.js
View File

@@ -24,8 +24,9 @@ OpenLayers.Util = OpenLayers.Util || {};
*
* Parameters:
* e - {String or DOMElement or Window}
* Return:
* {Array(DOMElement)}
*
* Returns:
* {Array(DOMElement) or DOMElement}
*/
OpenLayers.Util.getElement = function() {
var elements = [];
@@ -66,7 +67,7 @@ OpenLayers.Util.isElement = function(o) {
* Parameters:
* a - {Object} the object test.
*
* Returns
* Returns:
* {Boolean} true if the object is an array.
*/
OpenLayers.Util.isArray = function(a) {
@@ -89,7 +90,7 @@ if(typeof window.$ === "undefined") {
* array - {Array}
* item - {Object}
*
* Return
* Returns:
* {Array} A reference to the array
*/
OpenLayers.Util.removeItem = function(array, item) {
@@ -1310,10 +1311,12 @@ OpenLayers.Util.isEquivalentUrl = function(url1, url2, options) {
*
* Parameters:
* url - {String}
* options - {Object} A hash of options. Can be one of:
* ignoreCase: lowercase url,
* ignorePort80: don't include explicit port if port is 80,
* ignoreHash: Don't include part of url after the hash (#).
* options - {Object} A hash of options.
*
* Valid options:
* ignoreCase - {Boolean} lowercase url,
* ignorePort80 - {Boolean} don't include explicit port if port is 80,
* ignoreHash - {Boolean} Don't include part of url after the hash (#).
*
* Returns:
* {Object} An object with separate url, a, port, host, and args parsed out
@@ -1488,7 +1491,7 @@ OpenLayers.Util.getBrowserName = function() {
* this node instead of the body root when calculating dimensions.
*
* Returns:
* {OpenLayers.Size}
* {<OpenLayers.Size>}
*/
OpenLayers.Util.getRenderedDimensions = function(contentHTML, size, options) {