MapWidget

java.lang.Object
- edu.ucdavis.cstars.client.MapWidget

```
public class MapWidget
extends java.lang.Object
```
Basic Map class with all the navigation functionalities. The Map.onLoad event is fired after the first layer has been added to the map. At this point, the map is fully functional. A Map.onLoad handler function should be used to add content and change map behaviors.

Author:

Justin Merz

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MapWidget.BaseMap

static class MapWidget.Options

Nested Classes
Modifier and Type	Class and Description
`static class`	`MapWidget.BaseMap`
`static class`	`MapWidget.Options`

Constructor Summary

Constructors
Constructor and Description
`MapWidget(com.google.gwt.user.client.ui.SimplePanel mapPanel, MapLoadHandler onLoad)` Creates a new map.
`MapWidget(com.google.gwt.user.client.ui.SimplePanel mapPanel, MapLoadHandler onLoad, MapWidget.Options options)` Creates a new Map.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addClickHandler(ClickHandler handler)` Add handler for when map is clicked.
`void`	`addControl(Control control)` Add new control to the Control Layer.
`void`	`addDblClickHandler(DblClickHandler handler)` Add handler for when maps is double clicked
`void`	`addExtentChangeHandler(MapExtentChangeHandler handler)` Add Handler to listen to maps onResize Event Fires when the extent of the map has changed.
`void`	`addInfoWindow(com.google.gwt.user.client.ui.Widget panel)`
`void`	`addKeyDownHandler(MapKeyDownHandler handler)`
`void`	`addKeyUpHandler(MapKeyUpHandler handler)`
`Layer`	`addLayer(Layer layer)` Adds an ESRI Layer to the map.
`Layer`	`addLayer(Layer layer, int index)` Adds an ESRI Layer to the map.
`void`	`addLayerAddHandler(MapLayerAddHandler handler)`
`void`	`addLayerAddResultHandler(MapLayerAddResultHandler handler)`
`void`	`addLayerRemoveHandler(MapLayerRemoveHandler handler)`
`void`	`addLayerReorderHandler(MapLayerReorderHandler handler)`
`void`	`addLayers(Layer[] layers)` Adds multiple layers to a map.
`void`	`addLayersAddResultHandler(MapLayersAddResultHandler handler)`
`void`	`addLayersRemovedHandler(MapLayersRemovedHandler handler)`
`void`	`addLayersReorderedHandler(MapLayersReorderedHandler handler)` Fires when all the layers have been reordered.
`void`	`addLoadHandler(MapLoadHandler handler)` Add Handler to listen to maps onLoad Event
`void`	`addMouseDownHandler(MouseDownHandler handler)`
`void`	`addMouseDragEndHandler(MapMouseDragEndHandler handler)`
`void`	`addMouseDragHandler(MapMouseDragHandler handler)`
`void`	`addMouseDragStartHandler(MapMouseDragStartHandler handler)`
`void`	`addMouseMoveHandler(MouseMoveHandler handler)`
`void`	`addMouseOutHandler(MouseOutHandler handler)`
`void`	`addMouseOverHandler(MouseOverHandler handler)`
`void`	`addMouseUpHandler(MouseUpHandler handler)`
`void`	`addMouseWheelHandler(MouseWheelHandler handler)`
`void`	`addPanEndHandler(MapPanEndHandler handler)`
`void`	`addPanHandler(MapPanHandler handler)` Add Handler to listen to maps onPan Event
`void`	`addPanStartHandler(MapPanStartHandler handler)`
`void`	`addRepositionHandler(MapRepositionHandler handler)`
`void`	`addResizeHandler(MapResizeHandler handler)` Add Handler to listen to maps onResize Event
`void`	`addTimeExtentChange(TimeExtentChangeHandler handler)`
`void`	`addUnloadHandler(MapUnloadHandler handler)` Add Handler to listen to maps onUnload Event
`void`	`addUpdateEndHandler(UpdateEndHandler handler)`
`void`	`addUpdateStartHandler(UpdateStartHandler handler)`
`void`	`addZoomEndHandler(MapZoomEndHandler handler)`
`void`	`addZoomHandler(MapZoomHandler handler)`
`void`	`addZoomStartHandler(MapZoomStartHandler handler)`
`static boolean`	`assertLoaded()` Make sure the $wnd.esri library has been loaded.
`void`	`centerAndZoom(Point center, double levelOrFactor)` Centers and zooms the map.
`void`	`centerAt(Point center)` Recenters the map based on map coordinates as the center point.
`void`	`destroy()` Destroys the map instance.
`void`	`disableClickRecenter()` Disallows clicking on a map to recenter it.
`void`	`disableDoubleClickZoom()` Disallows double clicking on a map to zoom in a level and recenter the map.
`void`	`disableKeyboardNavigation()` Disallows panning and zooming using the keyboard.
`void`	`disableMapNavigation()` Disallows all map navigation except the slider and pan arrows.
`void`	`disablePan()` Disallows panning a map using the mouse.
`void`	`disableRubberBandZoom()` Disallows zooming in or out on a map using a bounding box.
`void`	`disableScrollWheelZoom()` Disallows zooming in or out on a map using the mouse scroll wheel.
`void`	`disableShiftDoubleClickZoom()` Disallows shift double clicking on a map to zoom in a level and recenter the map.
`void`	`disableSnapping()` Disables snapping on the map.
`void`	`enableClickRecenter()` Permits users to click on a map to recenter it.
`void`	`enableDoubleClickZoom()` Permits users to double click on a map to zoom in a level and recenter the map
`void`	`enableKeyboardNavigation()` Permits users to pan and zoom using the keyboard.
`void`	`enableMapNavigation()` Allows all map navigation.
`void`	`enablePan()` Permits users to pan a map using the mouse.
`void`	`enableRubberBandZoom()` Permits users to zoom in or out on a map using a bounding box.
`void`	`enableScrollWheelZoom()` Permits users to zoom in or out on a map using the mouse scroll wheel.
`void`	`enableShiftDoubleClickZoom()` Permits users to shift double click on a map to zoom in a level and recenter the map.
`SnappingManager`	`enableSnapping()` Enable snapping on the map when working with the Editor, Measurement widget or the Draw and Edit toolbars.
`SnappingManager`	`enableSnapping(SnappingManager.SnappingOptions options)` Enable snapping on the map when working with the Editor, Measurement widget or the Draw and Edit toolbars.
`Extent`	`getExtent()` The current extent of the map in map units.
`GraphicsLayer`	`getGraphics()` Add and remove graphics from the GraphicsLayer.
`com.google.gwt.core.client.JsArrayString`	`getGraphicsLayerIds()` An array of the current GraphicsLayers in the map.
`int`	`getHeight()` Current height of the map in screen pixels.
`java.lang.String`	`getId()` Reference to HTML DIV or other element where the map is placed on the page.
`InfoWindow`	`getInfoWindow()` Displays the InfoWindow on a map.
`java.lang.String`	`getInfoWindowAnchor(Point screenCoords)` Sets an InfoWindow's anchor when calling InfoWindow.show
`Layer`	`getLayer(java.lang.String id)` Returns an individual layer of a map.
`com.google.gwt.core.client.JsArrayString`	`getLayerIds()` Array of current TiledMapServiceLayers and DynamicMapServiceLayers added to the map.
`float`	`getLevel()` Gets the current level of detail ID for the map.
`com.google.gwt.core.client.JavaScriptObject`	`getMapObject()` Return the actual ersi.map object that has been created
`com.google.gwt.user.client.ui.SimplePanel`	`getMapPanel()`
`java.lang.String`	`getNavigationMode()` Indicates whether the map uses CSS3 transformations when panning and zooming.
`Point`	`getPosition()` This point geometry in screen coordinates represent the top-left corner of the map container.
`com.google.gwt.dom.client.Element`	`getRoot()` The DOM node that contains the container of layers, build-in info window, logo and slider.
`SnappingManager`	`getSnappingManager()` If snapping is enabled on the map using map.enableSnapping() this property provides access to the SnappingManager.
`SpatialReference`	`getSpatialReference()` The spatial reference of the map.
`TimeExtent`	`getTimeExtent()` The current TimeExtent for the map.
`int`	`getWidth()` Current width of the map in screen pixels.
`void`	`hidePanArrows()` Hides the pan arrows from the map.
`void`	`hideZoomSlider()` Hides the zoom slider from the map.
`boolean`	`isClickRecenter()` When true, the key sequence of shift then click to recenter the map is enabled.
`boolean`	`isDoubleClickZoom()` When true, double click zoom is enabled.
`boolean`	`isFadeOnZoom()` Indicates if the fade effect is enabled while zooming.
`boolean`	`isForce3DTransforms()` When the mapNavigation mode is set to 'css-transforms', CSS3 transforms will be used for map navigation when supported by the browser.
`boolean`	`isKeyboardNavigation()` When true, double click zoom is enabled.
`boolean`	`isLoaded()` After the first layer is loaded, the value is set to true.
`boolean`	`isPan()` When true, map panning is enabled using the mouse.
`boolean`	`isPanArrows()` When true, pan arrows are displayed around the edge of the map.
`boolean`	`isRubberBandZoom()` When true, rubberband zoom is enabled.
`boolean`	`isScrollWheelZoom()` When true, the mouse scroll wheel zoom is enabled.
`boolean`	`isShiftDoubleClickZoom()` When true, shift double click zoom is enabled.
`boolean`	`isZoomSlider()` When true, the zoom slider is displayed on the map.
`void`	`panDown()` Pans the map south.
`void`	`panLeft()` Pans the map west.
`void`	`panLowerLeft()` Pans the map southwest.
`void`	`panLowerRight()` Pans the map southeast.
`void`	`panRight()` Pans the map east.
`void`	`panUp()` Pans the map north.
`void`	`panUpperLeft()` Pans the map northwest.
`void`	`panUpperRight()` Pans the map northeast.
`void`	`removeAllLayers()` Removes all layers from the map.
`void`	`removeControl(Control control)` Remove control from the Control Layer.
`void`	`removeLayer(Layer layer)` Removes the specified layer from the map.
`void`	`reorderLayer(Layer layer, int index)` Changes the layer order in the map.
`void`	`reposition()` Repositions the map DIV on the page.
`void`	`resize()` Resizes the map DIV.
`void`	`setExtent(Extent extent)` Sets the extent of the map.
`void`	`setExtent(Extent extent, boolean fit)` Sets the extent of the map.
`void`	`setHeight(java.lang.String height)` Updates the MapWidget's height.
`void`	`setLevel(int level)` Sets the map to the specified level ID.
`void`	`setMapCursor(java.lang.String cursor)` Sets the default cursor for the map.
`void`	`setSize(java.lang.String width, java.lang.String height)` Updates the MapWidget's size.
`void`	`setTimeExtent(TimeExtent timeExtent)` Sets the TimeExtent for the map.
`void`	`setTimeSlider(TimeSlider timeSlider)` Set the time slider associated with the map.
`void`	`setWidth(java.lang.String width)` Updates the MapWidget's width.
`void`	`showPanArrows()` Shows the pan arrows on the map.
`void`	`showZoomSlider()` Shows the zoom slider on the map.
`Point`	`toMap(Point screenPoint)` Converts a single screen point or an array of screen points to map coordinates.
`Point`	`toScreen(Point mapPoint)` Converts a single map point or an array of map points to screen coordinates.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MapWidget
```
public MapWidget(com.google.gwt.user.client.ui.SimplePanel mapPanel,
         MapLoadHandler onLoad)
