com.esri.arcgis.arcglobe
Class GMxDocument

java.lang.Object
  com.esri.arcgis.arcglobe.GMxDocument

All Implemented Interfaces:

IGMxDocument, IGMxDocumentInfo, IBasicDocument2, IBasicDocumentDefaultSymbols, IContentsViewEdit, IDocumentDefaultSymbols, IDocument3DDefaultSymbols, IDataGraphCollection, IDocumentInfo2, IDocumentPreview, IDocumentDatasets, IDocument, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersion, java.io.Serializable

public class GMxDocument
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDocument, IBasicDocument2, IGMxDocument, IGMxDocumentInfo, IDocumentDatasets, IDocumentDefaultSymbols, IDocument3DDefaultSymbols, IContentsViewEdit, IDocumentVersion, IDocumentInfo2, IDocumentPreview, IDataGraphCollection

COM Class 'GMxDocument'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriArcGlobe.olb'

Description 'Provides access to members that control the ArcGlobe document.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.framework.IDocument

DISPID_0_GET_NAME, DISPID_1_GET_NAME, DISPID_2_GET_NAME, DISPID_4_GET_NAME, DISPID_5_GET_NAME, DISPID_6_GET_NAME, DISPID_7_GET_NAME, IID, IID3e927177_307a_11d2_94c9_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.arcmapui.IBasicDocument2

IID, IIDef2ec034_c197_48a0_90ee_c6b7db797eb8, xxDummy

Fields inherited from interface com.esri.arcgis.arcglobe.IGMxDocument

IID, IIDb461cddf_216d_11d6_b2b3_00508bcdde28, xxDummy

Fields inherited from interface com.esri.arcgis.arcglobe.IGMxDocumentInfo

IID, IIDb461cdd3_216d_11d6_b2b3_00508bcdde28, xxDummy

Fields inherited from interface com.esri.arcgis.catalogUI.IDocumentDatasets

IID, IID7bfce4b1_1228_11d4_9fec_00c04f6bc78e, xxDummy

Fields inherited from interface com.esri.arcgis.arcmapui.IDocumentDefaultSymbols

IID, IID85961926_d8e9_11d3_9ff5_00c04f6bc8dd, xxDummy

Fields inherited from interface com.esri.arcgis.arcscene.IDocument3DDefaultSymbols

IID, IID846a792e_1b96_4350_8bcc_b10f7c5012a7, xxDummy

Fields inherited from interface com.esri.arcgis.arcmapui.IBasicDocumentDefaultSymbols

IIDbaf98c1c_6e13_11d4_ab81_0008c73fd50c

Fields inherited from interface com.esri.arcgis.arcmapui.IContentsViewEdit

IID, IIDb0f32eaf_ebdb_11d3_9fdb_00c04f6bc78e, xxDummy

Fields inherited from interface com.esri.arcgis.system.IDocumentVersion

IID, IIDecc43c55_0148_4ec1_bf87_b9a183c5dc98, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IDocumentInfo2

IID, IIDd3e5c54f_2a84_11d4_9ff2_00c04f6bc78e, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IDocumentPreview

IID, IIDefe86eff_4c92_47b8_af1b_2d7ded932e24, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IDataGraphCollection

IID, IID5c68acbe_4517_4c11_97a1_e3c7edb0c3bb, xxDummy

Constructor Summary

GMxDocument()
Constructs a GMxDocument using ArcGIS Engine.

GMxDocument(java.lang.Object obj)
Construct a GMxDocument using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

