public class

KMLLayer

extends GroupLayer

java.lang.Object
↳	com.esri.android.map.Layer
	↳	com.esri.android.map.GroupLayer
		↳	com.esri.android.map.ogc.KMLLayer

Class Overview

The KMLLayer class represents a layer based on a KML file (.kml,.kmz). KML is an XML tag based syntax that holds geographic information (geometric shapes, symbology, and attributes) in a file with the .kml extension. To add a KML file(.kml or .kmz) to a map, the KML must be available via a publicly accessible URL. Locally hosted or KML files inside a firewall are not supported. KML Layer is a group layer which is made up of several layers in order to support wide range of feature types that can be stored in a KML file. Geometries from a KML file are stored as feature layers: one each for points, lines and polygons. The feature layer can be accessed by iterating the children of the GroupLayer.

Summary

[Expand]

Inherited Fields

From class com.esri.android.map.Layer

Public Constructors
	KMLLayer(String url) The constructor is used if you are instantiating a KMLLayer using a publicly accessible URL.
	KMLLayer(String url, SpatialReference outSR) The constructor is used if you are instantiating a KMLLayer using a URL and output spatial reference.
	KMLLayer(String url, SpatialReference outSR, boolean initLayer) The constructor is used if you are instantiating a KMLLayer using a URL, output spatial reference and initLayer indicator.

Public Methods
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	refresh() Refreshes the KML layer by downloading and parsing the KML document.
void	setVisible(boolean visible) Sets the visibility of the Layer.

Protected Methods
void	initLayer() Initializes the layer.
void	updateSpatialReferenceStatus(int SRStatus) The callback method is invoked when the layer is added to map.

[Expand]

Inherited Methods

From class com.esri.android.map.GroupLayer

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	create()
void	finalize()
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.
void	graphicsLayerAddRequest(String layerName, int index) Callback when a GraphicLayer is added to the GroupLayer in the MessageProcessor.
boolean	hasLayer(String layername) Tests if the group contains the sublayer with given name.
boolean	hasLayer(int index) Tests if the group contains the sublayer in the given index.
void	initLayer() Initializes the layer.
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	setDefaultSpatialReference(SpatialReference defaultSpatialReference) Sets the defaultSpatialReference of the Layer.
void	setOpacity(float opacity) Sets the opacity of the GroupLayer, it will change all opacity of it sublayers.

From class com.esri.android.map.Layer

