edu.ucdavis.cstars.client.dijits

Class OverviewMap

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

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

The OverviewMap widget displays the current extent of the map within the context of a larger area. The OverviewMap updates whenever the map map extent changes. The extent of the main map is represented in the overview map area as a rectangle. The extent rectangle can be dragged to modify the extent of the main map. The OverviewMap can be displayed several ways: - Attach the overview map to a corner of the main map and hide when not in use. - Render the overview map in a div element outside the main map window. - Temporarily maximize the overview map for quick access to far away areas of interest.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OverviewMap.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
OverviewMap(OverviewMap.Parameters params) Creates a new OverviewMap object.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	assertLoaded() Check that the esri.dijit.OverviewMap package has been loaded
void	destroy() Releases the resources used by the dijit.
void	startup() Finalizes the creation of the OverviewMap dijit.

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

OverviewMap

public OverviewMap(OverviewMap.Parameters params)

Creates a new OverviewMap object.

Parameters:

params - - Parameters that define the functionality of the OverviewMap widget.

Method Detail

assertLoaded

public static boolean assertLoaded()

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

Returns:

boolean

destroy

public void destroy()

Releases the resources used by the dijit. Call this method when an instance of this dijit is no longer needed.

startup

public final void startup()

Finalizes the creation of the OverviewMap dijit. Call this method after the constructor for the dijit is called and before users interact with the dijit.