com.esri.arcgis.carto
Class IMxdServerProxy

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

All Implemented Interfaces:

IMxdServer, java.io.Externalizable, java.io.Serializable

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

Description: 'Provides access to members that support opening a map document and generating images of it.' 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 IMxdServerProxy
extends com.esri.arcgis.interop.Dispatch
implements IMxdServer, 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.IMxdServer

DISPID_0_NAME, DISPID_1_NAME, DISPID_10_NAME, DISPID_11_NAME, DISPID_12_NAME, DISPID_13_NAME, DISPID_14_NAME, DISPID_15_GET_NAME, DISPID_16_GET_NAME, DISPID_17_NAME, DISPID_2_NAME, DISPID_3_GET_NAME, DISPID_4_GET_NAME, DISPID_5_GET_NAME, DISPID_6_GET_NAME, DISPID_7_NAME, DISPID_8_NAME, DISPID_9_NAME, IID, IIDbd2e03fc_a244_46af_93ed_b522a090de89

Constructor Summary

	IMxdServerProxy() Deprecated. For internal use only
	IMxdServerProxy(java.lang.Object obj) Deprecated.
protected	IMxdServerProxy(java.lang.Object obj, java.lang.String iid) Deprecated.
	IMxdServerProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo) Deprecated.
protected	IMxdServerProxy(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.
IEnvelope	exportLayout(IArray mapDescriptors, int dpi, int imageWidth, int imageHeight, IEnvelope pageExtent, java.lang.String fileType, java.lang.String outputFileName) Deprecated. Generates an image of the layout, based on the given array of map descriptors, and writes the image to a specified file on disk.
void	exportLegend(ILegend legend, IMapDescriptor mapDescriptor, int dpi, int imageWidth, int imageHeight, IColor backgroundColor, java.lang.String fileType, java.lang.String outputFileName) Deprecated. Exports a legend to an image file.
IEnvelope	exportMapImage(IMapDescriptor mapDescriptor, int dpi, int imageWidth, int imageHeight, java.lang.String fileType, java.lang.String outputFileName) Deprecated. Generates an image of the map, based on the given map descriptor, and writes the image to the specified file on disk.
void	exportNorthArrow(INorthArrow arrow, int dpi, int imageWidth, int imageHeight, IColor backgroundColor, java.lang.String fileType, java.lang.String outputFileName) Deprecated. Exports a north arrow to an image file.
void	exportScaleBar(IScaleBar scalebar, int mapImageWidthPixels, int dpi, int imageWidth, int imageHeight, IColor backgroundColor, java.lang.String fileType, java.lang.String outputFileName) Deprecated. Exports a scale bar to an image file.
IEnumSpatialBookmark	getBookmarks(java.lang.String mapName) Deprecated. The spatial bookmarks saved with the specified map, if any.
java.lang.String	getDefaultMapName() Deprecated. The TOC Information.
java.lang.String	getFeatureValue(java.lang.String mapName, int layerID, IFeature feature, java.lang.String fieldName) Deprecated. The value of the specified field for the specified feature.
IArray	getLayerDescriptors(java.lang.String mapName) Deprecated. An array of LayerDescriptor objects for a given map name.
int	getMapBitmapHandle(IMapDescriptor mapDescriptor, int dpi, tagRECT pixelBounds) Deprecated. Generates a picture of the map, based on the given map descriptor, and returns an HBITMAP handle to the resulting image.
IArray	getMapDescriptors() Deprecated. An array of MapDescriptor objects, where each map descriptor describes the characteristics of a data frame in the document.
Picture	getMapPicture(IMapDescriptor mapDescriptor, int dpi, tagRECT pixelBounds) Deprecated. Generates a picture of the map, based on the given map descriptor, and returns the image as an IPictureDisp.
Picture	getThumbnail() Deprecated. The thumbnail image stored with the map document, if any.
IArray	getTOCInfo(java.lang.String mapName, int layerID) Deprecated. The TOC Information.
void	releaseBitmapHandle(int hBmp) Deprecated. Companion function to GetBitmapHandle().
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Deprecated.
void	start(java.lang.String mxdPath) Deprecated. Initializes the map server with an mxd file stored at the specified path.
void	startWithData(IDataset pDataset) Deprecated. An alternative to calling Start() with a document name, this method synthesizes a map document with a single layer based on the given IDataset object, and initializes the map server for processing.
void	stop() Deprecated. Clears out all of the map objects in memory.

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

IMxdServerProxy

public IMxdServerProxy(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

IMxdServerProxy

public IMxdServerProxy()

Deprecated.

For internal use only

IMxdServerProxy

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

Deprecated.

Throws:

java.io.IOException

IMxdServerProxy

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

Deprecated.

Throws:

java.io.IOException

IMxdServerProxy

protected IMxdServerProxy(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

start

public void start(java.lang.String mxdPath)
           throws java.io.IOException,
                  AutomationException

Deprecated.

Initializes the map server with an mxd file stored at the specified path. The path must be able to be located by the server machine.

Specified by:

start in interface IMxdServer

Parameters:

mxdPath - The mxdPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startWithData

public void startWithData(IDataset pDataset)
                   throws java.io.IOException,
                          AutomationException

Deprecated.

An alternative to calling Start() with a document name, this method synthesizes a map document with a single layer based on the given IDataset object, and initializes the map server for processing.

Specified by:

startWithData in interface IMxdServer

Parameters:

pDataset - A reference to a com.esri.arcgis.geodatabase.IDataset (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stop

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

Deprecated.

Clears out all of the map objects in memory. The client must call one of the Start methods again before attempting any other operations.

Specified by:

stop in interface IMxdServer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapDescriptors

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

Deprecated.

An array of MapDescriptor objects, where each map descriptor describes the characteristics of a data frame in the document. The properties of a map descriptor object can be altered in order to draw the map image with different state than the default.

Specified by:

getMapDescriptors in interface IMxdServer

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.

getLayerDescriptors

public IArray getLayerDescriptors(java.lang.String mapName)
                           throws java.io.IOException,
                                  AutomationException

Deprecated.

An array of LayerDescriptor objects for a given map name. Each layer descriptor describes the characteristics of a layer in the map. Default layer properties can be changed to change output.

Specified by:

getLayerDescriptors in interface IMxdServer

Parameters:

mapName - The mapName (in)

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.

getBookmarks

public IEnumSpatialBookmark getBookmarks(java.lang.String mapName)
                                  throws java.io.IOException,
                                         AutomationException

Deprecated.

The spatial bookmarks saved with the specified map, if any.

Specified by:

getBookmarks in interface IMxdServer

Parameters:

mapName - The mapName (in)

Returns:

A reference to a com.esri.arcgis.carto.IEnumSpatialBookmark

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getThumbnail

public Picture getThumbnail()
                     throws java.io.IOException,
                            AutomationException

Deprecated.

The thumbnail image stored with the map document, if any. If the document has no thumbnail stored with it, this method will return E_FAIL and the returned IPictureDisp object will be null.

Specified by:

getThumbnail in interface IMxdServer

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapPicture

public Picture getMapPicture(IMapDescriptor mapDescriptor,
                             int dpi,
                             tagRECT pixelBounds)
                      throws java.io.IOException,
                             AutomationException

Deprecated.

Generates a picture of the map, based on the given map descriptor, and returns the image as an IPictureDisp. If pMapDescriptor is null, it draws a picture of the default map at the default extent.

Specified by:

getMapPicture in interface IMxdServer

Parameters:

mapDescriptor - A reference to a com.esri.arcgis.carto.IMapDescriptor (in)

dpi - The dpi (in)

pixelBounds - A Structure: com.esri.arcgis.system.tagRECT (in)

Returns:

A reference to a com.esri.arcgis.support.ms.stdole.Picture (A com.esri.arcgis.support.ms.stdole.Picture COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapBitmapHandle

public int getMapBitmapHandle(IMapDescriptor mapDescriptor,
                              int dpi,
                              tagRECT pixelBounds)
                       throws java.io.IOException,
                              AutomationException

Deprecated.

Generates a picture of the map, based on the given map descriptor, and returns an HBITMAP handle to the resulting image. If you call this function, you absolutely MUST call ReleaseBitmapHandle() with the returned bitmap handle.

Specified by:

getMapBitmapHandle in interface IMxdServer

Parameters:

mapDescriptor - A reference to a com.esri.arcgis.carto.IMapDescriptor (in)

dpi - The dpi (in)

pixelBounds - A Structure: com.esri.arcgis.system.tagRECT (in)

Returns:

The hBmp (A COM typedef)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

releaseBitmapHandle

public void releaseBitmapHandle(int hBmp)
                         throws java.io.IOException,
                                AutomationException

Deprecated.

Companion function to GetBitmapHandle(). Releases the bitmap handle that is returned from that function.

Specified by:

releaseBitmapHandle in interface IMxdServer

Parameters:

hBmp - The hBmp (A COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

exportMapImage

public IEnvelope exportMapImage(IMapDescriptor mapDescriptor,
                                int dpi,
                                int imageWidth,
                                int imageHeight,
                                java.lang.String fileType,
                                java.lang.String outputFileName)
                         throws java.io.IOException,
                                AutomationException

Deprecated.

Generates an image of the map, based on the given map descriptor, and writes the image to the specified file on disk. Supported file types are: 'bmp', 'jpg', 'tif', 'png'/'png8', 'png24', 'emf' and 'pcx'.

Specified by:

exportMapImage in interface IMxdServer

Parameters:

mapDescriptor - A reference to a com.esri.arcgis.carto.IMapDescriptor (in)

dpi - The dpi (in)

imageWidth - The imageWidth (in)

imageHeight - The imageHeight (in)

fileType - The fileType (in)

outputFileName - The outputFileName (in)

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.

exportLayout

public IEnvelope exportLayout(IArray mapDescriptors,
                              int dpi,
                              int imageWidth,
                              int imageHeight,
                              IEnvelope pageExtent,
                              java.lang.String fileType,
                              java.lang.String outputFileName)
                       throws java.io.IOException,
                              AutomationException

Deprecated.

Generates an image of the layout, based on the given array of map descriptors, and writes the image to a specified file on disk. Supported Image types are: 'bmp', 'jpg', 'tif', 'png', 'emf', 'eps', 'pdf', 'ai', 'pcx'.

Specified by:

exportLayout in interface IMxdServer

Parameters:

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

dpi - The dpi (in)

imageWidth - The imageWidth (in)

imageHeight - The imageHeight (in)

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

fileType - The fileType (in)

outputFileName - The outputFileName (in)

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.

exportLegend

public void exportLegend(ILegend legend,
                         IMapDescriptor mapDescriptor,
                         int dpi,
                         int imageWidth,
                         int imageHeight,
                         IColor backgroundColor,
                         java.lang.String fileType,
                         java.lang.String outputFileName)
                  throws java.io.IOException,
                         AutomationException

Deprecated.

Exports a legend to an image file. The client can create the pLegend object and set its desired properties appropriately. If pLegend is null, a default legend for the default map will be generated.

Specified by:

exportLegend in interface IMxdServer

Parameters:

legend - A reference to a com.esri.arcgis.carto.ILegend (in)

mapDescriptor - A reference to a com.esri.arcgis.carto.IMapDescriptor (in)

dpi - The dpi (in)

imageWidth - The imageWidth (in)

imageHeight - The imageHeight (in)

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

fileType - The fileType (in)

outputFileName - The outputFileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

exportScaleBar

public void exportScaleBar(IScaleBar scalebar,
                           int mapImageWidthPixels,
                           int dpi,
                           int imageWidth,
                           int imageHeight,
                           IColor backgroundColor,
                           java.lang.String fileType,
                           java.lang.String outputFileName)
                    throws java.io.IOException,
                           AutomationException

Deprecated.

Exports a scale bar to an image file. The client can create the pScaleBar object and set its desired properties appropriately. If pScaleBar is null, a default scale bar will be generated for the default map.

Specified by:

exportScaleBar in interface IMxdServer

Parameters:

scalebar - A reference to a com.esri.arcgis.carto.IScaleBar (in)

mapImageWidthPixels - The mapImageWidthPixels (in)

dpi - The dpi (in)

imageWidth - The imageWidth (in)

imageHeight - The imageHeight (in)

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

fileType - The fileType (in)

outputFileName - The outputFileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

exportNorthArrow

public void exportNorthArrow(INorthArrow arrow,
                             int dpi,
                             int imageWidth,
                             int imageHeight,
                             IColor backgroundColor,
                             java.lang.String fileType,
                             java.lang.String outputFileName)
                      throws java.io.IOException,
                             AutomationException

Deprecated.

Exports a north arrow to an image file. The client can create the pArrow object and set its desired properties appropriately. If pArrow is null, a default north arrow will be generated for the default map.

Specified by:

exportNorthArrow in interface IMxdServer

Parameters:

arrow - A reference to a com.esri.arcgis.carto.INorthArrow (in)

dpi - The dpi (in)

imageWidth - The imageWidth (in)

imageHeight - The imageHeight (in)

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

fileType - The fileType (in)

outputFileName - The outputFileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTOCInfo

public IArray getTOCInfo(java.lang.String mapName,
                         int layerID)
                  throws java.io.IOException,
                         AutomationException

Deprecated.

The TOC Information.

Specified by:

getTOCInfo in interface IMxdServer

Parameters:

mapName - The mapName (in)

layerID - The layerID (in)

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.

getDefaultMapName

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

Deprecated.

The TOC Information.

Specified by:

getDefaultMapName in interface IMxdServer

Returns:

The mapName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFeatureValue

public java.lang.String getFeatureValue(java.lang.String mapName,
                                        int layerID,
                                        IFeature feature,
                                        java.lang.String fieldName)
                                 throws java.io.IOException,
                                        AutomationException

Deprecated.

The value of the specified field for the specified feature.

Specified by:

getFeatureValue in interface IMxdServer

Parameters:

mapName - The mapName (in)

layerID - The layerID (in)

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

fieldName - The fieldName (in)

Returns:

The fieldValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.