com.esri.arcgis.controls
Interface IARMap

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ARMap, IARMapProxy

public interface IARMap
extends java.io.Serializable

COM Interface 'IARMap'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriPublisherControls.olb'

Description: 'Provides access to members that control the ARMap.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	DISPID_1_GET_NAME
static java.lang.String	DISPID_1_PUT_NAME
static java.lang.String	DISPID_10_NAME
static java.lang.String	DISPID_11_NAME
static java.lang.String	DISPID_12_NAME
static java.lang.String	DISPID_13_GET_NAME
static java.lang.String	DISPID_14_NAME
static java.lang.String	DISPID_15_NAME
static java.lang.String	DISPID_16_NAME
static java.lang.String	DISPID_17_NAME
static java.lang.String	DISPID_18_GET_NAME
static java.lang.String	DISPID_18_PUT_NAME
static java.lang.String	DISPID_19_NAME
static java.lang.String	DISPID_2_NAME
static java.lang.String	DISPID_20_NAME
static java.lang.String	DISPID_21_GET_NAME
static java.lang.String	DISPID_22_NAME
static java.lang.String	DISPID_23_GET_NAME
static java.lang.String	DISPID_24_NAME
static java.lang.String	DISPID_25_GET_NAME
static java.lang.String	DISPID_26_GET_NAME
static java.lang.String	DISPID_27_GET_NAME
static java.lang.String	DISPID_28_NAME
static java.lang.String	DISPID_29_NAME
static java.lang.String	DISPID_3_GET_NAME
static java.lang.String	DISPID_30_NAME
static java.lang.String	DISPID_31_GET_NAME
static java.lang.String	DISPID_31_PUT_NAME
static java.lang.String	DISPID_32_NAME
static java.lang.String	DISPID_4_GET_NAME
static java.lang.String	DISPID_5_GET_NAME
static java.lang.String	DISPID_6_GET_NAME
static java.lang.String	DISPID_7_GET_NAME
static java.lang.String	DISPID_8_GET_NAME
static java.lang.String	DISPID_9_GET_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IIDb27adbe0_9c31_48db_87a8_0434e88180c2
static int	xxDummy Deprecated. Internal use only

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

Field Detail

IIDb27adbe0_9c31_48db_87a8_0434e88180c2

static final int IIDb27adbe0_9c31_48db_87a8_0434e88180c2

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

DISPID_1_PUT_NAME

static final java.lang.String DISPID_1_PUT_NAME

See Also:

Constant Field Values

DISPID_1_GET_NAME

static final java.lang.String DISPID_1_GET_NAME

See Also:

Constant Field Values

DISPID_2_NAME

static final java.lang.String DISPID_2_NAME

See Also:

Constant Field Values

DISPID_3_GET_NAME

static final java.lang.String DISPID_3_GET_NAME

See Also:

Constant Field Values

DISPID_4_GET_NAME

static final java.lang.String DISPID_4_GET_NAME

See Also:

Constant Field Values

DISPID_5_GET_NAME

static final java.lang.String DISPID_5_GET_NAME

See Also:

Constant Field Values

DISPID_6_GET_NAME

static final java.lang.String DISPID_6_GET_NAME

See Also:

Constant Field Values

DISPID_7_GET_NAME

static final java.lang.String DISPID_7_GET_NAME

See Also:

Constant Field Values

DISPID_8_GET_NAME

static final java.lang.String DISPID_8_GET_NAME

See Also:

Constant Field Values

DISPID_9_GET_NAME

static final java.lang.String DISPID_9_GET_NAME

See Also:

Constant Field Values

DISPID_10_NAME

static final java.lang.String DISPID_10_NAME

See Also:

Constant Field Values

DISPID_11_NAME

static final java.lang.String DISPID_11_NAME

See Also:

Constant Field Values

DISPID_12_NAME

static final java.lang.String DISPID_12_NAME

See Also:

Constant Field Values

DISPID_13_GET_NAME

static final java.lang.String DISPID_13_GET_NAME

See Also:

Constant Field Values

DISPID_14_NAME

static final java.lang.String DISPID_14_NAME

See Also:

Constant Field Values

DISPID_15_NAME

static final java.lang.String DISPID_15_NAME

See Also:

Constant Field Values

DISPID_16_NAME

static final java.lang.String DISPID_16_NAME

See Also:

Constant Field Values

DISPID_17_NAME