void	addContentsView(IContentsView contentsView) Adds a contents view object to the TOC.
void	addDataGraph(IDataGraphBase graph) Adds the graph to the collection.
void	addIDataGraphCollectionEventsListener(IDataGraphCollectionEvents theListener) addIDataGraphCollectionEventsListener.
void	addIGMxDocumentEventsDispListener(IGMxDocumentEventsDisp theListener) addIGMxDocumentEventsDispListener.
void	addIGMxDocumentEventsListener(IGMxDocumentEvents theListener) addIGMxDocumentEventsListener.
void	addLayer(ILayer pLayer) Adds a layer to the current focus map or scene.
void	clearContentsViews() Removes all current contents views.
void	createPreview() Creates a thumbnail preview of the document.
void	deletePreview() Deletes the thumbnail preview of the document.
boolean	equals(java.lang.Object o) Compare this object with another
IAcceleratorTable	getAccelerators() The accelerator table for this document.
IActiveView	getActivatedView() The activated view.
IAreaPatch	getAreaPatch() Default Area Patch.
java.lang.String	getAuthor() The author of the document.
IFormattedTextSymbol	getCallout() Default Callout.
java.lang.String	getCategory() The category of the document.
static java.lang.String	getClsid() getClsid.
ICommandBars	getCommandBars() The commandbars collection in this document.
java.lang.String	getComments() The comments for the document.
IContentsView2	getContentsView(int index) The contents view at the specified index.
int	getContentsViewCount() The number of contents views in the document.
java.lang.Object	getContextItem() The last item that was right-clicked.
java.lang.String	getCredits() The credits of the document.
IContentsView2	getCurrentContentsView() The current contents view of the document.
IPoint	getCurrentLocation() The current mouse location in map units.
Font	getCustomTOCFont() Custom TOC Font.
double	getCustomTOCFontSize() Custom TOC Font Size in Points.
IDataGraphBase	getDataGraph(int index) Graph at the given index.
int	getDataGraphCount() Number of graphs in the collection.
IEnumDataset	getDatasets() The datasets in the document.
java.lang.Object	getDateExported() Date the document was last exported.
java.lang.Object	getDatePrinted() Date the document was last printed.
java.lang.Object	getDateSaved() Date the document was last saved.
IColor	getDefaultColor(int type) The default color for the given type.
java.lang.String	getDocumentTitle() The title of the document.
int	getDocumentVersion() The version of the document to save.
IFillSymbol	getFillSymbol() Default Fill Symbol.
IMap	getFocusMap() The current focus map.
java.lang.String	getFolder() The folder of the document.
java.lang.String	getHyperlinkBase() The hyperlink base of the document.
IUID	getID() The unique id for this document.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getKeywords() The keywords for the document.
ILinePatch	getLinePatch() Default Line Patch.
ILineSymbol	getLineSymbol() Default Line Symbol.
IMaps	getMaps() The collection of maps in the document.
IMarkerSymbol	getMarkerSymbol() Default Marker Symbol.
java.lang.String	getName() The name of the document.
IOperationStack	getOperationStack() The operation stack.
IPageLayout	getPageLayout() The page layout.
IApplication	getParent() The application in which this document is open.
double	getPatchHeight() Default Patch Height in Points.
double	getPatchWidth() Default Patch Width in Points.
java.lang.String	getPath() The path of the document.
IScene	getScene() The scene.
double	getSearchTolerance() The global search tolerance in geographic units for selection.
int	getSearchTolerancePixels() The global search tolerance in pixels for selection.
java.lang.Object	getSelectedItem() The selected item in the layer control.
ILayer	getSelectedLayer() The selected layer in the layer control.
IStyleGallery	getStyleGallery() Reference to the document's Style Gallery.
java.lang.String	getSubject() The subject of the document.
ITableProperties	getTableProperties() Table properties, for Layers and Tables.
IText3DElement	getText3DElement() Default 3D Text Element.
ITextSymbol	getTextSymbol() Default Text Symbol.
java.lang.String	getTitle() The title of this document.
int	getType() The type of this document.
java.lang.Object	getVBProject() The VBProject for this document.
int	hashCode() the hashcode for this object
boolean	isHasPreviewSaved() Indicates the presence of a thumbnail preview in the document.
boolean	isHasPreviewToSave() Indicates the presence of a thumbnail preview to be saved with the document.
boolean	isRelativePaths() Indicates if path names are stored relative to the document.
boolean	isSavePreview() Indicates if a preview image is saved in the document.
void	release() Release a GMxDocument.
void	removeAllDataGraphs() Removes all graphs from the collection.
void	removeAllLayers() Removes all layers.
void	removeDataGraph(IDataGraphBase graph) Removes the graph from the collection.
void	removeIDataGraphCollectionEventsListener(IDataGraphCollectionEvents theListener) removeIDataGraphCollectionEventsListener.
void	removeIGMxDocumentEventsDispListener(IGMxDocumentEventsDisp theListener) removeIGMxDocumentEventsDispListener.
void	removeIGMxDocumentEventsListener(IGMxDocumentEvents theListener) removeIGMxDocumentEventsListener.
void	setAreaPatch(IAreaPatch patch) Default Area Patch.
void	setAuthor(java.lang.String author) The author of the document.
void	setCallout(IFormattedTextSymbol callout) Default Callout.
void	setCategory(java.lang.String category) The category of the document.
void	setComments(java.lang.String comments) The comments for the document.
void	setContextItem(java.lang.Object ppItem) The last item that was right-clicked.
void	setCredits(java.lang.String credits) The credits of the document.
void	setCurrentContentsViewByRef(IContentsView2 view) The current contents view of the document.
void	setCurrentLocation(IPoint mouseLoc) The current mouse location in map units.
void	setCustomTOCFont(Font font) Custom TOC Font.
void	setCustomTOCFontSize(double fontSizePts) Custom TOC Font Size in Points.
void	setDefaultColor(int type, IColor color) The default color for the given type.
void	setDelayUpdateContents(boolean rhs1) Indicates whether to ignore document update notifications.
void	setDocumentTitle(java.lang.String title) The title of the document.
void	setDocumentVersion(int docVersion) The version of the document to save.
void	setFillSymbol(IFillSymbol lSymbol) Default Fill Symbol.
void	setHyperlinkBase(java.lang.String path) The hyperlink base of the document.
void	setKeywords(java.lang.String keywords) The keywords for the document.
void	setLinePatch(ILinePatch patch) Default Line Patch.
void	setLineSymbol(ILineSymbol lineSymbol) Default Line Symbol.
void	setMarkerSymbol(IMarkerSymbol markerSymbol) Default Marker Symbol.
void	setPageLayoutByRef(IPageLayout pageLayout) The page layout.
void	setPatchHeight(double heightPts) Default Patch Height in Points.
void	setPatchWidth(double widthPts) Default Patch Width in Points.
void	setRelativePaths(boolean relPaths) Indicates if path names are stored relative to the document.
void	setSavePreview(boolean savePreview) Indicates if a preview image is saved in the document.
void	setScene(IScene pScene) The scene.
void	setSearchTolerancePixels(int tol) The global search tolerance in pixels for selection.
void	setSubject(java.lang.String subject) The subject of the document.
void	setText3DElement(IText3DElement text3DElement) Default 3D Text Element.
void	setTextSymbol(ITextSymbol textSymbol) Default Text Symbol.
void	updateContents() Notifies the document that the contents have been updated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GMxDocument

