com.esri.arcgis.carto
Class IGlobeDocumentProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.carto.IGlobeDocumentProxy
All Implemented Interfaces:
IGlobeDocument, java.io.Externalizable, java.io.Serializable

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

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 IGlobeDocumentProxy
extends com.esri.arcgis.interop.Dispatch
implements IGlobeDocument, 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.IGlobeDocument
IID, IIDd2bcaf32_541c_4965_9980_aae56ab3a964
 
Constructor Summary
  IGlobeDocumentProxy()
          Deprecated. For internal use only
  IGlobeDocumentProxy(java.lang.Object obj)
          Deprecated.  
protected IGlobeDocumentProxy(java.lang.Object obj, java.lang.String iid)
          Deprecated.  
  IGlobeDocumentProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
          Deprecated.  
protected IGlobeDocumentProxy(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 globe document.
 void esri_new(java.lang.String bsDocument)
          Deprecated. Creates and opens a new globe document in preparation for the contents to be retrieve or updated.
 java.lang.String getDocumentFilename()
          Deprecated. The globe document filename that the GlobeDocument coclass is linked to.
 int getDocumentType()
          Deprecated. The type of globe document currently loaded in the object.
 int getDocumentVersion()
          Deprecated. Indicates if the version of the globe document is compatible with the current version of software.
 java.lang.Object getGlobeObject()
          Deprecated. The Globe object.
 ILayer getLayer(int lLayerIndex)
          Deprecated. The Layer object at the specified index.
 int getLayerCount()
          Deprecated. The number of Layer objects contained within the globe document.
 IPicture getThumbnail()
          Deprecated. The thumbnail stored in the globe document.
 void getVersionInfo(boolean[] pbVersionInfoMissing, int[] plMajor, int[] plMinor, int[] plRevision, int[] plBuild)
          Deprecated. Retrieve the detailed version information of the globe document.
 boolean isGlobeDocument(java.lang.String bsDocument)
          Deprecated. Indicates if the globe document is a valid globe document.
 boolean isPasswordProtected(java.lang.String bsDocument)
          Deprecated. Indicates if the globe document is protected by a passsword.
 boolean isPresent(java.lang.String bsDocument)
          Deprecated. Indicates if the globe document is present.
 boolean isReadOnly(java.lang.String bsDocument)
          Deprecated. Indicates if the globe document is read only.
 boolean isRestricted(java.lang.String bsDocument)
          Deprecated. Indicates if the use of the globe document is restricted to certain applications.
 boolean isUsesRelativePaths()
          Deprecated. Indicates if the data in the globe document is referenced using relative paths.
 void open(java.lang.String bsDocument, java.lang.String bsPassword)
          Deprecated. Open the globe document in preparation for the contents to be retrieved or updated.
 void removeListener(java.lang.String iidStr, java.lang.Object theListener)
          Deprecated.  
 void save(boolean bUseRelativePaths, boolean bCreateThumnbail)
          Deprecated. Save the contents of the globe document to the bound file.
 void saveAs(java.lang.String bsDocument, boolean bUseRelativePaths, boolean bCreateThumnbail)
          Deprecated. Save the contents of the globe document to the specified file name.
 void setGlobeObject(java.lang.Object ppUnk)
          Deprecated. The Globe object.
 
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

IGlobeDocumentProxy

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

IGlobeDocumentProxy

public IGlobeDocumentProxy()
Deprecated. 
For internal use only


IGlobeDocumentProxy

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

IGlobeDocumentProxy

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

IGlobeDocumentProxy

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

isGlobeDocument

public boolean isGlobeDocument(java.lang.String bsDocument)
                        throws java.io.IOException,
                               AutomationException
Deprecated. 
Indicates if the globe document is a valid globe document.

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

isPresent

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

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

isReadOnly

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

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

isRestricted

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

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

isPasswordProtected

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

Specified by:
isPasswordProtected in interface IGlobeDocument
Parameters:
bsDocument - The bsDocument (in)
Returns:
The pbIsPasswordProtected
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 bsDocument)
              throws java.io.IOException,
                     AutomationException
Deprecated. 
Creates and opens a new globe document in preparation for the contents to be retrieve or updated.

Specified by:
esri_new in interface IGlobeDocument
Parameters:
bsDocument - The bsDocument (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 bsDocument,
                 java.lang.String bsPassword)
          throws java.io.IOException,
                 AutomationException
Deprecated. 
Open the globe document in preparation for the contents to be retrieved or updated.

Specified by:
open in interface IGlobeDocument
Parameters:
bsDocument - The bsDocument (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 globe document filename that the GlobeDocument coclass is linked to.

Specified by:
getDocumentFilename in interface IGlobeDocument
Returns:
The pbsDocument
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 globe document currently loaded in the object.

Specified by:
getDocumentType in interface IGlobeDocument
Returns:
A com.esri.arcgis.carto.esriGlobeDocumentType 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 globe document is referenced using relative paths.

Specified by:
isUsesRelativePaths in interface IGlobeDocument
Returns:
The pbUsesRelativePaths
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 globe document is compatible with the current version of software.

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

setGlobeObject

public void setGlobeObject(java.lang.Object ppUnk)
                    throws java.io.IOException,
                           AutomationException
Deprecated. 
The Globe object.

Specified by:
setGlobeObject in interface IGlobeDocument
Parameters:
ppUnk - A reference to another Object (IUnknown) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGlobeObject

public java.lang.Object getGlobeObject()
                                throws java.io.IOException,
                                       AutomationException
Deprecated. 
The Globe object.

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

getLayerCount

public int getLayerCount()
                  throws java.io.IOException,
                         AutomationException
Deprecated. 
The number of Layer objects contained within the globe document.

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

getLayer

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

Specified by:
getLayer in interface IGlobeDocument
Parameters:
lLayerIndex - The lLayerIndex (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.

getThumbnail

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

Specified by:
getThumbnail in interface IGlobeDocument
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 globe document.

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

getVersionInfo

public void getVersionInfo(boolean[] pbVersionInfoMissing,
                           int[] plMajor,
                           int[] plMinor,
                           int[] plRevision,
                           int[] plBuild)
                    throws java.io.IOException,
                           AutomationException
Deprecated. 
Retrieve the detailed version information of the globe document.

Specified by:
getVersionInfo in interface IGlobeDocument
Parameters:
pbVersionInfoMissing - The pbVersionInfoMissing (in/out: use single element array)
plMajor - The plMajor (in/out: use single element array)
plMinor - The plMinor (in/out: use single element array)
plRevision - The plRevision (in/out: use single element array)
plBuild - The plBuild (in/out: use single element array)
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 globe document to the bound file.

Specified by:
save in interface IGlobeDocument
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 bsDocument,
                   boolean bUseRelativePaths,
                   boolean bCreateThumnbail)
            throws java.io.IOException,
                   AutomationException
Deprecated. 
Save the contents of the globe document to the specified file name.

Specified by:
saveAs in interface IGlobeDocument
Parameters:
bsDocument - The bsDocument (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.