/**
*
* Copyright 2015 sourceforge.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gwtopenmaps.openlayers.client.layer;
import org.gwtopenmaps.openlayers.client.OpenLayersEObjectWrapper;
import org.gwtopenmaps.openlayers.client.Projection;
import org.gwtopenmaps.openlayers.client.event.EventHandler;
import org.gwtopenmaps.openlayers.client.event.EventObject;
import org.gwtopenmaps.openlayers.client.event.EventType;
import org.gwtopenmaps.openlayers.client.event.LayerLoadCancelListener;
import org.gwtopenmaps.openlayers.client.event.LayerLoadCancelListener.LoadCancelEvent;
import org.gwtopenmaps.openlayers.client.event.LayerLoadEndListener;
import org.gwtopenmaps.openlayers.client.event.LayerLoadEndListener.LoadEndEvent;
import org.gwtopenmaps.openlayers.client.event.LayerLoadStartListener;
import org.gwtopenmaps.openlayers.client.event.LayerLoadStartListener.LoadStartEvent;
import org.gwtopenmaps.openlayers.client.event.LayerVisibilityChangedListener;
import org.gwtopenmaps.openlayers.client.event.LayerVisibilityChangedListener.VisibilityChangedEvent;
import org.gwtopenmaps.openlayers.client.util.JSObject;
import com.google.gwt.core.client.JsArrayMixed;
/**
*
* @author Erdem Gunay, Amr Alam - Refractions Research, Edwin Commandeur -
* Atlis EJS
*
* @author Nazzareno Sileno - CNR IMAA geoSDI Group -
* @email nazzareno.sileno@geosdi.org
*
* @author Giuseppe La Scaleia - CNR IMAA geoSDI Group
* @email giuseppe.lascaleia@geosdi.org
*/
public class Layer extends OpenLayersEObjectWrapper {
static {
layerCreatorStore = new OpenLayerCreatorStore();
}
private final static LayerCreatorStore layerCreatorStore;
public static final String ARCGIS93REST_CLASS_NAME = "OpenLayers.Layer.ArcGIS93Rest";
public static final String BOXES_CLASS_NAME = "OpenLayers.Layer.Boxes";
public static final String GOOGLE_CLASS_NAME = "OpenLayers.Layer.Google";
public static final String BING_CLASS_NAME = "OpenLayers.Layer.Bing";
public static final String GRIDLAYER_CLASS_NAME = "OpenLayers.Layer.Grid";
public static final String HTTPREQUESTLAYER_CLASS_NAME = "OpenLayers.Layer.HTTPRequest";
public static final String IMAGE_CLASS_NAME = "OpenLayers.Layer.Image";
public static final String MARKERS_CLASS_NAME = "OpenLayers.Layer.Markers";
public static final String OSM_CLASS_NAME = "OpenLayers.Layer.OSM";
public static final String TMS_CLASS_NAME = "OpenLayers.Layer.TMS";
public static final String VECTOR_CLASS_NAME = "OpenLayers.Layer.Vector";
public static final String WMS_CLASS_NAME = "OpenLayers.Layer.WMS";
public static final String XYZ_CLASS_NAME = "OpenLayers.Layer.XYZ";
public static final String WMTS_CLASS_NAME = "OpenLayers.Layer.TMS";
public static final String LAYER_CLASS_NAME = "OpenLayers.Layer";
public static <L extends Layer> L narrowToLayer(JSObject layer) {
return layerCreatorStore.createLayer(layer);
}
// TODO: add support for moveend event
// TODO: refactor to use getJSObject().getProperty/setProperty
protected Layer(JSObject element) {
super(element);
layerCreatorStore.registerLayerCreator(this);
}
public void setIsBaseLayer(boolean isBaseLayer) {
LayerImpl.setIsBaseLayer(isBaseLayer, getJSObject());
}
/**
* Indicates if Layer is a BaseLayer.
*
* @return true if the layer is a BaseLayer false if the layer is not a
* BaseLayer
*/
public boolean isBaseLayer() {
return LayerImpl.isBaseLayer(getJSObject());
}
public String getId() {
return LayerImpl.getId(getJSObject());
}
public float getOpacity() {
return LayerImpl.getOpacity(getJSObject());
}
public void setOpacity(float opacity) {
LayerImpl.setOpacity(opacity, getJSObject());
}
/**
* Indicates if the Layer should be displayed in the LayerSwitcher Control.
*
* @return true if the layer should be displayed in the LayerSwitcher
* Control, false if the layer should be hidden
*/
public boolean displayInLayerSwitcher() {
return LayerImpl.displayInLayerSwitcher(getJSObject());
}
public void setDisplayInLayerSwitcher(boolean display) {
LayerImpl.setDisplayInLayerSwitcher(display, getJSObject());
}
/**
* @return The name of the Layer, or an empty string if no name was found.
*/
public String getName() {
return LayerImpl.getName(getJSObject());
}
/**
* @param name - the new name for the layer.
*/
public void setName(String name) {
getJSObject().setProperty("name", name);
}
public boolean isVisible() {
return LayerImpl.isVisible(getJSObject());
}
public void setIsVisible(boolean isVisible) {
LayerImpl.setIsVisible(isVisible, getJSObject());
}
public boolean redraw() {
/* super class redraw doesn't have a force. But we'll pass through a value since the JSNI expects one */
return LayerImpl.redraw(getJSObject(), true);
}
public boolean isAlwaysInRange() {
return LayerImpl.isAlwaysInRange(getJSObject());
}
/**
* APIMethod: calculateInRange
*
* Returns: {Boolean} The layer is displayable at the current map's current
* resolution. Note that if 'alwaysInRange' is true for the layer, this
* function will always return true.
*/
public boolean calculateInRange() {
return LayerImpl.calculateInRange(getJSObject());
}
/**
* Property: inRange {Boolean} The current map resolution is within the
* layer's min/max range. This is set in <OpenLayers.Map.setCenter> whenever
* the zoom changes.
*/
public boolean isInRange() {
return LayerImpl.isInRange(getJSObject());
}
/**
* Method: setZIndex
*
* Parameters: zIndex - {Integer}
*/
public void setZIndex(int zIndex) {
LayerImpl.setZIndex(getJSObject(), zIndex);
}
/**
* Method: destroy Destroy is a destructor: this is to alleviate cyclic
* references which the Javascript garbage cleaner can not take care of on
* its own.
*
* Parameters: setNewBaseLayer - {Boolean} Set a new base layer when this
* layer has been destroyed. Default is true.
*/
public void destroy(boolean setNewBaseLayer) {
LayerImpl.destroy(getJSObject(), setNewBaseLayer);
}
/**
* Method: getZIndex
*
* Returns: {Integer} the z-index of this layer
*/
public Object getZIndex() {
return LayerImpl.getZIndex(getJSObject());
}
public void addOptions(LayerOptions layerOptions) {
LayerImpl.addOptions(getJSObject(), layerOptions.getJSObject());
}
public Layer clone() {
return narrowToLayer(LayerImpl.clone(getJSObject()));
}
public void addLayerLoadStartListener(final LayerLoadStartListener listener) {
eventListeners.addListener(this, listener, EventType.LAYER_LOADSTART,
new EventHandler() {
public void onHandle(EventObject eventObject) {
LoadStartEvent e = new LoadStartEvent(eventObject);
listener.onLoadStart(e);
}
});
}
public void addLayerLoadEndListener(final LayerLoadEndListener listener) {
eventListeners.addListener(this, listener, EventType.LAYER_LOADEND,
new EventHandler() {
public void onHandle(EventObject eventObject) {
LoadEndEvent e = new LoadEndEvent(eventObject);
listener.onLoadEnd(e);
}
});
}
public void addLayerLoadCancelListener(
final LayerLoadCancelListener listener) {
eventListeners.addListener(this, listener, EventType.LAYER_LOADCANCEL,
new EventHandler() {
public void onHandle(EventObject eventObject) {
LoadCancelEvent e = new LoadCancelEvent(eventObject);
listener.onLoadCancel(e);
}
});
}
public void addLayerVisibilityChangedListener(
final LayerVisibilityChangedListener listener) {
eventListeners.addListener(this, listener,
EventType.LAYER_VISIBILITYCHANGED, new EventHandler() {
public void onHandle(EventObject eventObject) {
VisibilityChangedEvent e = new VisibilityChangedEvent(
eventObject);
listener.onVisibilityChanged(e);
}
});
}
/**
* Gets the contents of the given {@link JsArrayMixed} as a double array.
*
* @param o {@link JsArrayMixed}
* @return double[] if the array is not null, else null
*/
private static double[] getDoubleArray(JsArrayMixed o) {
if (o != null) {
double[] a = new double[o.length()];
for (int i = 0; i < o.length(); i++) {
a[i] = o.getNumber(i);
}
return a;
} else {
return null;
}
}
/**
* Get the maximum zoomlevel for this layer.
*
* @return maximum zoomlevel
*/
public int getMaxZoomLevel() {
return getMinZoomLevel() + LayerImpl.getResolutions(this.getJSObject()).length() - 1;
}
/**
* Get the minimum zoomlevel for this layer.
*
* @return minimum zoomlevel
*/
public int getMinZoomLevel() {
return (int) this.getJSObject().getPropertyAsDouble("zoomOffset");
}
public double getResolutionForZoom(double zoom) {
double result = -1;
if (this.isBaseLayer()) {
result = LayerImpl.getResolutionForZoom(getJSObject(), zoom);
}
return result;
}
/**
* Get all resolutions for the layer.
* @return resolutions A list of map resolutions (map units per pixel) in descending order. If this is not set in the
* layer constructor, it will be set based on other resolution related properties (maxExtent, maxResolution,
* maxScale, etc.).
*/
public double[] getResolutions() {
return getDoubleArray(LayerImpl.getResolutions(this.getJSObject()));
}
/**
* Sets all resolutions for the layer.
* @param resolutions A list of map resolutions (map units per pixel) in descending order.
*/
public void setResolutions(double[] resolutions)
{
LayerImpl.setResolutions(this.getJSObject(), resolutions);
}
/**
* Get all scales for the layer.
*
* @return scales
*/
public double[] getScales() {
return getDoubleArray(LayerImpl.getScales(this.getJSObject()));
}
public Projection getProjection() {
return Projection.narrowToProjection(LayerImpl.getProjection(
getJSObject()));
}
/**
* <p>
* This method must be present in all Layer subclasses, so we can have the
* real JavaBean Implementation.
* </p>
*
* @param <L>
* @return {@link LayerCreator} layerCreator
*/
protected <L extends Layer> LayerCreator<L> getLayerCreator() {
return new LayerCreator<L>() {
public L createLayer(JSObject jsObject) {
return (L) new Layer(jsObject);
}
};
}
protected interface LayerCreator<L extends Layer> {
L createLayer(JSObject jsObject);
}
}