edu.ucdavis.cstars.client.dijits

Class Legend

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

edu.ucdavis.cstars.client.dijits.Legend

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget

public class Legend
extends com.google.gwt.user.client.ui.Composite

The legend dijit displays a label and symbol for some or all of the layers in the map. If specified, the legend will respect scale dependencies and only display layers and sub layers that are currently visible in the map. The legend automatically updates if the visibility of a layer or sublayer changes. The legend supports the following layer types: ArcGISDynamicMapServiceLayer, ArcGISTiledMapServiceLayer, FeatureLayer. If the layer is an ArcGISDynamicMapServiceLayer or ArcGISTiledMapServiceLayer created using ArcGIS Server 10.0 SP1 or higher the legend is generated using the REST Map Service legend resource. http://mapservice-url/legend If the layers are version 10 or lower the legend is created using the ArcGIS.com legend service. In order to use the ArcGIS.com legend service your map service needs to be publicly accessible and your application must be able to access ArcGIS.com. The legend for feature layers is created using the layer's drawing info, for example: http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Earthquakes/EarthquakesFromLastSevenDays/MapServer/0

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Legend.LayerInfo
static class	Legend.LegendAlignment
static class	Legend.Parameters Parameters used to configure the dijit.

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
Legend(Legend.Parameters params) Creates a new Legend dijit.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	assertLoaded() Check that the esri.dijit.Legend package has been loaded
void	destroy() Destroys the legend.
void	refresh() Refresh the legend.
void	refresh(Legend.LayerInfo layerInfos) Refresh the legend to replace the layers setup by the legend constructor.
void	startup() Finalizes the creation of the legend .

Methods inherited from class com.google.gwt.user.client.ui.Composite

claimElement, initializeClaimedElement, isAttached, onBrowserEvent, render, render

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, fireEvent, getLayoutData, getParent, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Legend

public Legend(Legend.Parameters params)

Creates a new Legend dijit. Should be called after all the layers have been loaded in the map, typically in the map's onLayerAddResult event.

Parameters:

params - - Parameters used to configure the dijit. See the list below for details.

Method Detail

assertLoaded

public static boolean assertLoaded()

Check that the esri.dijit.Legend package has been loaded

Returns:

boolean

destroy

public void destroy()

Destroys the legend. Call destroy() when the widget is no longer needed by the application.

refresh

public final void refresh()

Refresh the legend. Calling refresh is only necessary when layerInfos is used in the Legend constructor, otherwise the legend will refresh the layers automatically.

refresh

public final void refresh(Legend.LayerInfo layerInfos)

Refresh the legend to replace the layers setup by the legend constructor. Calling refresh is only necessary when layerInfos is used in the Legend constructor, otherwise the legend will refresh the layers automatically.

startup

public final void startup()

Finalizes the creation of the legend . Call startup() after creating the widget when you are ready for user interaction.