org.gwtopenmaps.openlayers.client.control
Class WMSGetFeatureInfoOptions

java.lang.Object
  org.gwtopenmaps.openlayers.client.util.JSObjectWrapper
      org.gwtopenmaps.openlayers.client.control.WMSGetFeatureInfoOptions

public class WMSGetFeatureInfoOptions
extends JSObjectWrapper

Author:

Dave Potts, Lukas Johansson

Nested Class Summary

static class

WMSGetFeatureInfoOptions.GetFeatureInfoFormat

Constructor Summary

	WMSGetFeatureInfoOptions()
protected	WMSGetFeatureInfoOptions(JSObject jsObject)

Method Summary

boolean	getHover()
int	getMaxFeatures()
void	setDrillDown(boolean value) Drill down over all WMS layers in the map.
void	setHover(boolean hover)
void	setInfoFormat(String infoFormat) The mimetype to request from the server defaults to 'text/html'
void	setLayers(WMS[] layers) The layers to query for feature info.
void	setLayerUrls(String[] urls) Optional list of urls for layers that should be queried.
void	setMaxFeaturess(int maxFeatures)
void	setQueryVisible(Boolean qvis)
void	setTitle(String title)
void	setURL(String url) The URL of the WMS service to use.

Methods inherited from class org.gwtopenmaps.openlayers.client.util.JSObjectWrapper

getJSObject, setJSObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WMSGetFeatureInfoOptions

protected WMSGetFeatureInfoOptions(JSObject jsObject)

WMSGetFeatureInfoOptions

public WMSGetFeatureInfoOptions()

Method Detail

setHover

public void setHover(boolean hover)

getHover

public boolean getHover()

setMaxFeaturess

public void setMaxFeaturess(int maxFeatures)

getMaxFeatures

public int getMaxFeatures()

setURL

public void setURL(String url)

The URL of the WMS service to use. If not provided, the url of the first eligible layer will be used.

Parameters:

url - The url to which the WmsGetFeatureInfo will be called against

setTitle

public void setTitle(String title)

setQueryVisible

public void setQueryVisible(Boolean qvis)

setLayers

public void setLayers(WMS[] layers)

The layers to query for feature info. If omitted, all map WMS layers with a url that matches this or will be considered.

Parameters:

layers - The layers to query

setLayerUrls

public void setLayerUrls(String[] urls)

Optional list of urls for layers that should be queried. This can be used when the layer url differs from the url used for making GetFeatureInfo requests (in the case of a layer using cached tiles). Notice that this will not cause a WmsGetFeatureInfo request to be sent to all urls, its merely to include layers that don't match this.url. For a a request to be sent to each url the propery drillDown must be set to true.

Parameters:

urls - urls that should be considered

setDrillDown

public void setDrillDown(boolean value)

Drill down over all WMS layers in the map. When using drillDown mode, hover is not possible, and an infoFormat that returns parseable features is required. Default is false.

Parameters:

value - indicates whether drillDown should be enabled or not

setInfoFormat

public void setInfoFormat(String infoFormat)

The mimetype to request from the server defaults to 'text/html'