```
    Creates a new map.
    
    Parameters:
    initializationLayer - - Layer map will be initialized to. After the map is added to the dom, this will be the first layer added to the map. Once the map is initialized the onLoad handler will be called. Can be null.
    onLoad - - This is the map load handler to be fired once the map as been added to the dom and the first layer has been initialized. Can be null.
  - MapWidget
```
public MapWidget(com.google.gwt.user.client.ui.SimplePanel mapPanel,
         MapLoadHandler onLoad,
         MapWidget.Options options)
```
    Creates a new Map.
    
    Parameters:
    initializationLayer - - Layer map will be initialized to. After the map is added to the dom, this will be the first layer added to the map. Once the map is initialized the onLoad handler will be called.
    onLoad - - This is the map load handler to be fired once the map as been added to the dom and the first layer has been initialized. Can be null.
    options - - Optional parameters for the map.
- Method Detail
  - addControl
```
public void addControl(Control control)
```
    Add new control to the Control Layer. The control layer is not apart of the ESRI library, rather an added component in the GWT library.
    
    Parameters:
    control - - Control to be added to the map
  - removeControl
```
public void removeControl(Control control)
```
    Remove control from the Control Layer. The control layer is not apart of the ESRI library, rather an added component in the GWT library.
    
    Parameters:
    control - - Control to be removed
  - assertLoaded
```
public static final boolean assertLoaded()
```
    Make sure the $wnd.esri library has been loaded. Alert error message and return false if it has not been loaded. Othewise return true.
    
    Returns:
    boolean
  - getMapObject
```
public com.google.gwt.core.client.JavaScriptObject getMapObject()
```
    Return the actual ersi.map object that has been created
    
    Returns:
    JavaScriptObject
  - getMapPanel
```
public com.google.gwt.user.client.ui.SimplePanel getMapPanel()
```
  - setSize
```
public void setSize(java.lang.String width,
           java.lang.String height)