public GMxDocument()
            throws java.io.IOException,
                   java.net.UnknownHostException

Constructs a GMxDocument using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GMxDocument

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

Construct a GMxDocument using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GMxDocument.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems GMxDocument theGMxDocument = (GMxDocument) obj;

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

addIGMxDocumentEventsDispListener

public void addIGMxDocumentEventsDispListener(IGMxDocumentEventsDisp theListener)
                                       throws java.io.IOException

addIGMxDocumentEventsDispListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.arcglobe.IGMxDocumentEventsDisp interface.

Throws:

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

removeIGMxDocumentEventsDispListener

public void removeIGMxDocumentEventsDispListener(IGMxDocumentEventsDisp theListener)
                                          throws java.io.IOException

removeIGMxDocumentEventsDispListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.arcglobe.IGMxDocumentEventsDisp interface.

Throws:

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

addIGMxDocumentEventsListener

public void addIGMxDocumentEventsListener(IGMxDocumentEvents theListener)
                                   throws java.io.IOException

addIGMxDocumentEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.arcglobe.IGMxDocumentEvents interface.

Throws:

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

removeIGMxDocumentEventsListener

public void removeIGMxDocumentEventsListener(IGMxDocumentEvents theListener)
                                      throws java.io.IOException

removeIGMxDocumentEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.arcglobe.IGMxDocumentEvents interface.

Throws:

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

addIDataGraphCollectionEventsListener

public void addIDataGraphCollectionEventsListener(IDataGraphCollectionEvents theListener)
                                           throws java.io.IOException

addIDataGraphCollectionEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IDataGraphCollectionEvents interface.

Throws:

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

removeIDataGraphCollectionEventsListener

public void removeIDataGraphCollectionEventsListener(IDataGraphCollectionEvents theListener)
                                              throws java.io.IOException

removeIDataGraphCollectionEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.carto.IDataGraphCollectionEvents interface.

Throws:

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

release

public void release()

Release a GMxDocument.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getParent

public IApplication getParent()
                       throws java.io.IOException,
                              AutomationException

The application in which this document is open.

Specified by:

getParent in interface IDocument

Returns:

A reference to a com.esri.arcgis.framework.IApplication

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTitle

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

The title of this document.

Specified by:

getTitle in interface IDocument

Returns:

The title

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCommandBars

public ICommandBars getCommandBars()
                            throws java.io.IOException,
                                   AutomationException

The commandbars collection in this document.

Specified by:

getCommandBars in interface IDocument

Returns:

A reference to a com.esri.arcgis.framework.ICommandBars

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAccelerators

public IAcceleratorTable getAccelerators()
                                  throws java.io.IOException,
                                         AutomationException

The accelerator table for this document.

Specified by:

getAccelerators in interface IDocument

Returns:

A reference to a com.esri.arcgis.framework.IAcceleratorTable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getID

public IUID getID()
           throws java.io.IOException,
                  AutomationException

The unique id for this document.

Specified by:

getID in interface IDocument

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getType

public int getType()
            throws java.io.IOException,
                   AutomationException

The type of this document.

Specified by:

getType in interface IDocument

Returns:

A com.esri.arcgis.framework.esriDocumentType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getVBProject

public java.lang.Object getVBProject()
                              throws java.io.IOException,
                                     AutomationException

The VBProject for this document.

Specified by:

getVBProject in interface IDocument

Returns:

A reference to another Automation Object (IDispatch)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelectedLayer

public ILayer getSelectedLayer()
                        throws java.io.IOException,
                               AutomationException

The selected layer in the layer control.

