ARMap (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.controls
Class ARMap

java.lang.Object
  com.esri.arcgis.controls.ARMap

All Implemented Interfaces:: IARMap, java.io.Serializable

public class ARMap
extends java.lang.Object
implements IARMap

The ARMap container for the display of map data.

Product Availability

Available with ArcGIS Engine.

See Also:: Serialized Form

Constructor Summary
`ARMap(java.lang.Object obj)` Construct a ARMap using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary
`void`	`centerAt(double xCoord, double yCoord)` Moves the center of the map to the specified point.
`void`	`centerAtBookmark(java.lang.Object vBookmarkID)` Centers the map display on the bookmark.
`boolean`	`equals(java.lang.Object o)` Compare this object with another
`IARLayer`	`getARLayer(int index)` The layer at the specified index.
`int`	`getARLayerCount()` The number of layer in the map's layer collection.
`IARMap`	`getAsIARMap()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`int`	`getBookmarkCount()` The number of bookmarks in the map's bookmark collection.
`java.lang.String`	`getBookmarkName(int index)` The name of the bookmark.
`java.lang.Object`	`getCustomProperty()` A property to associate data with an object.
`java.lang.String`	`getDescription()` The description of the map.
`int`	`getDistanceUnits()` The distance units of the map.
`void`	`getExtent(double[] xMin, double[] yMin, double[] xMax, double[] yMax)` The visible extent of the map.
`void`	`getFullExtent(double[] xMin, double[] yMin, double[] xMax, double[] yMax)` The extent of all the data within the map.
`java.lang.Object`	`getInternalObject()` The internal ArcObjects IMap object.
`double`	`getMapScale()` The scale of the map as a representative fraction.
`int`	`getMapUnits()` The geographical units of the map.
`java.lang.String`	`getName()` The name of the map.
`double`	`getReferenceScale()` The reference scale of the map as a representative fraction.
`double`	`getRotation()` The number of degrees the map display is rotated.
`java.lang.String`	`getSpatialReferenceName()` The name of the map's spatial reference.
`int`	`hashCode()` the hashcode for this object
`boolean`	`isCanRedoExtent()` Indicates if there is a map extent that can be redone.
`boolean`	`isCanUndoExtent()` Indicates if there is a map extent that can be undone.
`void`	`pan(int direction, double screenPercentage)` Pans the map by a factor in a specified direction.
`IARFeatureSet`	`queryARFeatures(IARSearchDef pSearchDef)` Searches the map using a search definition and returns an ARFeatureSet.
`void`	`redoExtent()` Redo the next map extent in the stack.
`void`	`refresh(boolean refreshNow)` Redraws the map display area.
`IARFeatureCursor`	`searchARFeatures(IARSearchDef pSearchDef)` Searches the map using a search definition and returns an ARFeatureCursor.
`void`	`setCustomProperty(java.lang.Object pVal)` A property to associate data with an object.
`void`	`setExtent(double xMin, double yMin, double xMax, double yMax)` Sets the visible extent of the map.
`void`	`setMapScale(double mapScale)` The scale of the map as a representative fraction.
`void`	`setRotation(double mapRotation)` The number of degrees the map display is rotated.
`void`	`toMapPoint(int x, int y, double[] xCoord, double[] yCoord)` Converts a point in device coordinates (typically pixels) to coordinates in map units.
`void`	`undoExtent()` Undo to the previous map extent in the stack.
`void`	`zoomIn(double factor)` Zooms in on the map by a factor.
`void`	`zoomOut(double factor)` Zooms out on the map by a factor.
`void`	`zoomToBookmark(java.lang.Object vBookmarkID)` Zooms the map display to the bookmark.
`void`	`zoomToFullExtent()` Zoom to the full extent of all data within the map.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ARMap

public ARMap(java.lang.Object obj)
      throws java.io.IOException

Construct a ARMap using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ARMap.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
* ARMap o = (ARMap)obj; // will not work ARMap o = new ARMap(obj); // Use this constructor instead * @param obj an object returned from ArcGIS Engine or Server ARMap theARMap = (ARMap) obj;
Throws:: java.io.IOException - if there are interop problems

Method Detail

getAsIARMap

public IARMap getAsIARMap()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object