```
    Updates the MapWidget's size. If the map has been loaded, resize() will be called automatically. If the map hasn't loaded (attached to the DOM with at least one layer loaded) you need to call resize() once the map is loaded or bad things will happen. You can add an event listener to onMapLoad to know when the map is loaded.
    
    Parameters:
    width - - width MapWidget should be set to
    height - - height MapWidget should be set to
  - setWidth
```
public void setWidth(java.lang.String width)
```
    Updates the MapWidget's width. If the map has been loaded, resize() will be called automatically. If the map hasn't loaded (attached to the DOM with at least one layer loaded) you need to call resize() once the map is loaded or bad things will happen. You can add an event listener to onMapLoad to know when the map is loaded.
    
    Parameters:
    width - - width MapWidget should be set to
  - setHeight
```
public void setHeight(java.lang.String height)
```
    Updates the MapWidget's height. If the map has been loaded, resize() will be called automatically. If the map hasn't loaded (attached to the DOM with at least one layer loaded) you need to call resize() once the map is loaded or bad things will happen. You can add an event listener to onMapLoad to know when the map is loaded.
    
    Parameters:
    height - - height MapWidget should be set to
  - addInfoWindow
```
public void addInfoWindow(com.google.gwt.user.client.ui.Widget panel)
```
  - getExtent
```
public Extent getExtent()
```
    The current extent of the map in map units.
    
    Returns:
    boolean
  - isFadeOnZoom
```
public boolean isFadeOnZoom()
```
    Indicates if the fade effect is enabled while zooming. Only applicable when navigationMode is set to 'css-transforms'.
    
    Returns:
    boolean
  - isForce3DTransforms
```
public boolean isForce3DTransforms()
```
    When the mapNavigation mode is set to 'css-transforms', CSS3 transforms will be used for map navigation when supported by the browser. It is recommended that you let the map determine when to enable transformations to avoid running into a known issue with scrollbar rendering on Chrome on Windows XP.
    
    Returns:
    boolean
  - getGraphics
```
public GraphicsLayer getGraphics()
```
    Add and remove graphics from the GraphicsLayer.
    
    Returns:
    GraphicsLayer
  - getGraphicsLayerIds
```
public com.google.gwt.core.client.JsArrayString getGraphicsLayerIds()
```
    An array of the current GraphicsLayers in the map.
    
    Returns:
    JsArrayString
  - getHeight
```
public int getHeight()
```
    Current height of the map in screen pixels.
    
    Returns:
    int
  - getId
```
public java.lang.String getId()
```
    Reference to HTML DIV or other element where the map is placed on the page. This property is set in the Map constructor.
    
    Returns:
    String
  - getInfoWindow
```
public InfoWindow getInfoWindow()
```
    Displays the InfoWindow on a map.
    
    Returns:
    InfoWindow
  - isClickRecenter
```
public boolean isClickRecenter()
```
    When true, the key sequence of shift then click to recenter the map is enabled.
    
    Returns:
    boolean
  - isDoubleClickZoom
```
public boolean isDoubleClickZoom()
```
    When true, double click zoom is enabled. This allows a user to zoom and recenter the map by double clicking the mouse.
    
    Returns:
    boolean
  - isKeyboardNavigation
```
public boolean isKeyboardNavigation()
```
    When true, double click zoom is enabled. This allows a user to zoom and recenter the map by double clicking the mouse.
    
    Returns:
    boolean
  - isPan
```
public boolean isPan()
```
    When true, map panning is enabled using the mouse.
    
    Returns:
    boolean
  - isPanArrows
```
public boolean isPanArrows()
```
    When true, pan arrows are displayed around the edge of the map.
    
    Returns:
    boolean
  - isRubberBandZoom
```
public boolean isRubberBandZoom()
```
    When true, rubberband zoom is enabled. This allows users to draw a bounding box zoom area using the mouse.
    
    Returns:
    boolean
  - isScrollWheelZoom
```
public boolean isScrollWheelZoom()
```
    When true, the mouse scroll wheel zoom is enabled.
    
    Returns:
    boolean
  - isShiftDoubleClickZoom
```
public boolean isShiftDoubleClickZoom()
```
    When true, shift double click zoom is enabled. This allows a user to zoom and recenter the map by shift + double clicking the mouse.
    
    Returns:
    boolean
  - isZoomSlider
```
public boolean isZoomSlider()
```
    When true, the zoom slider is displayed on the map.
    
    Returns:
    boolean
  - getLayerIds
```
public com.google.gwt.core.client.JsArrayString getLayerIds()
```
    Array of current TiledMapServiceLayers and DynamicMapServiceLayers added to the map.
    
    Returns:
    JsArrayString
  - isLoaded
```
public boolean isLoaded()
```
    After the first layer is loaded, the value is set to true.
    
    Returns:
    boolean
  - getNavigationMode
```
public java.lang.String getNavigationMode()
```
    Indicates whether the map uses CSS3 transformations when panning and zooming. In 'css-transform' mode the map will use CSS3 transformations, if supported by the browser, to provide a smoother experience while panning and zooming the map.
    
    Returns:
    String
  - getPosition
```
public Point getPosition()
```
    This point geometry in screen coordinates represent the top-left corner of the map container. This coordinate also acts as the origin for all screen coordinates returned by Map and GraphicsLayer events.
    
    Returns:
    Point
  - getRoot
```
public com.google.gwt.dom.client.Element getRoot()
```
    The DOM node that contains the container of layers, build-in info window, logo and slider. (As of v2.2)
    
    Returns:
    Element
  - getSnappingManager
```
public SnappingManager getSnappingManager()
```
    If snapping is enabled on the map using map.enableSnapping() this property provides access to the SnappingManager. The snapping manager's setLayerInfo method can be used to modify the target snapping layers.
    
    Returns:
    SnappingManager
  - getSpatialReference
```
public SpatialReference getSpatialReference()
```
    The spatial reference of the map.
    
    Returns:
    SpatialReference
  - getTimeExtent
```
public TimeExtent getTimeExtent()
```
    The current TimeExtent for the map. Use the setTimeExtent method to modify the time extent.
    
    Returns:
    TimeExtent
  - getWidth
```
public int getWidth()
```
    Current width of the map in screen pixels.
    
    Returns:
    int
  - addLayer
```
public Layer addLayer(Layer layer,
             int index)
