Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.carto
Class IMapDocumentProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.carto.IMapDocumentProxy
All Implemented Interfaces:
IMapDocument, java.io.Externalizable, java.io.Serializable
Deprecated. Internal use only. Proxy for COM Interface 'IMapDocument'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the reading and writing of map document files.' 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 IMapDocumentProxy
extends com.esri.arcgis.interop.Dispatch
implements IMapDocument, 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.IMapDocument
IID, IID5366451c_a001_4179_b8cb_e8f014628a44
 
Constructor Summary
  IMapDocumentProxy()
          Deprecated. For internal use only
  IMapDocumentProxy(java.lang.Object obj)
          Deprecated.  
protected IMapDocumentProxy(java.lang.Object obj, java.lang.String iid)
          Deprecated.  
  IMapDocumentProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
          Deprecated.  
protected IMapDocumentProxy(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 close()
          Deprecated. Close the map document.
 void esri_new(java.lang.String sDocument)
          Deprecated. Creates and opens a new map document in preparation for the contents to be retrieve or updated.
 IActiveView getActiveView()
          Deprecated. The ActiveView of the map document.
 java.lang.String getDocumentFilename()
          Deprecated. The map document filename that the MapDocument coclass is linked to.
 int getDocumentType()
          Deprecated. The type of map document currently loaded in the object.
 int getDocumentVersion()
          Deprecated. Indicates if the version of the map document is compatible with the current version of software.
 ILayer getLayer(int mapIndex, int layerIndex)
          Deprecated. The Layer object at the specified index for the specified map.
 IMap getMap(int mapIndex)
          Deprecated. The Map object at the specified index.
 int getMapCount()
          Deprecated. The number of Map objects contained within the map document.
 IPageLayout getPageLayout()
          Deprecated. The PageLayout object.
 IPrinter getPrinter()
          Deprecated. The printer object.
 IPicture getThumbnail()
          Deprecated. The thumbnail stored in the map document.
 void getVersionInfo(boolean[] versionInfoMissing, int[] lMajor, int[] lMinor, int[] lRevision, int[] lBuild)
          Deprecated. Retrieve the detailed version information of the map document.
 boolean isMapDocument(java.lang.String sDocument)
          Deprecated. Indicates if the map document is a valid map document.
 boolean isPasswordProtected(java.lang.String sDocument)
          Deprecated. Indicates if the map document is protected by a passsword.
 boolean isPresent(java.lang.String sDocument)
          Deprecated. Indicates if the map document is present.
 boolean isReadOnly(java.lang.String sDocument)
          Deprecated. Indicates if the map document is read only.
 boolean isRestricted(java.lang.String sDocument)
          Deprecated. Indicates if the use of the map document is restricted to certain applications.
 boolean isUsesRelativePaths()
          Deprecated. Indicates if the data in the map document is referenced using relative paths.
 void open(java.lang.String sDocument, java.lang.String bsPassword)
          Deprecated. Open the map document in preparation for the contents to be retrieve or updated.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
          Deprecated.  
 void replaceContents(IMxdContents pObject)
          Deprecated. Replace the contents of the map document.
 void save(boolean bUseRelativePaths, boolean bCreateThumnbail)
          Deprecated. Save the contents of the map document to the bound file.
 void saveAs(java.lang.String sDocument, boolean bUseRelativePaths, boolean bCreateThumnbail)
          Deprecated. Save the contents of the map document to the specified file name.
 void setActiveView(IActiveView pActiveView)
          Deprecated. Set the ActiveView content of the map document.
 
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

IMapDocumentProxy

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

IMapDocumentProxy

public IMapDocumentProxy()
Deprecated. 
For internal use only

IMapDocumentProxy

public IMapDocumentProxy(java.lang.Object obj)
                  throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException

IMapDocumentProxy

protected IMapDocumentProxy(java.lang.Object obj,
                            java.lang.String iid)
                     throws java.io.IOException
Deprecated. 
Throws:
java.io.IOException

IMapDocumentProxy

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

isMapDocument

public boolean isMapDocument(java.lang.String sDocument)
                      throws java.io.IOException,
                             AutomationException
Deprecated. 
Indicates if the map document is a valid map document.

Specified by:
isMapDocument in interface IMapDocument
Parameters:
sDocument - The sDocument (in)
Returns:
The isMapDocument
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPresent

public boolean isPresent(java.lang.String sDocument)
                  throws java.io.IOException,
                         AutomationException
Deprecated. 
Indicates if the map document is present.

Specified by:
isPresent in interface IMapDocument
Parameters:
sDocument - The sDocument (in)
Returns:
The isPresent
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReadOnly

public boolean isReadOnly(java.lang.String sDocument)
                   throws java.io.IOException,
                          AutomationException
Deprecated. 
Indicates if the map document is read only.

Specified by:
isReadOnly in interface IMapDocument
Parameters:
sDocument - The sDocument (in)
Returns:
The isReadOnly
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRestricted

public boolean isRestricted(java.lang.String sDocument)
                     throws java.io.IOException,
                            AutomationException
Deprecated. 
Indicates if the use of the map document is restricted to certain applications.

Specified by:
isRestricted in interface IMapDocument
Parameters:
sDocument - The sDocument (in)
Returns:
The isRestricted
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPasswordProtected

public boolean isPasswordProtected(java.lang.String sDocument)
                            throws java.io.IOException,
                                   AutomationException
Deprecated. 
Indicates if the map document is protected by a passsword.

Specified by:
isPasswordProtected in interface IMapDocument
Parameters:
sDocument - The sDocument (in)
Returns:
The isPasswordProtected
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_new

public void esri_new(java.lang.String sDocument)
              throws java.io.IOException,
                     AutomationException
Deprecated. 
Creates and opens a new map document in preparation for the contents to be retrieve or updated.

Specified by:
esri_new in interface IMapDocument
Parameters:
sDocument - The sDocument (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

open

public void open(java.lang.String sDocument,
                 java.lang.String bsPassword)
          throws java.io.IOException,
                 AutomationException
Deprecated. 
Open the map document in preparation for the contents to be retrieve or updated.

Specified by:
open in interface IMapDocument
Parameters:
sDocument - The sDocument (in)
bsPassword - The bsPassword (in, optional, pass if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDocumentFilename

public java.lang.String getDocumentFilename()
                                     throws java.io.IOException,
                                            AutomationException
Deprecated. 
The map document filename that the MapDocument coclass is linked to.

Specified by:
getDocumentFilename in interface IMapDocument
Returns:
The sDocument
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDocumentType

public int getDocumentType()
                    throws java.io.IOException,
                           AutomationException
Deprecated. 
The type of map document currently loaded in the object.

Specified by:
getDocumentType in interface IMapDocument
Returns:
A com.esri.arcgis.carto.esriMapDocumentType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUsesRelativePaths

public boolean isUsesRelativePaths()
                            throws java.io.IOException,
                                   AutomationException
Deprecated. 
Indicates if the data in the map document is referenced using relative paths.

Specified by:
isUsesRelativePaths in interface IMapDocument
Returns:
The bUsesRelativePaths
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDocumentVersion

public int getDocumentVersion()
                       throws java.io.IOException,
                              AutomationException
Deprecated. 
Indicates if the version of the map document is compatible with the current version of software.

Specified by:
getDocumentVersion in interface IMapDocument
Returns:
A com.esri.arcgis.carto.esriMapDocumentVersionInfo constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPageLayout

public IPageLayout getPageLayout()
                          throws java.io.IOException,
                                 AutomationException
Deprecated. 
The PageLayout object.

Specified by:
getPageLayout in interface IMapDocument
Returns:
A reference to a com.esri.arcgis.carto.IPageLayout
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActiveView

public IActiveView getActiveView()
                          throws java.io.IOException,
                                 AutomationException
Deprecated. 
The ActiveView of the map document.

Specified by:
getActiveView in interface IMapDocument
Returns:
A reference to a com.esri.arcgis.carto.IActiveView
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapCount

public int getMapCount()
                throws java.io.IOException,
                       AutomationException
Deprecated. 
The number of Map objects contained within the map document.

Specified by:
getMapCount in interface IMapDocument
Returns:
The mapCount
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMap

public IMap getMap(int mapIndex)
            throws java.io.IOException,
                   AutomationException
Deprecated. 
The Map object at the specified index.

Specified by:
getMap in interface IMapDocument
Parameters:
mapIndex - The mapIndex (in)
Returns:
A reference to a com.esri.arcgis.carto.IMap
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer(int mapIndex,
                       int layerIndex)
                throws java.io.IOException,
                       AutomationException
Deprecated. 
The Layer object at the specified index for the specified map.

Specified by:
getLayer in interface IMapDocument
Parameters:
mapIndex - The mapIndex (in)
layerIndex - The layerIndex (in)
Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPrinter

public IPrinter getPrinter()
                    throws java.io.IOException,
                           AutomationException
Deprecated. 
The printer object. If no printer object is stored in the map document this returns NULL.

Specified by:
getPrinter in interface IMapDocument
Returns:
A reference to a com.esri.arcgis.output.IPrinter
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getThumbnail

public IPicture getThumbnail()
                      throws java.io.IOException,
                             AutomationException
Deprecated. 
The thumbnail stored in the map document. If this is empty E_FAIL is returned.

Specified by:
getThumbnail in interface IMapDocument
Returns:
A reference to a com.esri.arcgis.support.ms.stdole.IPicture
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

close

public void close()
           throws java.io.IOException,
                  AutomationException
Deprecated. 
Close the map document.

Specified by:
close in interface IMapDocument
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVersionInfo

public void getVersionInfo(boolean[] versionInfoMissing,
                           int[] lMajor,
                           int[] lMinor,
                           int[] lRevision,
                           int[] lBuild)
                    throws java.io.IOException,
                           AutomationException
Deprecated. 
Retrieve the detailed version information of the map document.

Specified by:
getVersionInfo in interface IMapDocument
Parameters:
versionInfoMissing - The versionInfoMissing (in/out: use single element array)
lMajor - The lMajor (in/out: use single element array)
lMinor - The lMinor (in/out: use single element array)
lRevision - The lRevision (in/out: use single element array)
lBuild - The lBuild (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

replaceContents

public void replaceContents(IMxdContents pObject)
                     throws java.io.IOException,
                            AutomationException
Deprecated. 
Replace the contents of the map document.

Specified by:
replaceContents in interface IMapDocument
Parameters:
pObject - A reference to a com.esri.arcgis.carto.IMxdContents (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setActiveView

public void setActiveView(IActiveView pActiveView)
                   throws java.io.IOException,
                          AutomationException
Deprecated. 
Set the ActiveView content of the map document.

Specified by:
setActiveView in interface IMapDocument
Parameters:
pActiveView - A reference to a com.esri.arcgis.carto.IActiveView (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(boolean bUseRelativePaths,
                 boolean bCreateThumnbail)
          throws java.io.IOException,
                 AutomationException
Deprecated. 
Save the contents of the map document to the bound file.

Specified by:
save in interface IMapDocument
Parameters:
bUseRelativePaths - The bUseRelativePaths (in, optional, pass true if not required)
bCreateThumnbail - The bCreateThumnbail (in, optional, pass true if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveAs

public void saveAs(java.lang.String sDocument,
                   boolean bUseRelativePaths,
                   boolean bCreateThumnbail)
            throws java.io.IOException,
                   AutomationException
Deprecated. 
Save the contents of the map document to the specified file name.

Specified by:
saveAs in interface IMapDocument
Parameters:
sDocument - The sDocument (in)
bUseRelativePaths - The bUseRelativePaths (in, optional, pass true if not required)
bCreateThumnbail - The bCreateThumnbail (in, optional, pass true if not required)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD