com.esri.arcgis.carto
Class IMapDescriptorProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.carto.IMapDescriptorProxy

All Implemented Interfaces:

IMapDescriptor, java.io.Externalizable, java.io.Serializable

Deprecated. Internal use only. Proxy for COM Interface 'IMapDescriptor'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to the available properties of a map descriptor object.' 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 =

public class IMapDescriptorProxy
extends com.esri.arcgis.interop.Dispatch
implements IMapDescriptor, java.io.Serializable

Internal use class

See Also:

Serialized Form

Field Summary

boolean	noncastable Deprecated.
static java.lang.Class	targetClass Deprecated.

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Fields inherited from interface com.esri.arcgis.carto.IMapDescriptor

DISPID_0_GET_NAME, DISPID_0_PUT_NAME, DISPID_1_GET_NAME, DISPID_1_PUT_NAME, DISPID_10_GET_NAME, DISPID_10_PUT_NAME, DISPID_11_GET_NAME, DISPID_11_PUT_NAME, DISPID_12_GET_NAME, DISPID_12_PUT_NAME, DISPID_13_GET_NAME, DISPID_13_PUT_NAME, DISPID_14_NAME, DISPID_15_NAME, DISPID_16_NAME, DISPID_17_NAME, DISPID_2_GET_NAME, DISPID_2_PUT_NAME, DISPID_3_GET_NAME, DISPID_3_PUTREF_NAME, DISPID_4_GET_NAME, DISPID_4_PUT_NAME, DISPID_5_GET_NAME, DISPID_5_PUT_NAME, DISPID_6_GET_NAME, DISPID_6_PUT_NAME, DISPID_7_GET_NAME, DISPID_7_PUT_NAME, DISPID_8_GET_NAME, DISPID_8_PUT_NAME, DISPID_9_GET_NAME, DISPID_9_PUT_NAME, IID, IIDd9609d73_afea_4739_8f29_f5993823f4cf

Constructor Summary

	IMapDescriptorProxy() Deprecated. For internal use only
	IMapDescriptorProxy(java.lang.Object obj) Deprecated.
protected	IMapDescriptorProxy(java.lang.Object obj, java.lang.String iid) Deprecated.
	IMapDescriptorProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.
protected	IMapDescriptorProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Deprecated.
void	addMapSurround(IMapSurround surround, int xPixelOrigin, int yPixelOrigin, int anchorPoint) Deprecated. Call this multiple times to place surrounds on the surface of the map.
void	addPixelGraphic(IElement graphic) Deprecated. Call this multiple times to place graphics in pixel space on the map above Custom Graphics and Map Surrounds.
void	clearMapSurrounds() Deprecated. Remove all surrounds from the map.
void	clearPixelGraphics() Deprecated. Remove all pixel graphics from the map.
double	getAngle() Deprecated. The angle/rotation of the map in degrees, measured anti-clockwise.
IColor	getBackgroundColor() Deprecated. The background color of the map.
IArray	getCustomGraphics() Deprecated. Custom graphics of the map.
IEnvelope	getExtent() Deprecated. The current extent of the map.
IEnvelope	getFullExtent() Deprecated. The full extent of the map.
IGeometryCollection	getLabelBarriers() Deprecated. The barriers used for labeling.
java.lang.Object	getLayerOrder() Deprecated. The layer order for the map.
IArray	getLayers() Deprecated. The layer descriptors of the map.
IPoint	getMapCenter() Deprecated. The center of the map.
double	getMapScale() Deprecated. The scale of the map.
java.lang.String	getName() Deprecated. The name of the map.
ISpatialReference	getSpatialReference() Deprecated. The spatial reference of the map.
IColor	getTransparentColor() Deprecated. The color used for transparency (100 %).
boolean	isKeepAspectRatio() Deprecated. Indicates whether of not to maintain the aspect ratio.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Deprecated.
void	setAngle(double angleDegrees) Deprecated. The angle/rotation of the map in degrees, measured anti-clockwise.
void	setBackgroundColor(IColor color) Deprecated. The background color of the map.
void	setCustomGraphics(IArray elements) Deprecated. Custom graphics of the map.
void	setExtent(IEnvelope extent) Deprecated. The current extent of the map.
void	setFullExtent(IEnvelope extent) Deprecated. The full extent of the map.
void	setKeepAspectRatio(boolean keep) Deprecated. Indicates whether of not to maintain the aspect ratio.
void	setLabelBarriers(IGeometryCollection barriers) Deprecated. The barriers used for labeling.
void	setLayerOrder(java.lang.Object layerIds) Deprecated. The layer order for the map.
void	setLayers(IArray layerDescriptors) Deprecated. The layer descriptors of the map.
void	setMapCenter(IPoint center) Deprecated. The center of the map.
void	setMapScale(double mapScale) Deprecated. The scale of the map.
void	setName(java.lang.String name) Deprecated. The name of the map.
void	setSpatialReferenceByRef(ISpatialReference spatialReference) Deprecated. The spatial reference of the map.
void	setTransparentColor(IColor color) Deprecated. The color used for transparency (100 %).

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