```
    Adds an ESRI Layer to the map.
    
    Parameters:
    layer - - Layer to be added to the map.
    index - - A layer can be added at a specific index in the map.
  - addLayer
```
public Layer addLayer(Layer layer)
```
    Adds an ESRI Layer to the map.
    
    Parameters:
    layer - - Layer to be added to the map.
  - addLayers
```
public void addLayers(Layer[] layers)
```
    Adds multiple layers to a map. The array order corresponds to the layer order in the client side map. The onLayerAddResult event fires for each layer that is added. Once all the layers are added to the map the onLayersAddResult fires.
    
    Parameters:
    layers - - Layers to be added to the map.
  - centerAndZoom
```
public void centerAndZoom(Point center,
                 double levelOrFactor)
```
    Centers and zooms the map.
    
    Parameters:
    center - - Centers the map on the specified x,y location.
    levelOrFactor - - When using an ArcGISTiledMapServiceLayer, the map is zoomed to the level specified. When using a DynamicMapServiceLayer, the map is zoomed in or out by the specified factor. For example, use 0.5 to zoom in twice as far and 2.0 to zoom out twice as far.
  - centerAt
```
public void centerAt(Point center)
```
    Recenters the map based on map coordinates as the center point.
    
    Parameters:
    center - - Centers the map on the specified x,y location.
  - destroy
```
public void destroy()
```
    Destroys the map instance.
  - disableClickRecenter
```
public void disableClickRecenter()
```
    Disallows clicking on a map to recenter it.
  - disableDoubleClickZoom
```
public void disableDoubleClickZoom()
```
    Disallows double clicking on a map to zoom in a level and recenter the map.
  - disableKeyboardNavigation
```
public void disableKeyboardNavigation()
```
    Disallows panning and zooming using the keyboard.
  - disableMapNavigation
```
public void disableMapNavigation()
```
    Disallows all map navigation except the slider and pan arrows.
  - disablePan
```
public void disablePan()
```
    Disallows panning a map using the mouse.
  - disableRubberBandZoom
```
public void disableRubberBandZoom()
```
    Disallows zooming in or out on a map using a bounding box.
  - disableScrollWheelZoom
```
public void disableScrollWheelZoom()
```
    Disallows zooming in or out on a map using the mouse scroll wheel.
  - disableShiftDoubleClickZoom
```
public void disableShiftDoubleClickZoom()
```
    Disallows shift double clicking on a map to zoom in a level and recenter the map.
  - disableSnapping
```
public void disableSnapping()
```
    Disables snapping on the map.
  - enableClickRecenter
```
public void enableClickRecenter()
```
    Permits users to click on a map to recenter it.
  - enableDoubleClickZoom
```
public void enableDoubleClickZoom()
```
    Permits users to double click on a map to zoom in a level and recenter the map
  - enableKeyboardNavigation
```
public void enableKeyboardNavigation()
```
    Permits users to pan and zoom using the keyboard.
  - enableMapNavigation
```
public void enableMapNavigation()
```
    Allows all map navigation.
  - enablePan
```
public void enablePan()
```
    Permits users to pan a map using the mouse.
  - enableRubberBandZoom
```
public void enableRubberBandZoom()
```
    Permits users to zoom in or out on a map using a bounding box.
  - enableScrollWheelZoom
```
public void enableScrollWheelZoom()
```
    Permits users to zoom in or out on a map using the mouse scroll wheel.
  - enableShiftDoubleClickZoom
```
public void enableShiftDoubleClickZoom()
```
    Permits users to shift double click on a map to zoom in a level and recenter the map.
  - enableSnapping
```
public SnappingManager enableSnapping()
```
    Enable snapping on the map when working with the Editor, Measurement widget or the Draw and Edit toolbars. All graphics layers, including feature layers, will be set as snap targets. Call this method after the layers are loaded.
    
    Returns:
    SnappingManager
  - enableSnapping
```
public SnappingManager enableSnapping(SnappingManager.SnappingOptions options)
```
    Enable snapping on the map when working with the Editor, Measurement widget or the Draw and Edit toolbars. Call this method after the layers are loaded.
    
    Parameters:
    options - - optional parameters
    
    Returns:
    SnappingManager
  - getInfoWindowAnchor
```
public java.lang.String getInfoWindowAnchor(Point screenCoords)
```
    Sets an InfoWindow's anchor when calling InfoWindow.show
    
    Parameters:
    screenCoords - - The anchor point in screen units.
    
    Returns:
    String
  - getLayer
```
public Layer getLayer(java.lang.String id)
```
    Returns an individual layer of a map.
    
    Parameters:
    id - - ID assigned to the layer.
    
    Returns:
    boolean
  - getLevel
```
public float getLevel()
```
    Gets the current level of detail ID for the map. Valid only with an ArcGISTiledMapService layer.
    
    Returns:
    float
  - hidePanArrows
```
public void hidePanArrows()
```
    Hides the pan arrows from the map.
  - hideZoomSlider
```
public void hideZoomSlider()
```
    Hides the zoom slider from the map.
  - panDown
```
public void panDown()
```
    Pans the map south.
  - panLeft
```
public void panLeft()
```
    Pans the map west.
  - panLowerLeft
```
public void panLowerLeft()
```
    Pans the map southwest.
  - panLowerRight
```
public void panLowerRight()
```
    Pans the map southeast.
  - panRight
```
public void panRight()
```
    Pans the map east.
  - panUp
```
public void panUp()
```
    Pans the map north.
  - panUpperLeft
```
public void panUpperLeft()
```
    Pans the map northwest.
  - panUpperRight
```
public void panUpperRight()
```
    Pans the map northeast.
  - removeAllLayers
```
public void removeAllLayers()
```
    Removes all layers from the map. The map's extent, spatial reference, and tiling scheme if defined do not change when the layers are removed. When the next layer is added to the map, this layer is displayed at the same extent and spatial reference.
  - removeLayer
```
public void removeLayer(Layer layer)
```
    Removes the specified layer from the map.
    
    Parameters:
    layer - - Layer to be removed from the map.
  - reorderLayer
```
public void reorderLayer(Layer layer,
                int index)
