com.esri.arcgis.carto
Interface IGlobeDocument

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GlobeDocument, IGlobeDocumentProxy

public interface IGlobeDocument
extends java.io.Serializable

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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDd2bcaf32_541c_4965_9980_aae56ab3a964
static int	xxDummy Deprecated. Internal use only

Method Summary

void	close() Close the globe document.
void	esri_new(java.lang.String bsDocument) Creates and opens a new globe document in preparation for the contents to be retrieve or updated.
java.lang.String	getDocumentFilename() The globe document filename that the GlobeDocument coclass is linked to.
int	getDocumentType() The type of globe document currently loaded in the object.
int	getDocumentVersion() Indicates if the version of the globe document is compatible with the current version of software.
java.lang.Object	getGlobeObject() The Globe object.
ILayer	getLayer(int lLayerIndex) The Layer object at the specified index.
int	getLayerCount() The number of Layer objects contained within the globe document.
IPicture	getThumbnail() The thumbnail stored in the globe document.
void	getVersionInfo(boolean[] pbVersionInfoMissing, int[] plMajor, int[] plMinor, int[] plRevision, int[] plBuild) Retrieve the detailed version information of the globe document.
boolean	isGlobeDocument(java.lang.String bsDocument) Indicates if the globe document is a valid globe document.
boolean	isPasswordProtected(java.lang.String bsDocument) Indicates if the globe document is protected by a passsword.
boolean	isPresent(java.lang.String bsDocument) Indicates if the globe document is present.
boolean	isReadOnly(java.lang.String bsDocument) Indicates if the globe document is read only.
boolean	isRestricted(java.lang.String bsDocument) Indicates if the use of the globe document is restricted to certain applications.
boolean	isUsesRelativePaths() Indicates if the data in the globe document is referenced using relative paths.
void	open(java.lang.String bsDocument, java.lang.String bsPassword) Open the globe document in preparation for the contents to be retrieved or updated.
void	save(boolean bUseRelativePaths, boolean bCreateThumnbail) Save the contents of the globe document to the bound file.
void	saveAs(java.lang.String bsDocument, boolean bUseRelativePaths, boolean bCreateThumnbail) Save the contents of the globe document to the specified file name.
void	setGlobeObject(java.lang.Object ppUnk) The Globe object.

Field Detail

IIDd2bcaf32_541c_4965_9980_aae56ab3a964

static final int IIDd2bcaf32_541c_4965_9980_aae56ab3a964

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

Method Detail

isGlobeDocument

boolean isGlobeDocument(java.lang.String bsDocument)
                        throws java.io.IOException,
                               AutomationException

Indicates if the globe document is a valid globe document.

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

boolean isPresent(java.lang.String bsDocument)
                  throws java.io.IOException,
                         AutomationException

Indicates if the globe document is present.

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

boolean isReadOnly(java.lang.String bsDocument)
                   throws java.io.IOException,
                          AutomationException

Indicates if the globe document is read only.

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

boolean isRestricted(java.lang.String bsDocument)
                     throws java.io.IOException,
                            AutomationException

Indicates if the use of the globe document is restricted to certain applications.

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

boolean isPasswordProtected(java.lang.String bsDocument)
                            throws java.io.IOException,
                                   AutomationException

Indicates if the globe document is protected by a passsword.

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

void esri_new(java.lang.String bsDocument)
              throws java.io.IOException,
                     AutomationException

Creates and opens a new globe document in preparation for the contents to be retrieve or updated.

Parameters:

bsDocument - The bsDocument (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

open

void open(java.lang.String bsDocument,
          java.lang.String bsPassword)
          throws java.io.IOException,
                 AutomationException

Open the globe document in preparation for the contents to be retrieved or updated.

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

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

The globe document filename that the GlobeDocument coclass is linked to.

Returns:

The pbsDocument

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDocumentType

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

The type of globe document currently loaded in the object.

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

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

Indicates if the data in the globe document is referenced using relative paths.

Returns:

The pbUsesRelativePaths

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDocumentVersion

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

Indicates if the version of the globe document is compatible with the current version of software.

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

void setGlobeObject(java.lang.Object ppUnk)
                    throws java.io.IOException,
                           AutomationException

The Globe object.

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

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

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

getLayerCount

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

The number of Layer objects contained within the globe document.

Returns:

The plLayerCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayer

ILayer getLayer(int lLayerIndex)
                throws java.io.IOException,
                       AutomationException

The Layer object at the specified index.

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

IPicture getThumbnail()
                      throws java.io.IOException,
                             AutomationException

The thumbnail stored in the globe document. If this is empty E_FAIL is returned.

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

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

Close the globe document.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVersionInfo

void getVersionInfo(boolean[] pbVersionInfoMissing,
                    int[] plMajor,
                    int[] plMinor,
                    int[] plRevision,
                    int[] plBuild)
                    throws java.io.IOException,
                           AutomationException

Retrieve the detailed version information of the globe document.

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

void save(boolean bUseRelativePaths,
          boolean bCreateThumnbail)
          throws java.io.IOException,
                 AutomationException

Save the contents of the globe document to the bound file.

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

void saveAs(java.lang.String bsDocument,
            boolean bUseRelativePaths,
            boolean bCreateThumnbail)
            throws java.io.IOException,
                   AutomationException

Save the contents of the globe document to the specified file name.

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.