edu.ucdavis.cstars.client.layers

Class LayerInfo

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.layers.LayerInfo

Direct Known Subclasses:

DynamicLayerInfo

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

Contains information about each layer in a map service. LayerInfo has no constructor.

Author:

Justin Merz

Method Summary

Methods

Modifier and Type	Method and Description
int	getId() Layer ID assigned by ArcGIS Server for a layer.
java.lang.String	getLayerType()
com.google.gwt.core.client.JsArray<LegendInfo>	getLegendInfo() Get the layers LegendInfo if it is attached to this LayerInfo object.
double	getMaxScale() The maximum visible scale for each layer in the map service.
double	getMinScale() The maximum visible scale for each layer in the map service.
java.lang.String	getName() Layer name as defined in the map service.
int	getParentLayerId() If the layer is part of a group layer, it will include the parent ID of the group layer.
com.google.gwt.core.client.JsArrayInteger	getSubLayerIds() If the layer is a parent layer, it will have one or more sublayers included in an array.
boolean	hasDefaultVisibility() Default visibility of the layers in the map service.
boolean	hasLegendInfo() Check to see if this LayerInfo has legend information attached.
void	setDefaultVisibility(boolean defaultVisibility) Set the defaultVisibility parameter.
void	setId(int id) Set the id
void	setMaxScale(double maxScale) Set the maxScale parameter.
void	setMinScale(double minScale) Set the minScale parameter.
void	setName(java.lang.String name) Set the name parameter.
void	setParentLayerId(int parentLayerId) Set the parent layer id.
void	setSubLayerIds(int[] subLayerIds) Set the sublayer ids.

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

hasDefaultVisibility

public final boolean hasDefaultVisibility()

Default visibility of the layers in the map service.

Returns:

boolean

setDefaultVisibility

public final void setDefaultVisibility(boolean defaultVisibility)

Set the defaultVisibility parameter.

Parameters:

defaultVisibility - - Default visibility of the layers in the map service.

getId

public final int getId()

Layer ID assigned by ArcGIS Server for a layer. The topmost layer is 0, and each layer follows sequentially. If a layer is added or removed from the source map document, the ID values will shift accordingly.

Returns:

int

setId

public final void setId(int id)

Set the id

Parameters:

id - - Layer ID assigned by ArcGIS Server for a layer. The topmost layer is 0, and each layer follows sequentially. If a layer is added or removed from the source map document, the ID values will shift accordingly.

getMaxScale

public final double getMaxScale()

The maximum visible scale for each layer in the map service. If the map is zoomed in beyond this scale the layer will not be visible. A value of 0 means that the layer does not have a maximum scale. This property is only available for map services published using ArcGIS Server 10 SP1 or later.

Returns:

float

setMaxScale

public final void setMaxScale(double maxScale)

Set the maxScale parameter.

Parameters:

maxScale - - The maximum visible scale for each layer in the map service. If the map is zoomed in beyond this scale the layer will not be visible. A value of 0 means that the layer does not have a maximum scale. This property is only available for map services published using ArcGIS Server 10 SP1 or later.

getMinScale

public final double getMinScale()

The maximum visible scale for each layer in the map service. If the map is zoomed in beyond this scale the layer will not be visible. A value of 0 means that the layer does not have a maximum scale. This property is only available for map services published using ArcGIS Server 10 SP1 or later.

Returns:

float

setMinScale

public final void setMinScale(double minScale)

Set the minScale parameter.

Parameters:

minScale - - The maximum visible scale for each layer in the map service. If the map is zoomed in beyond this scale the layer will not be visible. A value of 0 means that the layer does not have a maximum scale. This property is only available for map services published using ArcGIS Server 10 SP1 or later.

getName

public final java.lang.String getName()

Layer name as defined in the map service.

Returns:

String

setName

public final void setName(java.lang.String name)

Set the name parameter.

Parameters:

name - - Layer name as defined in the map service.

getParentLayerId

public final int getParentLayerId()

If the layer is part of a group layer, it will include the parent ID of the group layer. Otherwise, the value is -1. If a layer is added or removed from the source map document, the ID values will shift accordingly.

Returns:

int

setParentLayerId

public final void setParentLayerId(int parentLayerId)

Set the parent layer id.

Parameters:

parentLayerId - - If the layer is part of a group layer, it will include the parent ID of the group layer. Otherwise, the value is -1. If a layer is added or removed from the source map document, the ID values will shift accordingly.

getSubLayerIds

public final com.google.gwt.core.client.JsArrayInteger getSubLayerIds()

If the layer is a parent layer, it will have one or more sublayers included in an array. Otherwise, the value is null. If a layer is added or removed from the source map document, the ID values will shift accordingly.

Returns:

JsArrayInteger

setSubLayerIds

public final void setSubLayerIds(int[] subLayerIds)

Set the sublayer ids.

Parameters:

subLayerIds - - If the layer is a parent layer, it will have one or more sublayers included in an array. Otherwise, the value is null. If a layer is added or removed from the source map document, the ID values will shift accordingly.

hasLegendInfo

public final boolean hasLegendInfo()

Check to see if this LayerInfo has legend information attached.

Returns:

boolean

getLegendInfo

public final com.google.gwt.core.client.JsArray<LegendInfo> getLegendInfo()

Get the layers LegendInfo if it is attached to this LayerInfo object.

Returns:

JsArray

getLayerType

public final java.lang.String getLayerType()