com.esri.android.map
Class GroupLayer

java.lang.Object
  com.esri.android.map.Layer
      com.esri.android.map.GroupLayer

public class GroupLayer
extends Layer

A group layer is a collection of layers extending from the Layer class. it can appear and act as a single layer and has a Layer object's properties such as visibility, extent etc.

If the group layer is the map's first layer, the map will be initialized by the first layer of group layer.

Constructor Summary

GroupLayer()
Creates a GroupLayer

Method Summary

int	addLayer(Layer layer) Adds a layer to the current layer group by appending it to the bottom.
boolean	addLayer(Layer layer, int index) Inserts a layer object at certain position in the group layer.
void	addLayers(Layer[] layers) Adds an array of layers to the current layer group.
int	count() Returns the size of the group layer.
long	getAddGraphicsLayerRequestCallbackHandle() This method is used internally only.
SpatialReference	getDefaultSpatialReference() Gets the defaultSpatialReference of the Layer.
Envelope	getFullExtent() Returns the full extent of the layer.
Layer	getLayer(int index) Returns the layer for the given index position.
Layer	getLayerByID(long layerId) Returns the Layer object matching the given ID.
Layer[]	getLayers() Returns the direct sublayers in an array.
Layer[]	getLayers(String layername) Returns all layers for the given layer name.
boolean	hasLayer(int index) Tests if the group contains the sublayer in the given index.
boolean	hasLayer(String layername) Tests if the group contains the sublayer with given name.
boolean	isInitialized() The initialization of a GroupLayer is depended upon if it is empty (return false ) or its first layer being initialized.
void	recycle() Releases resources referenced by the Layer so that they can be recycled.
void	removeAll() The sublayers are removed and destroyed from the group layers.
void	removeLayer(int index) Removes the layer in the given index.
void	removeLayers(String layerName) Remove all layers by for the given name.
void	setOpacity(float opacity) Sets the opacity of the GroupLayer, it will change all opacity of it sublayers.

Methods inherited from class com.esri.android.map.Layer

getCredentials, getExtent, getHeight, getID, getName, getOpacity, getPopupInfo, getResolution, getSpatialReference, getTitle, getUrl, getUrlHashCode, getWidth, isRecycled, isVisible, isWebMapBaselayer, reinitializeLayer, setName, setOnStatusChangedListener, setPopupInfos, setVisible

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupLayer

public GroupLayer()

Creates a GroupLayer

Method Detail

isInitialized

public boolean isInitialized()

The initialization of a GroupLayer is depended upon if it is empty (return false ) or its first layer being initialized.

Overrides:

isInitialized in class Layer

Returns:

boolean

getLayers

public Layer[] getLayers()

Returns the direct sublayers in an array.

Returns:

an array of Layer objects

getLayers

public Layer[] getLayers(String layername)

Returns all layers for the given layer name.

Parameters:

layername - a layer name string

Returns:

a Layer object

getLayerByID

public Layer getLayerByID(long layerId)

Returns the Layer object matching the given ID.

Parameters:

layerId - a long integer.

Returns:

a Layer object.

getLayer

public Layer getLayer(int index)

Returns the layer for the given index position.

Parameters:

index - an integer for layer position.

Returns:

a Layer object

addLayer

public int addLayer(Layer layer)

Adds a layer to the current layer group by appending it to the bottom.

Parameters:

layer -

Returns:

the index of the new added layer. return -1 if the layer fail to add the group layer.

addLayer

public boolean addLayer(Layer layer,
                        int index)

Inserts a layer object at certain position in the group layer.

Parameters:

layer - a Layer object to be added.

index - an integer of position.

Returns:

true if the layer is inserted successfully.

addLayers

public void addLayers(Layer[] layers)

Adds an array of layers to the current layer group.

Parameters:

layers - an array of layers

removeAll

public void removeAll()

The sublayers are removed and destroyed from the group layers.

hasLayer

public boolean hasLayer(String layername)

Tests if the group contains the sublayer with given name.

Parameters:

layername - a layer name string.

Returns:

true if the layer exists with the given name.

hasLayer

public boolean hasLayer(int index)

Tests if the group contains the sublayer in the given index.

Parameters:

index - a layer index.

Returns:

true if the layer exists in the given index.

removeLayer

public void removeLayer(int index)

Removes the layer in the given index.

Parameters:

index - an integer should be less than current group layer size.

removeLayers

public void removeLayers(String layerName)

Remove all layers by for the given name.

Parameters:

layerName - a layer name.

count

public int count()

Returns the size of the group layer.

Returns:

the size of the group layer.

getFullExtent

public Envelope getFullExtent()

Returns the full extent of the layer. Returns NULL if the group layer is empty.

Overrides:

getFullExtent in class Layer

Returns:

an Envelope object

getDefaultSpatialReference

public SpatialReference getDefaultSpatialReference()

Gets the defaultSpatialReference of the Layer.

Overrides:

getDefaultSpatialReference in class Layer

Returns:

Returns the defaultSpatialReference.

recycle

public void recycle()

Description copied from class: Layer

Releases resources referenced by the Layer so that they can be recycled.

Overrides:

recycle in class Layer

setOpacity

public void setOpacity(float opacity)

Sets the opacity of the GroupLayer, it will change all opacity of it sublayers.

Overrides:

setOpacity in class Layer

Parameters:

opacity - the opacity to set.

getAddGraphicsLayerRequestCallbackHandle

public long getAddGraphicsLayerRequestCallbackHandle()

This method is used internally only. The end user will not use it directly.

Returns:

a long number.