static final java.lang.String DISPID_17_NAME

See Also:

Constant Field Values

DISPID_18_PUT_NAME

static final java.lang.String DISPID_18_PUT_NAME

See Also:

Constant Field Values

DISPID_18_GET_NAME

static final java.lang.String DISPID_18_GET_NAME

See Also:

Constant Field Values

DISPID_19_NAME

static final java.lang.String DISPID_19_NAME

See Also:

Constant Field Values

DISPID_20_NAME

static final java.lang.String DISPID_20_NAME

See Also:

Constant Field Values

DISPID_21_GET_NAME

static final java.lang.String DISPID_21_GET_NAME

See Also:

Constant Field Values

DISPID_22_NAME

static final java.lang.String DISPID_22_NAME

See Also:

Constant Field Values

DISPID_23_GET_NAME

static final java.lang.String DISPID_23_GET_NAME

See Also:

Constant Field Values

DISPID_24_NAME

static final java.lang.String DISPID_24_NAME

See Also:

Constant Field Values

DISPID_25_GET_NAME

static final java.lang.String DISPID_25_GET_NAME

See Also:

Constant Field Values

DISPID_26_GET_NAME

static final java.lang.String DISPID_26_GET_NAME

See Also:

Constant Field Values

DISPID_27_GET_NAME

static final java.lang.String DISPID_27_GET_NAME

See Also:

Constant Field Values

DISPID_28_NAME

static final java.lang.String DISPID_28_NAME

See Also:

Constant Field Values

DISPID_29_NAME

static final java.lang.String DISPID_29_NAME

See Also:

Constant Field Values

DISPID_30_NAME

static final java.lang.String DISPID_30_NAME

See Also:

Constant Field Values

DISPID_31_GET_NAME

static final java.lang.String DISPID_31_GET_NAME

See Also:

Constant Field Values

DISPID_31_PUT_NAME

static final java.lang.String DISPID_31_PUT_NAME

See Also:

Constant Field Values

DISPID_32_NAME

static final java.lang.String DISPID_32_NAME

See Also:

Constant Field Values

Method Detail

setMapScale

void setMapScale(double mapScale)
                 throws java.io.IOException,
                        AutomationException

The scale of the map as a representative fraction.

Parameters:

mapScale - The mapScale (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapScale

double getMapScale()
                   throws java.io.IOException,
                          AutomationException

The scale of the map as a representative fraction.

Returns:

The mapScale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refresh

void refresh(boolean refreshNow)
             throws java.io.IOException,
                    AutomationException

Redraws the map display area.

Parameters:

refreshNow - The refreshNow (in, optional, pass false if not required)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the map.

Returns:

The sName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getARLayerCount

int getARLayerCount()
                    throws java.io.IOException,
                           AutomationException

The number of layer in the map's layer collection.

Returns:

The count

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getARLayer

IARLayer getARLayer(int index)
                    throws java.io.IOException,
                           AutomationException

The layer at the specified index.

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.controls.IARLayer

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

The description of the map.

Returns:

The sDesciption

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReferenceName

java.lang.String getSpatialReferenceName()
                                         throws java.io.IOException,
                                                AutomationException

The name of the map's spatial reference.

Returns:

The sSpatialReference

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMapUnits

int getMapUnits()
                throws java.io.IOException,
                       AutomationException

The geographical units of the map.

Returns:

A com.esri.arcgis.controls.esriARUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistanceUnits

int getDistanceUnits()
                     throws java.io.IOException,
                            AutomationException

The distance units of the map.

Returns:

A com.esri.arcgis.controls.esriARUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtent

void setExtent(double xMin,
               double yMin,
               double xMax,
               double yMax)
               throws java.io.IOException,
                      AutomationException

Sets the visible extent of the map.

Parameters:

xMin - The xMin (in)

yMin - The yMin (in)

xMax - The xMax (in)

yMax - The yMax (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

void getExtent(double[] xMin,
               double[] yMin,
               double[] xMax,
               double[] yMax)
               throws java.io.IOException,
                      AutomationException

The visible extent of the map.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullExtent

void getFullExtent(double[] xMin,
                   double[] yMin,
                   double[] xMax,
                   double[] yMax)
                   throws java.io.IOException,
                          AutomationException

The extent of all the data within the map.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceScale

double getReferenceScale()
                         throws java.io.IOException,
                                AutomationException

The reference scale of the map as a representative fraction.

Returns:

The refScale

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoomIn

void zoomIn(double factor)
            throws java.io.IOException,
                   AutomationException

Zooms in on the map by a factor.

Parameters:

factor - The factor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoomOut

void zoomOut(double factor)
             throws java.io.IOException,
                    AutomationException

Zooms out on the map by a factor.

Parameters:

factor - The factor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

pan

void pan(int direction,
         double screenPercentage)
         throws java.io.IOException,
                AutomationException

Pans the map by a factor in a specified direction.

Parameters:

direction - A com.esri.arcgis.controls.esriARDirection constant (in)

screenPercentage - The screenPercentage (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

centerAt

void centerAt(double xCoord,
              double yCoord)
              throws java.io.IOException,
                     AutomationException

Moves the center of the map to the specified point.

Parameters:

xCoord - The xCoord (in)

yCoord - The yCoord (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRotation

void setRotation(double mapRotation)
                 throws java.io.IOException,
                        AutomationException

The number of degrees the map display is rotated.

Parameters:

mapRotation - The mapRotation (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRotation

double getRotation()
                   throws java.io.IOException,
                          AutomationException

The number of degrees the map display is rotated.

Returns:

The mapRotation

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryARFeatures

IARFeatureSet queryARFeatures(IARSearchDef pSearchDef)
                              throws java.io.IOException,
                                     AutomationException

Searches the map using a search definition and returns an ARFeatureSet.

Parameters:

pSearchDef - A reference to a com.esri.arcgis.controls.IARSearchDef (in)

Returns:

A reference to a com.esri.arcgis.controls.IARFeatureSet

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

toMapPoint

void toMapPoint(int x,
                int y,
                double[] xCoord,
                double[] yCoord)
                throws java.io.IOException,
                       AutomationException

Converts a point in device coordinates (typically pixels) to coordinates in map units.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanUndoExtent

boolean isCanUndoExtent()
                        throws java.io.IOException,
                               AutomationException

Indicates if there is a map extent that can be undone.

Returns:

The bCanUndo

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

undoExtent

void undoExtent()
                throws java.io.IOException,
                       AutomationException

Undo to the previous map extent in the stack.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCanRedoExtent

boolean isCanRedoExtent()
                        throws java.io.IOException,
                               AutomationException

Indicates if there is a map extent that can be redone.

Returns:

The bCanRedo

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

redoExtent

void redoExtent()
                throws java.io.IOException,
                       AutomationException

Redo the next map extent in the stack.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInternalObject

java.lang.Object getInternalObject()
                                   throws java.io.IOException,
                                          AutomationException

The internal ArcObjects IMap object.

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBookmarkCount

int getBookmarkCount()
                     throws java.io.IOException,
                            AutomationException

The number of bookmarks in the map's bookmark collection.

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBookmarkName

java.lang.String getBookmarkName(int index)
                                 throws java.io.IOException,
                                        AutomationException

The name of the bookmark.

Parameters:

index - The index (in)

Returns:

The pVal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoomToBookmark

void zoomToBookmark(java.lang.Object vBookmarkID)
                    throws java.io.IOException,
                           AutomationException

Zooms the map display to the bookmark.

Parameters:

vBookmarkID - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

centerAtBookmark

void centerAtBookmark(java.lang.Object vBookmarkID)
                      throws java.io.IOException,
                             AutomationException

Centers the map display on the bookmark.

Parameters:

vBookmarkID - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

zoomToFullExtent

void zoomToFullExtent()
                      throws java.io.IOException,
                             AutomationException

Zoom to the full extent of all data within the map.

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomProperty

java.lang.Object getCustomProperty()
                                   throws java.io.IOException,
                                          AutomationException

A property to associate data with an object.

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCustomProperty

void setCustomProperty(java.lang.Object pVal)
                       throws java.io.IOException,
                              AutomationException

A property to associate data with an object.

Parameters:

pVal - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

searchARFeatures

IARFeatureCursor searchARFeatures(IARSearchDef pSearchDef)
                                  throws java.io.IOException,
                                         AutomationException

Searches the map using a search definition and returns an ARFeatureCursor.

Parameters:

pSearchDef - A reference to a com.esri.arcgis.controls.IARSearchDef (in)

Returns:

A reference to a com.esri.arcgis.controls.IARFeatureCursor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.