com.esri.arcgis.arcglobe
Class IGMxDocumentInfoProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.arcglobe.IGMxDocumentInfoProxy
All Implemented Interfaces:
IGMxDocumentInfo, Externalizable, Serializable

public class IGMxDocumentInfoProxy
extends com.esri.arcgis.interop.Dispatch
implements IGMxDocumentInfo, Serializable

Provides access to members that control the ArcGlobe document information.

Description

All globe documents have properties, which provide information about the document, such as title of the document, the author etc. The IGMxDocumentInfo interface provides such properties for entering the globe document metadata.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

See Also:
Serialized Form

Field Summary
 boolean noncastable
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Constructor Summary
  IGMxDocumentInfoProxy()
           
  IGMxDocumentInfoProxy(Object obj)
           
protected IGMxDocumentInfoProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 String getAuthor()
          The author of the document.
 String getCategory()
          The category of the document.
 String getComments()
          The comments for the document.
 String getDocumentTitle()
          The title of the document.
 String getHyperlinkBase()
          The hyperlink base of the document.
 String getKeywords()
          The keywords for the document.
 String getSubject()
          The subject of the document.
 void removeListener(String iidStr, Object theListener)
           
 void setAuthor(String author)
          The author of the document.
 void setCategory(String category)
          The category of the document.
 void setComments(String comments)
          The comments for the document.
 void setDocumentTitle(String title)
          The title of the document.
 void setHyperlinkBase(String path)
          The hyperlink base of the document.
 void setKeywords(String keywords)
          The keywords for the document.
 void setSubject(String subject)
          The subject of the 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

noncastable

public boolean noncastable
Constructor Detail

IGMxDocumentInfoProxy

public IGMxDocumentInfoProxy()

IGMxDocumentInfoProxy

public IGMxDocumentInfoProxy(Object obj)
                      throws IOException
Throws:
IOException

IGMxDocumentInfoProxy

protected IGMxDocumentInfoProxy(Object obj,
                                String iid)
                         throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getDocumentTitle

public String getDocumentTitle()
                        throws IOException,
                               AutomationException
The title of the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
getDocumentTitle in interface IGMxDocumentInfo
Returns:
The title
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDocumentTitle

public void setDocumentTitle(String title)
                      throws IOException,
                             AutomationException
The title of the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
setDocumentTitle in interface IGMxDocumentInfo
Parameters:
title - The title (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSubject

public String getSubject()
                  throws IOException,
                         AutomationException
The subject of the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
getSubject in interface IGMxDocumentInfo
Returns:
The subject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSubject

public void setSubject(String subject)
                throws IOException,
                       AutomationException
The subject of the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
setSubject in interface IGMxDocumentInfo
Parameters:
subject - The subject (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAuthor

public String getAuthor()
                 throws IOException,
                        AutomationException
The author of the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
getAuthor in interface IGMxDocumentInfo
Returns:
The author
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAuthor

public void setAuthor(String author)
               throws IOException,
                      AutomationException
The author of the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
setAuthor in interface IGMxDocumentInfo
Parameters:
author - The author (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

public String getCategory()
                   throws IOException,
                          AutomationException
The category of the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
getCategory in interface IGMxDocumentInfo
Returns:
The category
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(String category)
                 throws IOException,
                        AutomationException
The category of the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
setCategory in interface IGMxDocumentInfo
Parameters:
category - The category (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getComments

public String getComments()
                   throws IOException,
                          AutomationException
The comments for the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
getComments in interface IGMxDocumentInfo
Returns:
The comments
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setComments

public void setComments(String comments)
                 throws IOException,
                        AutomationException
The comments for the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
setComments in interface IGMxDocumentInfo
Parameters:
comments - The comments (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getKeywords

public String getKeywords()
                   throws IOException,
                          AutomationException
The keywords for the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
getKeywords in interface IGMxDocumentInfo
Returns:
The keywords
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKeywords

public void setKeywords(String keywords)
                 throws IOException,
                        AutomationException
The keywords for the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
setKeywords in interface IGMxDocumentInfo
Parameters:
keywords - The keywords (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHyperlinkBase

public String getHyperlinkBase()
                        throws IOException,
                               AutomationException
The hyperlink base of the document.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
getHyperlinkBase in interface IGMxDocumentInfo
Returns:
The path
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHyperlinkBase

public void setHyperlinkBase(String path)
                      throws IOException,
                             AutomationException
The hyperlink base of the document.

Remarks

The HyperlinkBase property specifies the root Web address for hyperlink fields. For example, you can set a globe documentís HyperlinkBase property to http://arcgisdeveloperonline.esri.com/ and a Web-linked field on a feature to "ArcGISDeveloper". When you turn on field Hyperlinks for a layer and use the Hyperlink tool, the two are put together, and http://arcgisdeveloperonline.esri.com/ArcGISDeveloper becomes the hyperlink.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Specified by:
setHyperlinkBase in interface IGMxDocumentInfo
Parameters:
path - The path (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.