com.esri.arcgis.controls
Class ARMap

java.lang.Object
  extended by com.esri.arcgis.controls.ARMap
All Implemented Interfaces:
IARMap, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ARMap
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IARMap

The ARMap container for the display of map data.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

See Also:
Serialized Form

Constructor Summary
ARMap(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(Object vBookmarkID)
          Centers the map display on the bookmark.
 boolean equals(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.
 int getBookmarkCount()
          The number of bookmarks in the map's bookmark collection.
 String getBookmarkName(int index)
          The name of the bookmark.
 Object getCustomProperty()
          A property to associate data with an object.
 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.
 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.
 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.
 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(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(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
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

ARMap

public ARMap(Object obj)
      throws 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

Throws:
IOException - if there are interop problems ARMap theARMap = (ARMap) obj;
Method Detail

equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

setMapScale

public void setMapScale(double mapScale)
                 throws IOException,
                        AutomationException
The scale of the map as a representative fraction.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
setMapScale in interface IARMap
Parameters:
mapScale - The mapScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapScale

public double getMapScale()
                   throws IOException,
                          AutomationException
The scale of the map as a representative fraction.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getMapScale in interface IARMap
Returns:
The mapScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh(boolean refreshNow)
             throws IOException,
                    AutomationException
Redraws the map display area.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
refresh in interface IARMap
Parameters:
refreshNow - The refreshNow (in, optional, pass false if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
The name of the map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getName in interface IARMap
Returns:
The sName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getARLayerCount

public int getARLayerCount()
                    throws IOException,
                           AutomationException
The number of layer in the map's layer collection.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getARLayerCount in interface IARMap
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getARLayer

public IARLayer getARLayer(int index)
                    throws IOException,
                           AutomationException
The layer at the specified index.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getARLayer in interface IARMap
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.controls.IARLayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException
The description of the map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getDescription in interface IARMap
Returns:
The sDesciption
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpatialReferenceName

public String getSpatialReferenceName()
                               throws IOException,
                                      AutomationException
The name of the map's spatial reference.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getSpatialReferenceName in interface IARMap
Returns:
The sSpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapUnits

public int getMapUnits()
                throws IOException,
                       AutomationException
The geographical units of the map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getMapUnits in interface IARMap
Returns:
A com.esri.arcgis.controls.esriARUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDistanceUnits

public int getDistanceUnits()
                     throws IOException,
                            AutomationException
The distance units of the map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getDistanceUnits in interface IARMap
Returns:
A com.esri.arcgis.controls.esriARUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtent

public void setExtent(double xMin,
                      double yMin,
                      double xMax,
                      double yMax)
               throws IOException,
                      AutomationException
Sets the visible extent of the map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
setExtent in interface IARMap
Parameters:
xMin - The xMin (in)
yMin - The yMin (in)
xMax - The xMax (in)
yMax - The yMax (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public void getExtent(double[] xMin,
                      double[] yMin,
                      double[] xMax,
                      double[] yMax)
               throws IOException,
                      AutomationException
The visible extent of the map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getExtent in interface IARMap
Parameters:
xMin - The xMin (in/out: use single element array)
yMin - The yMin (in/out: use single element array)
xMax - The xMax (in/out: use single element array)
yMax - The yMax (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFullExtent

public void getFullExtent(double[] xMin,
                          double[] yMin,
                          double[] xMax,
                          double[] yMax)
                   throws IOException,
                          AutomationException
The extent of all the data within the map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getFullExtent in interface IARMap
Parameters:
xMin - The xMin (in/out: use single element array)
yMin - The yMin (in/out: use single element array)
xMax - The xMax (in/out: use single element array)
yMax - The yMax (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReferenceScale

public double getReferenceScale()
                         throws IOException,
                                AutomationException
The reference scale of the map as a representative fraction.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getReferenceScale in interface IARMap
Returns:
The refScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

zoomIn

public void zoomIn(double factor)
            throws IOException,
                   AutomationException
Zooms in on the map by a factor.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
zoomIn in interface IARMap
Parameters:
factor - The factor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

zoomOut

public void zoomOut(double factor)
             throws IOException,
                    AutomationException
Zooms out on the map by a factor.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
zoomOut in interface IARMap
Parameters:
factor - The factor (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

pan

public void pan(int direction,
                double screenPercentage)
         throws IOException,
                AutomationException
Pans the map by a factor in a specified direction.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
pan in interface IARMap
Parameters:
direction - A com.esri.arcgis.controls.esriARDirection constant (in)
screenPercentage - The screenPercentage (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

centerAt

public void centerAt(double xCoord,
                     double yCoord)
              throws IOException,
                     AutomationException
Moves the center of the map to the specified point.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
centerAt in interface IARMap
Parameters:
xCoord - The xCoord (in)
yCoord - The yCoord (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRotation

public void setRotation(double mapRotation)
                 throws IOException,
                        AutomationException
The number of degrees the map display is rotated.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
setRotation in interface IARMap
Parameters:
mapRotation - The mapRotation (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRotation

public double getRotation()
                   throws IOException,
                          AutomationException
The number of degrees the map display is rotated.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getRotation in interface IARMap
Returns:
The mapRotation
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryARFeatures

public IARFeatureSet queryARFeatures(IARSearchDef pSearchDef)
                              throws IOException,
                                     AutomationException
Searches the map using a search definition and returns an ARFeatureSet.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
queryARFeatures in interface IARMap
Parameters:
pSearchDef - A reference to a com.esri.arcgis.controls.IARSearchDef (in)
Returns:
A reference to a com.esri.arcgis.controls.IARFeatureSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

toMapPoint

public void toMapPoint(int x,
                       int y,
                       double[] xCoord,
                       double[] yCoord)
                throws IOException,
                       AutomationException
Converts a point in device coordinates (typically pixels) to coordinates in map units.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
toMapPoint in interface IARMap
Parameters:
x - The x (in)
y - The y (in)
xCoord - The xCoord (in/out: use single element array)
yCoord - The yCoord (in/out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanUndoExtent

public boolean isCanUndoExtent()
                        throws IOException,
                               AutomationException
Indicates if there is a map extent that can be undone.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
isCanUndoExtent in interface IARMap
Returns:
The bCanUndo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

undoExtent

public void undoExtent()
                throws IOException,
                       AutomationException
Undo to the previous map extent in the stack.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
undoExtent in interface IARMap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanRedoExtent

public boolean isCanRedoExtent()
                        throws IOException,
                               AutomationException
Indicates if there is a map extent that can be redone.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
isCanRedoExtent in interface IARMap
Returns:
The bCanRedo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

redoExtent

public void redoExtent()
                throws IOException,
                       AutomationException
Redo the next map extent in the stack.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
redoExtent in interface IARMap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInternalObject

public Object getInternalObject()
                         throws IOException,
                                AutomationException
The internal ArcObjects IMap object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getInternalObject in interface IARMap
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBookmarkCount

public int getBookmarkCount()
                     throws IOException,
                            AutomationException
The number of bookmarks in the map's bookmark collection.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getBookmarkCount in interface IARMap
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBookmarkName

public String getBookmarkName(int index)
                       throws IOException,
                              AutomationException
The name of the bookmark.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getBookmarkName in interface IARMap
Parameters:
index - The index (in)
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

zoomToBookmark

public void zoomToBookmark(Object vBookmarkID)
                    throws IOException,
                           AutomationException
Zooms the map display to the bookmark.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
zoomToBookmark in interface IARMap
Parameters:
vBookmarkID - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

centerAtBookmark

public void centerAtBookmark(Object vBookmarkID)
                      throws IOException,
                             AutomationException
Centers the map display on the bookmark.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
centerAtBookmark in interface IARMap
Parameters:
vBookmarkID - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

zoomToFullExtent

public void zoomToFullExtent()
                      throws IOException,
                             AutomationException
Zoom to the full extent of all data within the map.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
zoomToFullExtent in interface IARMap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomProperty

public Object getCustomProperty()
                         throws IOException,
                                AutomationException
A property to associate data with an object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
getCustomProperty in interface IARMap
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomProperty

public void setCustomProperty(Object pVal)
                       throws IOException,
                              AutomationException
A property to associate data with an object.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
setCustomProperty in interface IARMap
Parameters:
pVal - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

searchARFeatures

public IARFeatureCursor searchARFeatures(IARSearchDef pSearchDef)
                                  throws IOException,
                                         AutomationException
Searches the map using a search definition and returns an ARFeatureCursor.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Specified by:
searchARFeatures in interface IARMap
Parameters:
pSearchDef - A reference to a com.esri.arcgis.controls.IARSearchDef (in)
Returns:
A reference to a com.esri.arcgis.controls.IARFeatureCursor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.