void	changeStatus(OnStatusChangedListener.STATUS status) Changes the STATUS of the layer and notifies the listener.
abstract long	create()
Popup	createPopup(MapView mapView, int sublayerId, Graphic graphic) Creates the popup.
void	finalize()
UserCredentials	getCredentials() Gets a copy of the credentials attached to the Layer.
SpatialReference	getDefaultSpatialReference() Gets the defaultSpatialReference of the Layer.
float	getDpi()
Polygon	getExtent() Gets the current extent.
Envelope	getFullExtent() Returns the full extent of the layer.
int	getHeight() Gets the height of the Layer in screen units.
long	getID() Return the Layer runtime ID which is a long integer.
Envelope	getInitialExtent() Returns the initial extent of the layer.
double	getMaxScale() Gets max scale.
double	getMinScale() Gets min scale.
String	getName() Gets the name of the layer.
float	getOpacity() Gets the opacity of the Layer.
Layer	getParent() Returns parent layer if the layer is in a group layer otherwise returning null.
ExecutorService	getPoolExecutor() Returns the ThreadPoolExecutor based on the context.
ArcGISPopupInfo	getPopupInfo(int sublayerId) Gets the `PopupInfo` associated with the sub-layer id.
Map<Integer, ArcGISPopupInfo>	getPopupInfos() Gets the popup infos.
String	getQueryUrl(int subLayerId) Gets the query url.
double	getResolution() Gets the resolution of the Layer.
ExecutorService	getServiceExecutor() Returns the ThreadPoolExecutor based on the context.
SpatialReference	getSpatialReference() Gets the current spatial reference of the Layer.
String	getTitle() Gets the title of the Layer.
String	getUrl() Gets the URL of the map service associated with the layer.
int	getUrlHashCode() A convenience method that returns the hash code of the map service URL.
String	getWebMapLayerID() Gets the web map layer id.
int	getWidth() Gets the width of the Layer in screen units.
abstract void	initLayer() Initializes the layer.
void	initializeMinMaxScale(double initalMinScale, double initalMaxScale) honor the webmaplayer min/max scale first, if it is not override, then using service min/max if they are set.
boolean	isInitialized() Gets the initialized of the Layer.
boolean	isRecycled() Returns true or false if the Layer object has been recycled.
boolean	isShowLegend() Returns true if legend of the layer will be shown up; by default it is true; The property is usually defined in the web map, a operation layer legend could be on or off.
boolean	isVisible() Gets the visibility of the Layer.
boolean	isWebMapBaselayer() Returns true if the layer is used as base layer in a web map.
<T> T	loadServiceInfo(Callable<T> task) If the Layer is loaded as a WebMapLayer and the OnWebMapLoadListener is specified, the service information will be loaded interactively.
synchronized long	lock()
void	recycle() Releases resources referenced by the Layer so that they can be recycled.
void	reinitializeLayer(UserCredentials usercredentials) Re-initializes the layer with the given credentials.
void	setCredentials(UserCredentials credentials) Sets the credentials of the Layer.
void	setDefaultSpatialReference(SpatialReference defaultSpatialReference) Sets the defaultSpatialReference of the Layer.
void	setFullExtent(Envelope extent)
void	setInitialExtent(Envelope e) Sets the initial extent of layer.
void	setMaxScale(double maxScale) Sets max scale.
void	setMinScale(double minScale) Sets min scale.
void	setName(String name) Sets the layer name.
void	setOnStatusChangedListener(OnStatusChangedListener onStatusChangedListener) Sets the onStatusChangedListener.
void	setOpacity(float opacity) Sets the opacity of the Layer.
void	setPopupInfos(Map<Integer, ArcGISPopupInfo> popUpInfos) Sets the popup infos.
void	setQueryUrls(Map<Integer, String> queryUrls) Sets the query urls.
void	setUrl(String url) Sets the URL of the map service associated with the layer.
void	setVisible(boolean visible) Sets the visibility of the Layer.
void	unlock(long handle)
void	updateSpatialReferenceStatus(int SRStatus) The callback method is invoked when the layer is added to map.
boolean	verifyCredentials() Returns true if the credentials is valid.

From class java.lang.Object

Public Constructors

public KMLLayer (String url)

The constructor is used if you are instantiating a KMLLayer using a publicly accessible URL. The default output spatial reference is WGS84.

Parameters

url	string URL to the KML file.

public KMLLayer (String url, SpatialReference outSR)

The constructor is used if you are instantiating a KMLLayer using a URL and output spatial reference.

Parameters

url	string URL to the KML file.
outSR	output spatial reference.

public KMLLayer (String url, SpatialReference outSR, boolean initLayer)

The constructor is used if you are instantiating a KMLLayer using a URL, output spatial reference and initLayer indicator.

Parameters

url	string URL to the KML file.
outSR	output spatial reference.
initLayer	true to initialize the layer.

Public Methods

public boolean isInitialized ()

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

Returns

boolean

public void recycle ()

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

public void refresh ()

Refreshes the KML layer by downloading and parsing the KML document.

public void setVisible (boolean visible)

Sets the visibility of the Layer.

Parameters

visible	The visibility to set.

Protected Methods

protected void initLayer ()

Initializes the layer. The implementation should submit the OnStatusChangedListener.STATUS event accordingly.

protected void updateSpatialReferenceStatus (int SRStatus)

The callback method is invoked when the layer is added to map. 0 - Spatial Reference Invalid 1 - Spatial Reference NotNeeded 2 - Spatial Reference Projected 3 - Spatial Reference Good

Parameters

SRStatus	an integer indicating the spatial reference status of layer

Classes

KMLLayer

Class Overview

Summary

Public Constructors

public KMLLayer (String url)

Parameters

public KMLLayer (String url, SpatialReference outSR)

Parameters

public KMLLayer (String url, SpatialReference outSR, boolean initLayer)

Parameters

Public Methods

public boolean isInitialized ()

Returns

public void recycle ()

public void refresh ()

public void setVisible (boolean visible)

Parameters

Protected Methods

protected void initLayer ()

protected void updateSpatialReferenceStatus (int SRStatus)

Parameters