edu.ucdavis.cstars.client.layers

Class KMLLayer

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.layers.Layer

edu.ucdavis.cstars.client.layers.KMLLayer

public class KMLLayer
extends Layer

The KMLLayer class is used to create a layer based on a KML file (.kml,.kmz). KML is an XML-based file format used to represent geographic features. Features from the KML file are accessible via the api so you can query features and use them as input to geometry or geoprocessing services.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KMLLayer.FeatureInfo
static class	KMLLayer.LinkInfo
static class	KMLLayer.Options

Method Summary

Methods

Modifier and Type	Method and Description
void	addRefreshHandler(RefreshHandler handler) Set the refresh event handler.
static boolean	assertLoaded() Check that the esri.layers.KMLLayer has been loaded
static KMLLayer	create(java.lang.String url) Creates a new KMLLayer object.
static KMLLayer	create(java.lang.String url, KMLLayer.Options options) Creates a new KMLLayer object.
com.google.gwt.core.client.JavaScriptObject	getFeature(KMLLayer.FeatureInfo featureInfo) Get the KML feature identified by the input feature info.
KMLFolder	getFeatureAsFolder(KMLLayer.FeatureInfo featureInfo) Get the KML feature identified by the input feature info.
KMLGroundOverlay	getFeatureAsGroundOverlay(KMLLayer.FeatureInfo featureInfo) Get the KML feature identified by the input feature info.
KMLLayer	getFeatureAsNetworkLink(KMLLayer.FeatureInfo featureInfo) Get the KML feature identified by the input feature info.
Graphic	getFeatureAsPlacemark(KMLLayer.FeatureInfo featureInfo) Get the KML feature identified by the input feature info.
com.google.gwt.core.client.JsArray<KMLLayer.FeatureInfo>	getFeatureInfos() An array of objects that describe top-level KML features ids and their types.
com.google.gwt.core.client.JsArray<KMLFolder>	getFolders() An array of KMLFolder objects that describe the folders and nested folders defined in the KML file.
com.google.gwt.core.client.JsArray<Layer>	getLayers() Get an array of map layers that were created to draw placemarks, ground and screen overlays.
KMLLayer.LinkInfo	getLinkInfo() A link info object with properties that describe the network link.
java.lang.String	getName() The name of the layer if specified in the KML file.
int	getVisibility() The initial visibility of the layer.
void	setFolderVisibility(KMLFolder folder, boolean isVisible) Set the visibility for the specified folder.

Methods inherited from class edu.ucdavis.cstars.client.layers.Layer

addErrorHandler, addLoadHandler, addOpacityChangeHandler, addUpdateEndHandler, addUpdateHandler, addUpdateStartHandler, addVisibilityChangeHandler, getCredential, getId, getOpacity, getUrl, hide, isloaded, isVisible, setOpacity, setVisibility, show

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

create

public static KMLLayer create(java.lang.String url)

Creates a new KMLLayer object.

Parameters:

url - - The url for a .kml or .kmz file.

Returns:

KMLLayer

create

public static KMLLayer create(java.lang.String url,
              KMLLayer.Options options)

Creates a new KMLLayer object.

Parameters:

url - - The url for a .kml or .kmz file.

options - - Optional parameters.

Returns:

KMLLayer

assertLoaded

public static boolean assertLoaded()

Check that the esri.layers.KMLLayer has been loaded

Returns:

boolean

getFeatureInfos

public final com.google.gwt.core.client.JsArray<KMLLayer.FeatureInfo> getFeatureInfos()

An array of objects that describe top-level KML features ids and their types.

Returns:

JsArray

getFolders

public final com.google.gwt.core.client.JsArray<KMLFolder> getFolders()

An array of KMLFolder objects that describe the folders and nested folders defined in the KML file. Use the parentFolderId and subFolderIds to identify the hierarchical relationship between folders.

Returns:

JsArray

getLinkInfo

public final KMLLayer.LinkInfo getLinkInfo()

A link info object with properties that describe the network link.

Returns:

LinkInfo

getName

public final java.lang.String getName()

The name of the layer if specified in the KML file.

Returns:

String

getVisibility

public final int getVisibility()

The initial visibility of the layer. If the visibility is 0 the layer is not visible.

Returns:

int

getFeature

public final com.google.gwt.core.client.JavaScriptObject getFeature(KMLLayer.FeatureInfo featureInfo)

Get the KML feature identified by the input feature info. The table below lists the type of objects returned for the KML feature types. KML Class name of returned object Placemark Graphic GroundOverlay KMLGroundOverlay ScreenOverlay KMLScreenOverlay NetworkLink KMLLayer Folder KMLFolder

Parameters:

featureInfo - - Feature info for the kml feature.

Returns:

JavaScriptObject

getFeatureAsPlacemark

public final Graphic getFeatureAsPlacemark(KMLLayer.FeatureInfo featureInfo)

Get the KML feature identified by the input feature info.

Parameters:

featureInfo - - Feature info for the kml feature.

Returns:

Graphic

getFeatureAsGroundOverlay

public final KMLGroundOverlay getFeatureAsGroundOverlay(KMLLayer.FeatureInfo featureInfo)

Get the KML feature identified by the input feature info.

Parameters:

featureInfo - - Feature info for the kml feature.

Returns:

KMLGroundOverlay

getFeatureAsNetworkLink

public final KMLLayer getFeatureAsNetworkLink(KMLLayer.FeatureInfo featureInfo)

Get the KML feature identified by the input feature info.

Parameters:

featureInfo - - Feature info for the kml feature.

Returns:

KMLLayer

getFeatureAsFolder

public final KMLFolder getFeatureAsFolder(KMLLayer.FeatureInfo featureInfo)

Get the KML feature identified by the input feature info.

Parameters:

featureInfo - - Feature info for the kml feature.

Returns:

KMLFolder

getLayers

public final com.google.gwt.core.client.JsArray<Layer> getLayers()

Get an array of map layers that were created to draw placemarks, ground and screen overlays. The returned array can have instances of the following layer types: FeatureLayer or MapImageLayer. This method can be used to override the renderer for feature layers.

Returns:

JsArray

setFolderVisibility

public final void setFolderVisibility(KMLFolder folder,
                       boolean isVisible)

Set the visibility for the specified folder.

Parameters:

folder - - A KML folder.

isVisible - - The visibility of the folder and all kml features within the folder.

addRefreshHandler

public final void addRefreshHandler(RefreshHandler handler)

Set the refresh event handler.

Parameters:

handler - - Fired after the layer is refreshed. If the layer represents a network link it is automatically refreshed based on the network link parameters defined in the linkInfo property. Layers can be explicitly refreshed by calling the refresh method.