Deprecated.

noncastable

public boolean noncastable

Deprecated.

Constructor Detail

IMapDescriptorProxy

public IMapDescriptorProxy(java.lang.String CLSID,
                           java.lang.String host,
                           com.esri.arcgis.interop.AuthInfo authInfo)
                    throws java.net.UnknownHostException,
                           java.io.IOException

Deprecated.

Throws:

java.net.UnknownHostException

java.io.IOException

IMapDescriptorProxy

public IMapDescriptorProxy()

Deprecated.

For internal use only

IMapDescriptorProxy

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

Deprecated.

Throws:

java.io.IOException

IMapDescriptorProxy

protected IMapDescriptorProxy(java.lang.Object obj,
                              java.lang.String iid)
                       throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

IMapDescriptorProxy

protected IMapDescriptorProxy(java.lang.String CLSID,
                              java.lang.String iid,
                              java.lang.String host,
                              com.esri.arcgis.interop.AuthInfo authInfo)
                       throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Deprecated.

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Deprecated.

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

getName

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

Deprecated.

The name of the map.

Specified by:

getName in interface IMapDescriptor

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Deprecated.

The name of the map.

Specified by:

setName in interface IMapDescriptor

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFullExtent

public IEnvelope getFullExtent()
                        throws java.io.IOException,
                               AutomationException

Deprecated.

The full extent of the map.

Specified by:

getFullExtent in interface IMapDescriptor

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFullExtent

public void setFullExtent(IEnvelope extent)
                   throws java.io.IOException,
                          AutomationException

Deprecated.

The full extent of the map.

Specified by:

setFullExtent in interface IMapDescriptor

Parameters:

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

Deprecated.

The current extent of the map.

Specified by:

getExtent in interface IMapDescriptor

Returns:

A reference to a com.esri.arcgis.geometry.IEnvelope

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExtent

public void setExtent(IEnvelope extent)
               throws java.io.IOException,
                      AutomationException

Deprecated.

The current extent of the map.

Specified by:

setExtent in interface IMapDescriptor

Parameters:

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

Deprecated.

The spatial reference of the map.

Specified by:

getSpatialReference in interface IMapDescriptor

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference spatialReference)
                              throws java.io.IOException,
                                     AutomationException

Deprecated.

The spatial reference of the map.

Specified by:

setSpatialReferenceByRef in interface IMapDescriptor

Parameters:

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAngle

public double getAngle()
                throws java.io.IOException,
                       AutomationException

Deprecated.

The angle/rotation of the map in degrees, measured anti-clockwise.

Specified by:

getAngle in interface IMapDescriptor

Returns:

The angleDegrees

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAngle

public void setAngle(double angleDegrees)
              throws java.io.IOException,
                     AutomationException

Deprecated.

The angle/rotation of the map in degrees, measured anti-clockwise.

Specified by:

setAngle in interface IMapDescriptor

Parameters:

angleDegrees - The angleDegrees (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayers

public IArray getLayers()
                 throws java.io.IOException,
                        AutomationException

Deprecated.

The layer descriptors of the map.

Specified by:

getLayers in interface IMapDescriptor

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLayers

public void setLayers(IArray layerDescriptors)
               throws java.io.IOException,
                      AutomationException

Deprecated.

The layer descriptors of the map.

Specified by:

setLayers in interface IMapDescriptor

Parameters:

layerDescriptors - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerOrder

public java.lang.Object getLayerOrder()
                               throws java.io.IOException,
                                      AutomationException

Deprecated.

The layer order for the map. The VARIANT value is a SAFEARRAY of long integers that list the layerIDs in order. The first element is top layer in the map. Layers that are within groups are not listed in this array.

Specified by:

getLayerOrder in interface IMapDescriptor

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLayerOrder

public void setLayerOrder(java.lang.Object layerIds)
                   throws java.io.IOException,
                          AutomationException

Deprecated.

The layer order for the map. The VARIANT value is a SAFEARRAY of long integers that list the layerIDs in order. The first element is top layer in the map. Layers that are within groups are not listed in this array.

Specified by:

setLayerOrder in interface IMapDescriptor

Parameters:

layerIds - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCustomGraphics

public IArray getCustomGraphics()
                         throws java.io.IOException,
                                AutomationException

Deprecated.

Custom graphics of the map.

Specified by:

getCustomGraphics in interface IMapDescriptor

Returns:

A reference to a com.esri.arcgis.system.IArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomGraphics

public void setCustomGraphics(IArray elements)
                       throws java.io.IOException,
                              AutomationException

Deprecated.

Custom graphics of the map.

Specified by:

setCustomGraphics in interface IMapDescriptor

Parameters:

elements - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLabelBarriers

public IGeometryCollection getLabelBarriers()
                                     throws java.io.IOException,
                                            AutomationException

Deprecated.

The barriers used for labeling.

Specified by:

getLabelBarriers in interface IMapDescriptor

Returns:

A reference to a com.esri.arcgis.geometry.IGeometryCollection

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLabelBarriers

public void setLabelBarriers(IGeometryCollection barriers)
                      throws java.io.IOException,
                             AutomationException

Deprecated.

The barriers used for labeling.

Specified by:

setLabelBarriers in interface IMapDescriptor

Parameters:

barriers - A reference to a com.esri.arcgis.geometry.IGeometryCollection (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapScale

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

Deprecated.

The scale of the map.

Specified by:

getMapScale in interface IMapDescriptor

Returns:

The mapScale

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapScale

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

Deprecated.

The scale of the map.

Specified by:

setMapScale in interface IMapDescriptor

Parameters:

mapScale - The mapScale (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapCenter

public IPoint getMapCenter()
                    throws java.io.IOException,
                           AutomationException

Deprecated.

The center of the map.

Specified by:

getMapCenter in interface IMapDescriptor

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapCenter

public void setMapCenter(IPoint center)
                  throws java.io.IOException,
                         AutomationException

Deprecated.

The center of the map.

Specified by:

setMapCenter in interface IMapDescriptor

Parameters:

center - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isKeepAspectRatio

public boolean isKeepAspectRatio()
                          throws java.io.IOException,
                                 AutomationException

Deprecated.

Indicates whether of not to maintain the aspect ratio.

Specified by:

isKeepAspectRatio in interface IMapDescriptor

Returns:

The keep

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setKeepAspectRatio

public void setKeepAspectRatio(boolean keep)
                        throws java.io.IOException,
                               AutomationException

Deprecated.

Indicates whether of not to maintain the aspect ratio.

Specified by:

setKeepAspectRatio in interface IMapDescriptor

Parameters:

keep - The keep (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

public IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException

Deprecated.

The background color of the map.

Specified by:

getBackgroundColor in interface IMapDescriptor

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

public void setBackgroundColor(IColor color)
                        throws java.io.IOException,
                               AutomationException

Deprecated.

The background color of the map.

Specified by:

setBackgroundColor in interface IMapDescriptor

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTransparentColor

public IColor getTransparentColor()
                           throws java.io.IOException,
                                  AutomationException

Deprecated.

The color used for transparency (100 %).

Specified by:

getTransparentColor in interface IMapDescriptor

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTransparentColor

public void setTransparentColor(IColor color)
                         throws java.io.IOException,
                                AutomationException

Deprecated.

The color used for transparency (100 %).

Specified by:

setTransparentColor in interface IMapDescriptor

Parameters:

color - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addMapSurround

public void addMapSurround(IMapSurround surround,
                           int xPixelOrigin,
                           int yPixelOrigin,
                           int anchorPoint)
                    throws java.io.IOException,
                           AutomationException

Deprecated.

Call this multiple times to place surrounds on the surface of the map. Specify coordinates in pixels. Origin is at lower left corner.

Specified by:

addMapSurround in interface IMapDescriptor

Parameters:

surround - A reference to a com.esri.arcgis.carto.IMapSurround (in)

xPixelOrigin - The xPixelOrigin (in)

yPixelOrigin - The yPixelOrigin (in)

anchorPoint - A com.esri.arcgis.carto.esriAnchorPointEnum constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearMapSurrounds

public void clearMapSurrounds()
                       throws java.io.IOException,
                              AutomationException

Deprecated.

Remove all surrounds from the map.

Specified by:

clearMapSurrounds in interface IMapDescriptor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addPixelGraphic

public void addPixelGraphic(IElement graphic)
                     throws java.io.IOException,
                            AutomationException

Deprecated.

Call this multiple times to place graphics in pixel space on the map above Custom Graphics and Map Surrounds. Specify coordinates in pixels. Origin is at lower left corner.

Specified by:

addPixelGraphic in interface IMapDescriptor

Parameters:

graphic - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearPixelGraphics

public void clearPixelGraphics()
                        throws java.io.IOException,
                               AutomationException

Deprecated.

Remove all pixel graphics from the map.

Specified by:

clearPixelGraphics in interface IMapDescriptor

Throws:

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

AutomationException - If the ArcObject component throws an exception.