Specified by:

getSelectedLayer in interface IGMxDocument

Specified by:

getSelectedLayer in interface IBasicDocument2

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.

getSelectedItem

public java.lang.Object getSelectedItem()
                                 throws java.io.IOException,
                                        AutomationException

The selected item in the layer control.

Specified by:

getSelectedItem in interface IGMxDocument

Specified by:

getSelectedItem in interface IBasicDocument2

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContextItem

public java.lang.Object getContextItem()
                                throws java.io.IOException,
                                       AutomationException

The last item that was right-clicked.

Specified by:

getContextItem in interface IGMxDocument

Specified by:

getContextItem in interface IBasicDocument2

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setContextItem

public void setContextItem(java.lang.Object ppItem)
                    throws java.io.IOException,
                           AutomationException

The last item that was right-clicked.

Specified by:

setContextItem in interface IGMxDocument

Specified by:

setContextItem in interface IBasicDocument2

Parameters:

ppItem - A reference to another Object (IUnknown) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addLayer

public void addLayer(ILayer pLayer)
              throws java.io.IOException,
                     AutomationException

Adds a layer to the current focus map or scene.

Specified by:

addLayer in interface IGMxDocument

Specified by:

addLayer in interface IBasicDocument2

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateContents

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

Notifies the document that the contents have been updated.

Specified by:

updateContents in interface IGMxDocument

Specified by:

updateContents in interface IBasicDocument2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTableProperties

public ITableProperties getTableProperties()
                                    throws java.io.IOException,
                                           AutomationException

Table properties, for Layers and Tables.

Specified by:

getTableProperties in interface IBasicDocument2

Returns:

A reference to a com.esri.arcgis.arcmapui.ITableProperties

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPageLayoutByRef

public void setPageLayoutByRef(IPageLayout pageLayout)
                        throws java.io.IOException,
                               AutomationException

The page layout.

Specified by:

setPageLayoutByRef in interface IBasicDocument2

Parameters:

pageLayout - A reference to a com.esri.arcgis.carto.IPageLayout (in)

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

The page layout.

Specified by:

getPageLayout in interface IBasicDocument2

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.

getActivatedView

public IActiveView getActivatedView()
                             throws java.io.IOException,
                                    AutomationException

The activated view. This is the same as the active view unless a data frame is activated within a layout.

Specified by:

getActivatedView in interface IBasicDocument2

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.

getFocusMap

public IMap getFocusMap()
                 throws java.io.IOException,
                        AutomationException

The current focus map.

Specified by:

getFocusMap in interface IBasicDocument2

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.

getStyleGallery

public IStyleGallery getStyleGallery()
                              throws java.io.IOException,
                                     AutomationException

Reference to the document's Style Gallery.

Specified by:

getStyleGallery in interface IBasicDocument2

Returns:

A reference to a com.esri.arcgis.display.IStyleGallery

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSearchTolerance

public double getSearchTolerance()
                          throws java.io.IOException,
                                 AutomationException

The global search tolerance in geographic units for selection.

Specified by:

getSearchTolerance in interface IBasicDocument2

Returns:

The tol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSearchTolerancePixels

public int getSearchTolerancePixels()
                             throws java.io.IOException,
                                    AutomationException

The global search tolerance in pixels for selection.

Specified by:

getSearchTolerancePixels in interface IGMxDocument

Specified by:

getSearchTolerancePixels in interface IBasicDocument2

Returns:

The tol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSearchTolerancePixels

public void setSearchTolerancePixels(int tol)
                              throws java.io.IOException,
                                     AutomationException

The global search tolerance in pixels for selection.

Specified by:

setSearchTolerancePixels in interface IGMxDocument

Specified by:

setSearchTolerancePixels in interface IBasicDocument2

Parameters:

tol - The tol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaps

public IMaps getMaps()
              throws java.io.IOException,
                     AutomationException

The collection of maps in the document.

Specified by:

getMaps in interface IBasicDocument2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOperationStack

public IOperationStack getOperationStack()
                                  throws java.io.IOException,
                                         AutomationException

The operation stack.

Specified by:

getOperationStack in interface IBasicDocument2

Returns:

A reference to a com.esri.arcgis.systemUI.IOperationStack

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentLocation

public IPoint getCurrentLocation()
                          throws java.io.IOException,
                                 AutomationException

The current mouse location in map units.

Specified by:

getCurrentLocation in interface IBasicDocument2

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCurrentLocation

public void setCurrentLocation(IPoint mouseLoc)
                        throws java.io.IOException,
                               AutomationException

The current mouse location in map units.

Specified by:

setCurrentLocation in interface IBasicDocument2

Parameters:

mouseLoc - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAllLayers

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

Removes all layers.

Specified by:

removeAllLayers in interface IGMxDocument

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDelayUpdateContents

