edu.ucdavis.cstars.client.dijits

Class BasemapGallery

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.BasemapGallery

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 BasemapGallery
extends com.google.gwt.user.client.ui.Composite

The BasemapGallery dijit displays a collection basemaps from ArcGIS.com or a user-defined set of map or image services. When a new basemap is selected from the BasemapGallery the basemap layers are removed from the map and the new layers are added. All basemaps added to the gallery need to have the same spatial reference. If the default ArcGIS.com basemaps are used then all additional items added to the gallery need to be in Web Mercator (wkids: 102100, 102113 and 3857). If the default basemaps are not used you can add basemaps in any spatial reference as long as all the items added to the gallery share that spatial reference. To achieve the best performance, it is recommended that all basemaps added to the gallery are cached (tiled) layers.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasemapGallery.Parameters

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
BasemapGallery(BasemapGallery.Parameters params) Creates a new BasemapGallery dijit.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(Basemap basemap) Add a new basemap to the BasemapGallery's list of basemaps.
void	addAddHandler(BasemapAddHandler handler) Fires when a basemap is added to the BasemapGallery's list of basemaps.
void	addErrorHandler(ErrorHandler handler) Fires when an error occurs while switching basemaps.
void	addLoadHandler(BasemapLoadHandler handler) Fires when the BasemapGallery retrieves the ArcGIS.com basemaps.
void	addRemoveHandler(BasemapRemoveHandler handler) Fires when a basemap is removed from the BasemapGallery's list of basemaps.
void	addSelectionHandler(BasemapSelectionHandler handler) Fires after the map is updated with a new basemap.
static boolean	assertLoaded() Check that the esri.dijit.BasemapGallery has been loaded
void	destroy() Destroys the basemap gallery.
Basemap	get(java.lang.String id) Return the basemap with the specified id.
com.google.gwt.core.client.JsArray<Basemap>	getBasemaps() List of basemaps displayed in the BasemapGallery.
Basemap	getSelected() Gets the currently selected basemap.
boolean	isLoaded() This value is true after the BasemapGallery retrieves the ArcGIS.com basemaps.
Basemap	remove(java.lang.String id) Remove a basemap from the BasemapGallery's list of basemaps.
Basemap	select(java.lang.String id) Select a new basemap for the map.
void	startup() Finalizes the creation of the basemap gallery.

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

BasemapGallery

public BasemapGallery(BasemapGallery.Parameters params)

Creates a new BasemapGallery dijit.

Parameters:

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

Method Detail

assertLoaded

public static boolean assertLoaded()

Check that the esri.dijit.BasemapGallery has been loaded

Returns:

boolean

getBasemaps

public com.google.gwt.core.client.JsArray<Basemap> getBasemaps()

List of basemaps displayed in the BasemapGallery. The list contains basemaps added using the basemaps constructor option and if showArcGISBasemaps is true ArcGIS.com basemaps are also included.

Returns:

JsArray

isLoaded

public boolean isLoaded()

This value is true after the BasemapGallery retrieves the ArcGIS.com basemaps. If showArcGISBasemaps is false the loaded property is set to true immediately.

Returns:

boolean

add

public boolean add(Basemap basemap)

Add a new basemap to the BasemapGallery's list of basemaps. Returns true if the basemap is successfully added and false if the item was not added, e.g. if the id is already in the list of basemaps.

Parameters:

basemap - - The basemap to add to the map.

Returns:

boolean

destroy

public void destroy()

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

get

public final Basemap get(java.lang.String id)

Return the basemap with the specified id. Returns null if a basemap with the specified id is not found.

Parameters:

id - - The basemap id.

Returns:

Basemap

getSelected

public final Basemap getSelected()

Gets the currently selected basemap. Returns null if the map is displaying a basemap that is not from the BasemapGallery.

Returns:

Basemap

remove

public final Basemap remove(java.lang.String id)

Remove a basemap from the BasemapGallery's list of basemaps. Returns null if a basemap with the specified id is not found.

Parameters:

id - - The basemap id.

Returns:

Basemap

select

public final Basemap select(java.lang.String id)

Select a new basemap for the map. The map refreshes to display the new basemap. Returns null if a basemap with the specified id is not found.

Parameters:

id - - The basemap id.

Returns:

Basemap

startup

public final void startup()

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

addAddHandler

public final void addAddHandler(BasemapAddHandler handler)

Fires when a basemap is added to the BasemapGallery's list of basemaps.

Parameters:

handler - - handler to fire when basemap is added

addErrorHandler

public final void addErrorHandler(ErrorHandler handler)

Fires when an error occurs while switching basemaps.

Parameters:

handler - - error handler to fire

addLoadHandler

public final void addLoadHandler(BasemapLoadHandler handler)

Fires when the BasemapGallery retrieves the ArcGIS.com basemaps. If showArcGISBasemaps is set to false this event is not fired.

Parameters:

handler - - handler to be fired

addRemoveHandler

public final void addRemoveHandler(BasemapRemoveHandler handler)

Fires when a basemap is removed from the BasemapGallery's list of basemaps.

Parameters:

handler - - handler to be fired.

addSelectionHandler

public final void addSelectionHandler(BasemapSelectionHandler handler)

Fires after the map is updated with a new basemap.

Parameters:

handler - - handler to be fired.