```
    Changes the layer order in the map.
    
    Parameters:
    layer - - The layer to be moved.
    index - - Refers to the location for placing the layer. The bottom most layer has an index of 0.
  - reposition
```
public void reposition()
```
    Repositions the map DIV on the page. This method should be used after the map DIV has been repostioned.
  - resize
```
public void resize()
```
    Resizes the map DIV. This method should be used after the map DIV has been resized.
  - setExtent
```
public void setExtent(Extent extent,
             boolean fit)
```
    Sets the extent of the map. The extent must be in the same spatial reference as the map.
    
    Parameters:
    extent - - Sets the minx, miny, maxx, and maxy for a map.
    fit - - When true, for maps that contain tiled map service layers, you are guaranteed to have the input extent shown completely on the map.
  - setExtent
```
public void setExtent(Extent extent)
```
    Sets the extent of the map. The extent must be in the same spatial reference as the map.
    
    Parameters:
    extent - - Sets the minx, miny, maxx, and maxy for a map.
  - setLevel
```
public void setLevel(int level)
```
    Sets the map to the specified level ID. Zooms to the new level based on the current map center point. Valid only with an ArcGISTiledMapService layer.
    
    Parameters:
    level - - The level ID.
  - setMapCursor
```
public void setMapCursor(java.lang.String cursor)
```
    Sets the default cursor for the map. This cursor is shown whenever the mouse is pointed over the map, except when panning by dragging the map or using SHIFT+Drag to zoom. If not set, the map uses the platform-dependent default cursor, usually an arrow.
    
    Parameters:
    cursor - - A standard CSS cursor value. Some common values include "default", "pointer", "crosshair", "text", "help", and "wait".
  - setTimeExtent
```
public void setTimeExtent(TimeExtent timeExtent)
```
    Sets the TimeExtent for the map. When the time extent is changed the onTimeExtentChange event fires. Time aware layers listen for this event and update to only display content for the current time extent.
    
    Parameters:
    timeExtent - - Set the time extent for which data is displayed on the map.
  - setTimeSlider
```
public void setTimeSlider(TimeSlider timeSlider)
```
    Set the time slider associated with the map.
    
    Parameters:
    timeSlider - - The time slider dijit to associate with the map.
  - showPanArrows
```
public void showPanArrows()
```
    Shows the pan arrows on the map.
  - showZoomSlider
```
public void showZoomSlider()
```
    Shows the zoom slider on the map.
  - toMap
```
public final Point toMap(Point screenPoint)
```
    Converts a single screen point or an array of screen points to map coordinates.
    
    Parameters:
    screenPoint - - Converts screen coordinates to map coordinates.
    
    Returns:
    Point
  - toScreen
```
public final Point toScreen(Point mapPoint)
```
    Converts a single map point or an array of map points to screen coordinates.
    
    Parameters:
    mapPoint - - Converts map coordinates to screen coordinates.
    
    Returns:
    Point
  - addClickHandler
```
public void addClickHandler(ClickHandler handler)
```
    Add handler for when map is clicked.
    
    Parameters:
    handler - - Fires when a user single clicks on the map using the mouse and the mouse pointer\ is within the map region of the HTML page.
  - addDblClickHandler
```
public void addDblClickHandler(DblClickHandler handler)
```
    Add handler for when maps is double clicked
    
    Parameters:
    handler - - Fires when a user double clicks on the map using the mouse and the mouse pointer is within the map region of the HTML page.
  - addExtentChangeHandler
```
public void addExtentChangeHandler(MapExtentChangeHandler handler)
```
    Add Handler to listen to maps onResize Event Fires when the extent of the map has changed.
    
    Parameters:
    handler -
  - addKeyDownHandler
```
public void addKeyDownHandler(MapKeyDownHandler handler)
```
    Parameters:
    handler - - Fires when a keyboard key is pressed.
  - addKeyUpHandler
```
public void addKeyUpHandler(MapKeyUpHandler handler)
```
    Parameters:
    handler - - Fires when a keyboard key is released.
  - addLayerAddHandler
```
public void addLayerAddHandler(MapLayerAddHandler handler)
```
    Parameters:
    handler - - Fires any time a layer is added to the map.
  - addLayerAddResultHandler
```
public void addLayerAddResultHandler(MapLayerAddResultHandler handler)
```
    Parameters:
    handler - - Fires after specified layer has been added to the map.
  - addLayerRemoveHandler
```
public void addLayerRemoveHandler(MapLayerRemoveHandler handler)
```
    Parameters:
    handler - - Fires after the layer has been removed.
  - addLayerReorderHandler
```
public void addLayerReorderHandler(MapLayerReorderHandler handler)
```
    Parameters:
    handler - - Fires when the map layer order has been changed.
  - addLayersAddResultHandler
```
public void addLayersAddResultHandler(MapLayersAddResultHandler handler)
```
    Parameters:
    handler - - Fires after all layers are added to the map.
  - addLayersRemovedHandler
```
public void addLayersRemovedHandler(MapLayersRemovedHandler handler)
```
    Parameters:
    handler - - Fires after all the layers have been removed.
  - addLayersReorderedHandler
```
public void addLayersReorderedHandler(MapLayersReorderedHandler handler)
```
    Fires when all the layers have been reordered.
    
    Parameters:
    handler -
  - addLoadHandler
```
public void addLoadHandler(MapLoadHandler handler)
```
    Add Handler to listen to maps onLoad Event
    
    Parameters:
    handler - - Fires when the first or base layer has been successfully added to the map.
  - addMouseDownHandler
```
public void addMouseDownHandler(MouseDownHandler handler)
```
    Parameters:
    handler - - Fires when a mouse button is pressed down and the mouse cursor is in the map region of the HTML page.
  - addMouseDragHandler
```
public void addMouseDragHandler(MapMouseDragHandler handler)
```
    Parameters:
    handler - - Fires while the mouse is being dragged until the mouse button is released.
  - addMouseDragEndHandler
```
public void addMouseDragEndHandler(MapMouseDragEndHandler handler)
```
    Parameters:
    handler - - Fires when a mouse button is released and the user stops dragging the mouse.
  - addMouseDragStartHandler
```
public void addMouseDragStartHandler(MapMouseDragStartHandler handler)
```
    Parameters:
    handler - - Fires when a mouse button is pressed down and the user starts to drag the mouse.
  - addMouseMoveHandler
```
public void addMouseMoveHandler(MouseMoveHandler handler)
```
    Parameters:
    handler - - Fires any time the mouse pointer moves over the map region. A common use for this event is to show the current x,y coordinate of the map as the user moves the mouse pointer.
  - addMouseOutHandler
```
public void addMouseOutHandler(MouseOutHandler handler)
```
    Parameters:
    handler - - Fires when the mouse moves out of the map region of the HTML page.
  - addMouseOverHandler
```
public void addMouseOverHandler(MouseOverHandler handler)
```
    Parameters:
    handler - - Fires when the mouse moves into the map region of the HTML page.
  - addMouseUpHandler
```
public void addMouseUpHandler(MouseUpHandler handler)
```
    Parameters:
    handler - - Fires when the mouse button is released and the mouse pointer is within the map region of the HTML page.
  - addMouseWheelHandler
```
public void addMouseWheelHandler(MouseWheelHandler handler)
```
    Parameters:
    handler - - Fires when the mouse wheel is scrolled.
  - addPanHandler
```
public void addPanHandler(MapPanHandler handler)
```
    Add Handler to listen to maps onPan Event
    
    Parameters:
    handler - - Fires during the pan process.
  - addPanEndHandler
```
public void addPanEndHandler(MapPanEndHandler handler)
```
    Parameters:
    handler - - Fires when the pan is complete.
  - addPanStartHandler
```
public void addPanStartHandler(MapPanStartHandler handler)
```
    Parameters:
    handler - - Fires when a user commences panning.
  - addRepositionHandler
```
public void addRepositionHandler(MapRepositionHandler handler)
```
    Parameters:
    handler - - Fires when the map DIV is repositioned.
  - addResizeHandler
```
public void addResizeHandler(MapResizeHandler handler)
```
    Add Handler to listen to maps onResize Event
    
    Parameters:
    handler - - Fires when the Div containing the map has been resized.
  - addTimeExtentChange
```
public void addTimeExtentChange(TimeExtentChangeHandler handler)
```
    Parameters:
    handler - - Fires when the map's timeExtent property is set.
  - addUnloadHandler
```
public void addUnloadHandler(MapUnloadHandler handler)
```
    Add Handler to listen to maps onUnload Event
    
    Parameters:
    handler - - Fires when the page is refreshed.
  - addZoomHandler
```
public void addZoomHandler(MapZoomHandler handler)
```
    Parameters:
    handler - - Fires during the zoom process.
  - addUpdateEndHandler
```
public void addUpdateEndHandler(UpdateEndHandler handler)
```
    Parameters:
    handler - - Fires after layers that are updating their content have completed. This event is often used in combination with onUpdateStart to display a "Map is busy" or "Loading? " message as visual feedback to the end-user. (As of v2.2)
  - addUpdateStartHandler
```
public void addUpdateStartHandler(UpdateStartHandler handler)
```
    Parameters:
    handler - - Fires when one or more layers being updating their content. This event is often used in combination with onUpdateEnd to display a "Map is busy" or "Loading? " message as visual feedback to the end-user. (As of v2.2)
  - addZoomEndHandler
```
public void addZoomEndHandler(MapZoomEndHandler handler)
```
    Parameters:
    handler - - Fires when the zoom is complete.
  - addZoomStartHandler
```
public void addZoomStartHandler(MapZoomStartHandler handler)
```
    Parameters:
    handler - - Fires when a user commences zooming.

Class MapWidget

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MapWidget

MapWidget

Method Detail

addControl

removeControl

assertLoaded

getMapObject

getMapPanel

setSize

setWidth

setHeight

addInfoWindow

getExtent

isFadeOnZoom

isForce3DTransforms

getGraphics

getGraphicsLayerIds

getHeight

getId

getInfoWindow

isClickRecenter

isDoubleClickZoom

isKeyboardNavigation

isPan

isPanArrows

isRubberBandZoom

isScrollWheelZoom

isShiftDoubleClickZoom

isZoomSlider

getLayerIds

isLoaded

getNavigationMode

getPosition

getRoot

getSnappingManager

getSpatialReference

getTimeExtent

getWidth

addLayer

addLayer

addLayers

centerAndZoom

centerAt

destroy

disableClickRecenter

disableDoubleClickZoom

disableKeyboardNavigation

disableMapNavigation

disablePan

disableRubberBandZoom

disableScrollWheelZoom

disableShiftDoubleClickZoom

disableSnapping

enableClickRecenter

enableDoubleClickZoom

enableKeyboardNavigation

enableMapNavigation

enablePan

enableRubberBandZoom

enableScrollWheelZoom

enableShiftDoubleClickZoom

enableSnapping

enableSnapping

getInfoWindowAnchor

getLayer

getLevel

hidePanArrows

hideZoomSlider

panDown

panLeft

panLowerLeft

panLowerRight

panRight

panUp