public void setDelayUpdateContents(boolean rhs1)
                            throws java.io.IOException,
                                   AutomationException

Indicates whether to ignore document update notifications.

Specified by:

setDelayUpdateContents in interface IGMxDocument

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultColor

public IColor getDefaultColor(int type)
                       throws java.io.IOException,
                              AutomationException

The default color for the given type.

Specified by:

getDefaultColor in interface IGMxDocument

Parameters:

type - A com.esri.arcgis.arcmapui.esriMxDefaultColorTypes constant (in)

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultColor

public void setDefaultColor(int type,
                            IColor color)
                     throws java.io.IOException,
                            AutomationException

The default color for the given type.

Specified by:

setDefaultColor in interface IGMxDocument

Parameters:

type - A com.esri.arcgis.arcmapui.esriMxDefaultColorTypes constant (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getScene

public IScene getScene()
                throws java.io.IOException,
                       AutomationException

The scene.

Specified by:

getScene in interface IGMxDocument

Returns:

A reference to a com.esri.arcgis.analyst3d.IScene

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setScene

public void setScene(IScene pScene)
              throws java.io.IOException,
                     AutomationException

The scene.

Specified by:

setScene in interface IGMxDocument

Parameters:

pScene - A reference to a com.esri.arcgis.analyst3d.IScene (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRelativePaths

public boolean isRelativePaths()
                        throws java.io.IOException,
                               AutomationException

Indicates if path names are stored relative to the document.

Specified by:

isRelativePaths in interface IGMxDocument

Specified by:

isRelativePaths in interface IDocumentInfo2

Returns:

The relPaths

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRelativePaths

public void setRelativePaths(boolean relPaths)
                      throws java.io.IOException,
                             AutomationException

Indicates if path names are stored relative to the document.

Specified by:

setRelativePaths in interface IGMxDocument

Specified by:

setRelativePaths in interface IDocumentInfo2

Parameters:

relPaths - The relPaths (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSavePreview

public boolean isSavePreview()
                      throws java.io.IOException,
                             AutomationException

Indicates if a preview image is saved in the document.

Specified by:

isSavePreview in interface IGMxDocument

Specified by:

isSavePreview in interface IDocumentInfo2

Returns:

The savePreview

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSavePreview

public void setSavePreview(boolean savePreview)
                    throws java.io.IOException,
                           AutomationException

Indicates if a preview image is saved in the document.

Specified by:

setSavePreview in interface IGMxDocument

Specified by:

setSavePreview in interface IDocumentInfo2

Parameters:

savePreview - The savePreview (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentContentsView

public IContentsView2 getCurrentContentsView()
                                      throws java.io.IOException,
                                             AutomationException

The current contents view of the document.

Specified by:

getCurrentContentsView in interface IGMxDocument

Returns:

A reference to a com.esri.arcgis.arcmapui.IContentsView2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCurrentContentsViewByRef

public void setCurrentContentsViewByRef(IContentsView2 view)
                                 throws java.io.IOException,
                                        AutomationException

The current contents view of the document.

Specified by:

setCurrentContentsViewByRef in interface IGMxDocument

Parameters:

view - A reference to a com.esri.arcgis.arcmapui.IContentsView2 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContentsViewCount

public int getContentsViewCount()
                         throws java.io.IOException,
                                AutomationException

The number of contents views in the document.

Specified by:

getContentsViewCount in interface IGMxDocument

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContentsView

public IContentsView2 getContentsView(int index)
                               throws java.io.IOException,
                                      AutomationException

The contents view at the specified index.

Specified by:

getContentsView in interface IGMxDocument

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.arcmapui.IContentsView2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDocumentTitle

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

The title of the document.

Specified by:

getDocumentTitle in interface IGMxDocumentInfo

Specified by:

getDocumentTitle in interface IDocumentInfo2

Returns:

The title

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDocumentTitle

public void setDocumentTitle(java.lang.String title)
                      throws java.io.IOException,
                             AutomationException

The title of the document.

Specified by:

setDocumentTitle in interface IGMxDocumentInfo

Specified by:

setDocumentTitle in interface IDocumentInfo2

Parameters:

title - The title (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSubject

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

The subject of the document.

Specified by:

getSubject in interface IGMxDocumentInfo

Specified by:

getSubject in interface IDocumentInfo2

Returns:

The subject

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSubject

public void setSubject(java.lang.String subject)
                throws java.io.IOException,
                       AutomationException

The subject of the document.

Specified by:

setSubject in interface IGMxDocumentInfo

Specified by:

setSubject in interface IDocumentInfo2

Parameters:

subject - The subject (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAuthor

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

The author of the document.

Specified by:

getAuthor in interface IGMxDocumentInfo

Specified by:

getAuthor in interface IDocumentInfo2

Returns:

The author

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAuthor

public void setAuthor(java.lang.String author)
               throws java.io.IOException,
                      AutomationException

The author of the document.

Specified by:

setAuthor in interface IGMxDocumentInfo

Specified by:

setAuthor in interface IDocumentInfo2

Parameters:

author - The author (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCategory

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

The category of the document.

Specified by:

getCategory in interface IGMxDocumentInfo

Specified by:

getCategory in interface IDocumentInfo2

Returns:

The category

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCategory

public void setCategory(java.lang.String category)
                 throws java.io.IOException,
                        AutomationException

The category of the document.

Specified by:

setCategory in interface IGMxDocumentInfo

Specified by:

setCategory in interface IDocumentInfo2

Parameters:

category - The category (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getComments

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

The comments for the document.

Specified by:

getComments in interface IGMxDocumentInfo

Specified by:

getComments in interface IDocumentInfo2

Returns:

The comments

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setComments

public void setComments(java.lang.String comments)
                 throws java.io.IOException,
                        AutomationException

The comments for the document.

Specified by:

setComments in interface IGMxDocumentInfo

Specified by:

setComments in interface IDocumentInfo2

Parameters:

comments - The comments (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getKeywords

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

The keywords for the document.

Specified by:

getKeywords in interface IGMxDocumentInfo

Specified by:

getKeywords in interface IDocumentInfo2

Returns:

The keywords

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setKeywords

public void setKeywords(java.lang.String keywords)
                 throws java.io.IOException,
                        AutomationException

The keywords for the document.

Specified by:

setKeywords in interface IGMxDocumentInfo

Specified by:

setKeywords in interface IDocumentInfo2

Parameters:

keywords - The keywords (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHyperlinkBase

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

The hyperlink base of the document.

Specified by:

getHyperlinkBase in interface IGMxDocumentInfo

Specified by:

getHyperlinkBase in interface IDocumentInfo2

Returns:

The path

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHyperlinkBase

public void setHyperlinkBase(java.lang.String path)
                      throws java.io.IOException,
                             AutomationException

The hyperlink base of the document.

Specified by:

setHyperlinkBase in interface IGMxDocumentInfo

Specified by:

setHyperlinkBase in interface IDocumentInfo2

Parameters:

path - The path (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDatasets

public IEnumDataset getDatasets()
                         throws java.io.IOException,
                                AutomationException

The datasets in the document.

Specified by:

getDatasets in interface IDocumentDatasets

Returns:

A reference to a com.esri.arcgis.geodatabase.IEnumDataset

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFillSymbol

public void setFillSymbol(IFillSymbol lSymbol)
                   throws java.io.IOException,
                          AutomationException

Default Fill Symbol.

Specified by:

setFillSymbol in interface IBasicDocumentDefaultSymbols

Specified by:

setFillSymbol in interface IDocumentDefaultSymbols

Parameters:

lSymbol - A reference to a com.esri.arcgis.display.IFillSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFillSymbol

public IFillSymbol getFillSymbol()
                          throws java.io.IOException,
                                 AutomationException

Default Fill Symbol.

Specified by:

getFillSymbol in interface IBasicDocumentDefaultSymbols

Specified by:

getFillSymbol in interface IDocumentDefaultSymbols

Returns:

A reference to a com.esri.arcgis.display.IFillSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLineSymbol

public void setLineSymbol(ILineSymbol lineSymbol)
                   throws java.io.IOException,
                          AutomationException

Default Line Symbol.

Specified by:

setLineSymbol in interface IBasicDocumentDefaultSymbols

Specified by:

setLineSymbol in interface IDocumentDefaultSymbols

Parameters:

lineSymbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLineSymbol

public ILineSymbol getLineSymbol()
                          throws java.io.IOException,
                                 AutomationException

Default Line Symbol.

Specified by:

getLineSymbol in interface IBasicDocumentDefaultSymbols

Specified by:

getLineSymbol in interface IDocumentDefaultSymbols

Returns:

A reference to a com.esri.arcgis.display.ILineSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMarkerSymbol

public void setMarkerSymbol(IMarkerSymbol markerSymbol)
                     throws java.io.IOException,
                            AutomationException

Default Marker Symbol.

Specified by:

setMarkerSymbol in interface IBasicDocumentDefaultSymbols

Specified by:

setMarkerSymbol in interface IDocumentDefaultSymbols

Parameters:

markerSymbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMarkerSymbol

public IMarkerSymbol getMarkerSymbol()
                              throws java.io.IOException,
                                     AutomationException

Default Marker Symbol.

Specified by:

getMarkerSymbol in interface IBasicDocumentDefaultSymbols

Specified by:

getMarkerSymbol in interface IDocumentDefaultSymbols

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTextSymbol

public void setTextSymbol(ITextSymbol textSymbol)
                   throws java.io.IOException,
                          AutomationException

Default Text Symbol.

Specified by:

setTextSymbol in interface IDocumentDefaultSymbols

Parameters:

textSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTextSymbol

public ITextSymbol getTextSymbol()
                          throws java.io.IOException,
                                 AutomationException

Default Text Symbol.

Specified by:

getTextSymbol in interface IDocumentDefaultSymbols

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCallout

public void setCallout(IFormattedTextSymbol callout)
                throws java.io.IOException,
                       AutomationException

Default Callout.

Specified by:

setCallout in interface IDocumentDefaultSymbols

Parameters:

callout - A reference to a com.esri.arcgis.display.IFormattedTextSymbol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCallout

public IFormattedTextSymbol getCallout()
                                throws java.io.IOException,
                                       AutomationException

Default Callout.

Specified by:

getCallout in interface IDocumentDefaultSymbols

Returns:

A reference to a com.esri.arcgis.display.IFormattedTextSymbol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAreaPatch

public void setAreaPatch(IAreaPatch patch)
                  throws java.io.IOException,
                         AutomationException

Default Area Patch.

Specified by:

setAreaPatch in interface IBasicDocumentDefaultSymbols

Specified by:

setAreaPatch in interface IDocumentDefaultSymbols

Parameters:

patch - A reference to a com.esri.arcgis.carto.IAreaPatch (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAreaPatch

public IAreaPatch getAreaPatch()
                        throws java.io.IOException,
                               AutomationException

Default Area Patch.

Specified by:

getAreaPatch in interface IBasicDocumentDefaultSymbols

Specified by:

getAreaPatch in interface IDocumentDefaultSymbols

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLinePatch

public void setLinePatch(ILinePatch patch)
                  throws java.io.IOException,
                         AutomationException

Default Line Patch.

Specified by:

setLinePatch in interface IBasicDocumentDefaultSymbols

Specified by:

setLinePatch in interface IDocumentDefaultSymbols

Parameters:

patch - A reference to a com.esri.arcgis.carto.ILinePatch (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLinePatch

public ILinePatch getLinePatch()
                        throws java.io.IOException,
                               AutomationException

Default Line Patch.

Specified by:

getLinePatch in interface IBasicDocumentDefaultSymbols

Specified by:

getLinePatch in interface IDocumentDefaultSymbols

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPatchWidth

public void setPatchWidth(double widthPts)
                   throws java.io.IOException,
                          AutomationException

Default Patch Width in Points.

Specified by:

setPatchWidth in interface IBasicDocumentDefaultSymbols

Specified by:

setPatchWidth in interface IDocumentDefaultSymbols

Parameters:

widthPts - The widthPts (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPatchWidth

public double getPatchWidth()
                     throws java.io.IOException,
                            AutomationException

Default Patch Width in Points.

Specified by:

getPatchWidth in interface IBasicDocumentDefaultSymbols

Specified by:

getPatchWidth in interface IDocumentDefaultSymbols

Returns:

The widthPts

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPatchHeight

public void setPatchHeight(double heightPts)
                    throws java.io.IOException,
                           AutomationException

Default Patch Height in Points.

Specified by:

setPatchHeight in interface IBasicDocumentDefaultSymbols

Specified by:

setPatchHeight in interface IDocumentDefaultSymbols

Parameters:

heightPts - The heightPts (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPatchHeight

public double getPatchHeight()
                      throws java.io.IOException,
                             AutomationException

Default Patch Height in Points.

Specified by:

getPatchHeight in interface IBasicDocumentDefaultSymbols

Specified by:

getPatchHeight in interface IDocumentDefaultSymbols

Returns:

The heightPts

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomTOCFont

public void setCustomTOCFont(Font font)
                      throws java.io.IOException,
                             AutomationException

Custom TOC Font.

Specified by:

setCustomTOCFont in interface IBasicDocumentDefaultSymbols

Specified by:

setCustomTOCFont in interface IDocumentDefaultSymbols

Parameters:

font - A reference to a com.esri.arcgis.support.ms.stdole.Font (A com.esri.arcgis.support.ms.stdole.Font COM typedef) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCustomTOCFont

public Font getCustomTOCFont()
                      throws java.io.IOException,
                             AutomationException

Custom TOC Font.

Specified by:

getCustomTOCFont in interface IBasicDocumentDefaultSymbols

Specified by:

getCustomTOCFont in interface IDocumentDefaultSymbols

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCustomTOCFontSize

public void setCustomTOCFontSize(double fontSizePts)
                          throws java.io.IOException,
                                 AutomationException

Custom TOC Font Size in Points.

Specified by:

setCustomTOCFontSize in interface IBasicDocumentDefaultSymbols

Specified by:

setCustomTOCFontSize in interface IDocumentDefaultSymbols

Parameters:

fontSizePts - The fontSizePts (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCustomTOCFontSize

public double getCustomTOCFontSize()
                            throws java.io.IOException,
                                   AutomationException

Custom TOC Font Size in Points.

Specified by:

getCustomTOCFontSize in interface IBasicDocumentDefaultSymbols

Specified by:

getCustomTOCFontSize in interface IDocumentDefaultSymbols

Returns:

The fontSizePts

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getText3DElement

public IText3DElement getText3DElement()
                                throws java.io.IOException,
                                       AutomationException

Default 3D Text Element.

Specified by:

getText3DElement in interface IDocument3DDefaultSymbols

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setText3DElement

public void setText3DElement(IText3DElement text3DElement)
                      throws java.io.IOException,
                             AutomationException

Default 3D Text Element.

Specified by:

setText3DElement in interface IDocument3DDefaultSymbols

Parameters:

text3DElement - A reference to a com.esri.arcgis.carto.IText3DElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearContentsViews

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

Removes all current contents views.

Specified by:

clearContentsViews in interface IContentsViewEdit

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addContentsView

public void addContentsView(IContentsView contentsView)
                     throws java.io.IOException,
                            AutomationException

Adds a contents view object to the TOC.

Specified by:

addContentsView in interface IContentsViewEdit

Parameters:

contentsView - A reference to a com.esri.arcgis.arcmapui.IContentsView (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDocumentVersion

public void setDocumentVersion(int docVersion)
                        throws java.io.IOException,
                               AutomationException

The version of the document to save.

Specified by:

setDocumentVersion in interface IDocumentVersion

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

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

The version of the document to save.

Specified by:

getDocumentVersion in interface IDocumentVersion

Returns:

A com.esri.arcgis.system.esriArcGISVersion constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCredits

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

The credits of the document.

Specified by:

getCredits in interface IDocumentInfo2

Returns:

The credits

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCredits

public void setCredits(java.lang.String credits)
                throws java.io.IOException,
                       AutomationException

The credits of the document.

Specified by:

setCredits in interface IDocumentInfo2

Parameters:

credits - The credits (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

The name of the document.

Specified by:

getName in interface IDocumentInfo2

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPath

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

The path of the document.

Specified by:

getPath in interface IDocumentInfo2

Returns:

The path

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFolder

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

The folder of the document.

Specified by:

getFolder in interface IDocumentInfo2

Returns:

The folder

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDateSaved

public java.lang.Object getDateSaved()
                              throws java.io.IOException,
                                     AutomationException

Date the document was last saved.

Specified by:

getDateSaved in interface IDocumentInfo2

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDatePrinted

public java.lang.Object getDatePrinted()
                                throws java.io.IOException,
                                       AutomationException

Date the document was last printed.

Specified by:

getDatePrinted in interface IDocumentInfo2

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDateExported

public java.lang.Object getDateExported()
                                 throws java.io.IOException,
                                        AutomationException

Date the document was last exported.

Specified by:

getDateExported in interface IDocumentInfo2

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createPreview

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

Creates a thumbnail preview of the document.

Specified by:

createPreview in interface IDocumentPreview

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deletePreview

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

Deletes the thumbnail preview of the document.

Specified by:

deletePreview in interface IDocumentPreview

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasPreviewSaved

public boolean isHasPreviewSaved()
                          throws java.io.IOException,
                                 AutomationException

Indicates the presence of a thumbnail preview in the document.

Specified by:

isHasPreviewSaved in interface IDocumentPreview

Returns:

The hasPreviewSaved

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasPreviewToSave

public boolean isHasPreviewToSave()
                           throws java.io.IOException,
                                  AutomationException

Indicates the presence of a thumbnail preview to be saved with the document.

Specified by:

isHasPreviewToSave in interface IDocumentPreview

Returns:

The hasPreviewToSave

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataGraphCount

public int getDataGraphCount()
                      throws java.io.IOException,
                             AutomationException

Number of graphs in the collection.

Specified by:

getDataGraphCount in interface IDataGraphCollection

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDataGraph

public IDataGraphBase getDataGraph(int index)
                            throws java.io.IOException,
                                   AutomationException

Graph at the given index.

Specified by:

getDataGraph in interface IDataGraphCollection

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeDataGraph

public void removeDataGraph(IDataGraphBase graph)
                     throws java.io.IOException,
                            AutomationException

Removes the graph from the collection.

Specified by:

removeDataGraph in interface IDataGraphCollection

Parameters:

graph - A reference to a com.esri.arcgis.carto.IDataGraphBase (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addDataGraph

public void addDataGraph(IDataGraphBase graph)
                  throws java.io.IOException,
                         AutomationException

Adds the graph to the collection.

Specified by:

addDataGraph in interface IDataGraphCollection

Parameters:

graph - A reference to a com.esri.arcgis.carto.IDataGraphBase (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAllDataGraphs

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

Removes all graphs from the collection.

Specified by:

removeAllDataGraphs in interface IDataGraphCollection

Throws:

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

AutomationException - If the ArcObject component throws an exception.