edu.ucdavis.cstars.client.layers

Class Layer

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.layers.Layer

Direct Known Subclasses:

DynamicMapServiceLayer, GraphicsLayer, KMLLayer, MapImageLayer, TiledMapServiceLayer

public class Layer
extends com.google.gwt.core.client.JavaScriptObject

The base class for all layers that can be added to a map.

Author:

Justin Merz

Method Summary

Methods

Modifier and Type	Method and Description
void	addErrorHandler(ErrorHandler handler) Add error handler to layer.
void	addLoadHandler(LayerLoadHandler handler) Add load handler to layer.
void	addOpacityChangeHandler(OpacityChangeHandler handler) Add opacity change handler to layer
void	addUpdateEndHandler(UpdateEndHandler handler) Add update end handler to layer
void	addUpdateHandler(UpdateHandler handler) Deprecated. at v2.0. Use addUpdateStartHandler and addUpdateEndHandler instead.
void	addUpdateStartHandler(UpdateStartHandler handler) Add update start handler to layer.
void	addVisibilityChangeHandler(VisibilityChangeHandler handler) Add visibility change handler to layer.
Credential	getCredential() Provides credential information for the layer such as userid and token if the layer represents a resource that is secured with token-based authentication.
java.lang.String	getId() ID assigned to the layer.
double	getOpacity() Opacity or transparency of layer.
java.lang.String	getUrl() URL to the ArcGIS Server REST resource that represents a map service.
void	hide() Sets the visibility of the layer to "false".
boolean	isloaded() When the layer is loaded, the value becomes "true", and layer properties can be accessed.
boolean	isVisible() Visibility of the layer.
void	setOpacity(double o) Sets the opacity of the layer.
void	setVisibility(boolean isVisible) Sets the visibility of the layer.
void	show() Sets the visibility of the layer to "true".

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getCredential

public final Credential getCredential()

Provides credential information for the layer such as userid and token if the layer represents a resource that is secured with token-based authentication. This value is available after the layer has been loaded i.e. layer.loaded is true.

Returns:

Credential

getId

public final java.lang.String getId()

ID assigned to the layer. If not assigned, esri.Map assigns value. By default, the ID of the layer is "layer" followed by a number. The ID can be user defined only in the layer constructor.

Returns:

String

isloaded

public final boolean isloaded()

When the layer is loaded, the value becomes "true", and layer properties can be accessed. The onLoad event is also fired.

Returns:

boolean

getOpacity

public final double getOpacity()

Opacity or transparency of layer. Values range from 0.0 to 1.0, where 0.0 is 100% transparent and 1.0 has no transparency.

Returns:

double

getUrl

public final java.lang.String getUrl()

URL to the ArcGIS Server REST resource that represents a map service.

Returns:

String

isVisible

public final boolean isVisible()

Visibility of the layer.

Returns:

boolean

hide

public final void hide()

Sets the visibility of the layer to "false". The layer is not removed, but it is hidden from view.

setOpacity

public final void setOpacity(double o)

Sets the opacity of the layer. Values range from 0.0 to 1.0, where 0.0 is 100% transparent and 1.0 has no transparency.

Parameters:

o - - opacity value

setVisibility

public final void setVisibility(boolean isVisible)

Sets the visibility of the layer. When true, the layer is visible.

Parameters:

isVisible -

show

public final void show()

Sets the visibility of the layer to "true".

addErrorHandler

public final void addErrorHandler(ErrorHandler handler)

Add error handler to layer.

Parameters:

handler - - Fires when there is a problem retrieving a layer

addLoadHandler

public final void addLoadHandler(LayerLoadHandler handler)

Add load handler to layer.

Parameters:

handler - - Fires after layer properties for the layer are successfully populated. This event must be successful before the layer can be added to the map.

addOpacityChangeHandler

public final void addOpacityChangeHandler(OpacityChangeHandler handler)

Add opacity change handler to layer

Parameters:

handler - - Fires when the layer opacity has been changed, and returns the opacity value.

addUpdateHandler

public final void addUpdateHandler(UpdateHandler handler)

Deprecated. at v2.0. Use addUpdateStartHandler and addUpdateEndHandler instead.

Add update handler to layer

Parameters:

handler - - Fires any time a layer has finished loading or updating itself. For an ArcGISTiledMapServiceLayer, the event fires when all required tiles have been retrieved and displayed. For an ArcGISDynamicMapServiceLayer or ArcGISImageServiceLayer, the event fires when the map image has been retrieved and displayed. For a GraphicsLayer, the event fires when all graphics have been redrawn after a pan or zoom.

addUpdateEndHandler

public final void addUpdateEndHandler(UpdateEndHandler handler)

Add update end handler to layer

Parameters:

handler - - Fires when a layer has finished updating its content. It is the responsibility of the (Layer) subclass to determine when this event is fired.

addUpdateStartHandler

public final void addUpdateStartHandler(UpdateStartHandler handler)

Add update start handler to layer.

Parameters:

handler - - Fires when a layer begins to update its content. It is the responsibility of the subclass to determine when this event is fired.

addVisibilityChangeHandler

public final void addVisibilityChangeHandler(VisibilityChangeHandler handler)

Add visibility change handler to layer.

Parameters:

handler - - Fires when the layer visibilty has been changed, and returns the new visibility.