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

com.esri.arcgis.arcmapui
Class MxDocument

java.lang.Object
  extended by com.esri.arcgis.arcmapui.MxDocument
All Implemented Interfaces:
IBasicDocument, IBasicDocument2, IBasicDocumentDefaultSymbols, IChangeLayout, IContentsViewEdit, IDocumentDefaultSymbols, IMxDocument, IReportUnitFormat, IReportUnitFormat2, IDataGraphCollection, IDocumentInfo, IDocumentInfo2, IDocumentPreview, IMapDocument, IDocumentDatasets, IConnectionPointContainer, IDocument, IDocumentDirty, IDocumentDirty2, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersion, IPersist, IPropertySupport, ISupportErrorInfo, java.io.Serializable
public class MxDocument
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IDocument, IMxDocument, IDocumentDirty, IDocumentDirty2, IPropertySupport, IChangeLayout, IDocumentDefaultSymbols, IContentsViewEdit, IDataGraphCollection, IDocumentDatasets, IDocumentInfo, IDocumentInfo2, IDocumentPreview, IReportUnitFormat, IReportUnitFormat2, IDocumentVersion, IPersist, IBasicDocument, IBasicDocument2, IBasicDocumentDefaultSymbols, IMapDocument, ISupportErrorInfo, IConnectionPointContainer

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

Description 'Esri Mx 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.IMxDocument
IID, IID0522a5f1_487c_11d0_98bd_00805f7ced21, xxDummy
 
Fields inherited from interface com.esri.arcgis.framework.IDocumentDirty2
IID, IIDa684089c_cde0_407c_92d8_811a3f8e850c, xxDummy
 
Fields inherited from interface com.esri.arcgis.framework.IDocumentDirty
IIDb26de0cf_5c0a_433d_9082_097004e13a0a
 
Fields inherited from interface com.esri.arcgis.system.IPropertySupport
IID, IID8a11ad55_2f4f_11d3_9fa0_00c04f6bc6a5, xxDummy
 
Fields inherited from interface com.esri.arcgis.arcmapui.IChangeLayout
IID, IID1a8d7ead_df05_11d3_9309_00600802e603, xxDummy
 
Fields inherited from interface com.esri.arcgis.arcmapui.IDocumentDefaultSymbols
IID, IID85961926_d8e9_11d3_9ff5_00c04f6bc8dd, xxDummy
 
Fields inherited from interface com.esri.arcgis.arcmapui.IContentsViewEdit
IID, IIDb0f32eaf_ebdb_11d3_9fdb_00c04f6bc78e, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IDataGraphCollection
IID, IID5c68acbe_4517_4c11_97a1_e3c7edb0c3bb, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalogUI.IDocumentDatasets
IID, IID7bfce4b1_1228_11d4_9fec_00c04f6bc78e, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IDocumentInfo
IID, IIDd3e5c54e_2a84_11d4_9ff2_00c04f6bc78e, 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.arcmapui.IReportUnitFormat
IID, IID5fc55a41_b276_4e9c_9dce_c54f61419dfe, xxDummy
 
Fields inherited from interface com.esri.arcgis.arcmapui.IReportUnitFormat2
IID, IID5fc55a42_b276_4e9c_9dce_c54f61419dfe, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IDocumentVersion
IID, IIDecc43c55_0148_4ec1_bf87_b9a183c5dc98, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID, IID0000010c_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.arcmapui.IBasicDocument
IID, IIDa58923bc_14d4_11d4_a0ff_00c04f8ece27, xxDummy
 
Fields inherited from interface com.esri.arcgis.arcmapui.IBasicDocument2
IID, IIDef2ec034_c197_48a0_90ee_c6b7db797eb8, xxDummy
 
Fields inherited from interface com.esri.arcgis.arcmapui.IBasicDocumentDefaultSymbols
IID, IIDbaf98c1c_6e13_11d4_ab81_0008c73fd50c, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IMapDocument
IID, IID5366451c_a001_4179_b8cb_e8f014628a44, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer
IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy
 
Constructor Summary
MxDocument()
          Constructs a MxDocument using ArcGIS Engine.
MxDocument(java.lang.Object obj)
          Construct a MxDocument 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 addIDocumentEventsDispListener(IDocumentEventsDisp theListener)
          addIDocumentEventsDispListener.
 void addIDocumentEventsListener(IDocumentEvents theListener)
          addIDocumentEventsListener.
 void addLayer(ILayer layer)
          Adds a layer to the current focus map.
 boolean applies(java.lang.Object pUnk)
          Indicates if the receiver can apply the given object at any given time.
 java.lang.Object apply(java.lang.Object newObject)
          Applies the given property to the receiver and returns the old object.
 boolean canApply(java.lang.Object pUnk)
          Indicates if the receiver can apply the given object at that particular moment.
 void canInsertObject(boolean[] pEnabled)
          Indicates if the document allows objects to be inserted.
 boolean changeLayout()
          Indicates if the wizard used to select a new layout is shown.
 void clearContentsViews()
          Removes all current contents views.
 void close()
          Close the map document.
 void createPreview()
          Creates a thumbnail preview of the document.
 void deletePreview()
          Deletes the thumbnail preview of the document.
 void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
          enumConnectionPoints
 boolean equals(java.lang.Object o)
          Compare this object with another
 void esri_new(java.lang.String sDocument)
          Creates and opens a new map document in preparation for the contents to be retrieve or updated.
 void findConnectionPoint(GUID riid, IConnectionPoint[] ppCP)
          findConnectionPoint
 IAcceleratorTable getAccelerators()
          The accelerator table for this document.
 IActiveView getActivatedView()
          The activated view.
 IActiveView getActiveView()
          The active view.
 ICommand getActiveViewCommand()
          The command associated with the active 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.
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 ICommandBars getCommandBars()
          The commandbars collection in this document.
 java.lang.String getComments()
          Comments for the document.
 IContentsView 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.
 ILatLonFormat getCoordinateReadoutLatLonFormat()
          The format used for the coordinate readout on the status bar.
 int getCoordinateReadoutUnits()
          The units used for the coordinate readout on the status bar.
 java.lang.String getCredits()
          The credits of the document.
 java.lang.Object getCurrent(java.lang.Object pUnk)
          The object currently being used.
 IContentsView 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.
 Font getDefaultTextFont()
          The default font for text.
 IFontSize getDefaultTextFontSize()
          The default font size for text.
 java.lang.String getDocumentFilename()
          The map document filename that the MapDocument coclass is linked to.
 java.lang.String getDocumentTitle()
          The title of the document.
 int getDocumentType()
          The type of map document currently loaded in the object.
 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.
 ILatLonFormat getLatLonFormat()
          The format object used for reporting lat-lon values.
 ILayer getLayer(int mapIndex, int layerIndex)
          The Layer object at the specified index for the specified map.
 ILinePatch getLinePatch()
          Default Line Patch.
 ILineSymbol getLineSymbol()
          Default Line Symbol.
 IMap getMap(int mapIndex)
          The Map object at the specified index.
 int getMapCount()
          The number of Map objects contained within the map document.
 IMaps getMaps()
          The collection of maps in the document.
 IMarkerSymbol getMarkerSymbol()
          Default Marker Symbol.
 java.lang.String getName()
          The name of the document.
 INumberFormat getNumericFormat()
          The format object used for reporting numeric values.
 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.
 IPrinter getPrinter()
          The printer object.
 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 in ArcMap.
 ITextSymbol getTextSymbol()
          Default Text Symbol.
 IPicture getThumbnail()
          The thumbnail stored in the map document.
 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.
 void getVersionInfo(boolean[] versionInfoMissing, int[] lMajor, int[] lMinor, int[] lRevision, int[] lBuild)
          Retrieve the detailed version information of the map document.
 int hashCode()
          the hashcode for this object
 void insertObject()
          Inserts an object into the document.
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 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 isMapDocument(java.lang.String sDocument)
          Indicates if the map document is a valid map document.
 boolean isPasswordProtected(java.lang.String sDocument)
          Indicates if the map document is protected by a passsword.
 boolean isPresent(java.lang.String sDocument)
          Indicates if the map document is present.
 boolean isReadOnly(java.lang.String sDocument)
          Indicates if the map document is read only.
 boolean isRelativePaths()
          Indicates if path names are stored relative to the document.
 boolean isRestricted(java.lang.String sDocument)
          Indicates if the use of the map document is restricted to certain applications.
 boolean isSavePreview()
          Indicates if a preview of the document is saved when the document is saved.
 boolean isUsesRelativePaths()
          Indicates if the data in the map document is referenced using relative paths.
 void open(java.lang.String sDocument, java.lang.String bsPassword)
          Open the map document in preparation for the contents to be retrieve or updated.
 void release()
          Release a MxDocument.
 void removeAllDataGraphs()
          Removes all graphs from the collection.
 void removeDataGraph(IDataGraphBase graph)
          Removes the graph from the collection.
 void removeIDataGraphCollectionEventsListener(IDataGraphCollectionEvents theListener)
          removeIDataGraphCollectionEventsListener.
 void removeIDocumentEventsDispListener(IDocumentEventsDisp theListener)
          removeIDocumentEventsDispListener.
 void removeIDocumentEventsListener(IDocumentEvents theListener)
          removeIDocumentEventsListener.
 void replaceContents(IMxdContents pObject)
          Replace the contents of the map document.
 void save(boolean bUseRelativePaths, boolean bCreateThumnbail)
          Save the contents of the map document to the bound file.
 void saveAs(java.lang.String sDocument, boolean bUseRelativePaths, boolean bCreateThumnbail)
          Save the contents of the map document to the specified file name.
 void setActiveView(IActiveView pActiveView)
          Set the ActiveView content of the map document.
 void setActiveViewByRef(IActiveView activeView)
          The active view.
 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 setClean()
          Resets the dirty flag on the document.
 void setComments(java.lang.String comments)
          Comments for the document.
 void setContextItem(java.lang.Object item)
          The last item that was right-clicked.
 void setCoordinateReadoutLatLonFormatByRef(ILatLonFormat format)
          The format used for the coordinate readout on the status bar.
 void setCoordinateReadoutUnits(int units)
          The units used for the coordinate readout on the status bar.
 void setCredits(java.lang.String credits)
          The credits of the document.
 void setCurrentContentsViewByRef(IContentsView 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 setDefaultTextFont(Font fontDisp)
          The default font for text.
 void setDefaultTextFontSize(IFontSize fontSize)
          The default font size for text.
 void setDelayUpdateContents(boolean rhs1)
          Indicates document update notifications should be ignored.
 void setDirty()
          Sets the dirty flag on the document.
 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 setLatLonFormatByRef(ILatLonFormat format)
          The format object used for reporting lat-lon values.
 void setLinePatch(ILinePatch patch)
          Default Line Patch.
 void setLineSymbol(ILineSymbol lineSymbol)
          Default Line Symbol.
 void setMarkerSymbol(IMarkerSymbol markerSymbol)
          Default Marker Symbol.
 void setNumericFormatByRef(INumberFormat format)
          The format object used for reporting numeric values.
 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 of the document is saved when the document is saved.
 void setSearchTolerancePixels(int tol)
          The global search tolerance in pixels for selection.
 void setSubject(java.lang.String subject)
          The subject of the document.
 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

MxDocument

public MxDocument()
           throws java.io.IOException,
                  java.net.UnknownHostException
Constructs a MxDocument using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

MxDocument

public MxDocument(java.lang.Object obj)
           throws java.io.IOException
Construct a MxDocument using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MxDocument.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems MxDocument theMxDocument = (MxDocument) 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

addIDocumentEventsDispListener

public void addIDocumentEventsDispListener(IDocumentEventsDisp theListener)
                                    throws java.io.IOException
addIDocumentEventsDispListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.arcmapui.IDocumentEventsDisp interface.
Throws:
java.io.IOException - If there are communications problems.

removeIDocumentEventsDispListener

public void removeIDocumentEventsDispListener(IDocumentEventsDisp theListener)
                                       throws java.io.IOException
removeIDocumentEventsDispListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.arcmapui.IDocumentEventsDisp interface.
Throws:
java.io.IOException - If there are communications problems.

addIDocumentEventsListener

public void addIDocumentEventsListener(IDocumentEvents theListener)
                                throws java.io.IOException
addIDocumentEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.arcmapui.IDocumentEvents interface.
Throws:
java.io.IOException - If there are communications problems.

removeIDocumentEventsListener

public void removeIDocumentEventsListener(IDocumentEvents theListener)
                                   throws java.io.IOException
removeIDocumentEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.arcmapui.IDocumentEvents 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 MxDocument.

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.

setPageLayoutByRef

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

Specified by:
setPageLayoutByRef in interface IBasicDocument2
Specified by:
setPageLayoutByRef in interface IMxDocument
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
Specified by:
getPageLayout in interface IMxDocument
Specified by:
getPageLayout in interface IMapDocument
Returns:
A reference to a com.esri.arcgis.carto.IPageLayout
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActiveView

public IActiveView getActiveView()
                          throws java.io.IOException,
                                 AutomationException
The active view.

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

setActiveViewByRef

public void setActiveViewByRef(IActiveView activeView)
                        throws java.io.IOException,
                               AutomationException
The active view.

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

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
Specified by:
getActivatedView in interface IMxDocument
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.

getActiveViewCommand

public ICommand getActiveViewCommand()
                              throws java.io.IOException,
                                     AutomationException
The command associated with the active view.

Specified by:
getActiveViewCommand in interface IMxDocument
Returns:
A reference to a com.esri.arcgis.systemUI.ICommand
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
Specified by:
getFocusMap in interface IMxDocument
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.

getSelectedLayer

public ILayer getSelectedLayer()
                        throws java.io.IOException,
                               AutomationException
The selected layer in the layer control.

Specified by:
getSelectedLayer in interface IBasicDocument
Specified by:
getSelectedLayer in interface IBasicDocument2
Specified by:
getSelectedLayer in interface IMxDocument
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 IBasicDocument
Specified by:
getSelectedItem in interface IBasicDocument2
Specified by:
getSelectedItem in interface IMxDocument
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 IBasicDocument
Specified by:
getContextItem in interface IBasicDocument2
Specified by:
getContextItem in interface IMxDocument
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 item)
                    throws java.io.IOException,
                           AutomationException
The last item that was right-clicked.

Specified by:
setContextItem in interface IBasicDocument
Specified by:
setContextItem in interface IBasicDocument2
Specified by:
setContextItem in interface IMxDocument
Parameters:
item - A reference to another Object (IUnknown) (in)
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
Specified by:
getStyleGallery in interface IMxDocument
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.

addLayer

public void addLayer(ILayer layer)
              throws java.io.IOException,
                     AutomationException
Adds a layer to the current focus map.

Specified by:
addLayer in interface IBasicDocument
Specified by:
addLayer in interface IBasicDocument2
Specified by:
addLayer in interface IMxDocument
Parameters:
layer - 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 IBasicDocument
Specified by:
updateContents in interface IBasicDocument2
Specified by:
updateContents in interface IMxDocument
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
Specified by:
getSearchTolerance in interface IMxDocument
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 IBasicDocument2
Specified by:
getSearchTolerancePixels in interface IMxDocument
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 IBasicDocument2
Specified by:
setSearchTolerancePixels in interface IMxDocument
Parameters:
tol - The tol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertObject

public void insertObject()
                  throws java.io.IOException,
                         AutomationException
Inserts an object into the document. Displays the insert object dialog.

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

canInsertObject

public void canInsertObject(boolean[] pEnabled)
                     throws java.io.IOException,
                            AutomationException
Indicates if the document allows objects to be inserted.

Specified by:
canInsertObject in interface IMxDocument
Parameters:
pEnabled - The pEnabled (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
Specified by:
getMaps in interface IMxDocument
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
Specified by:
getOperationStack in interface IMxDocument
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.

getDefaultTextFont

public Font getDefaultTextFont()
                        throws java.io.IOException,
                               AutomationException
The default font for text.

Specified by:
getDefaultTextFont in interface IMxDocument
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.

setDefaultTextFontSize

public void setDefaultTextFontSize(IFontSize fontSize)
                            throws java.io.IOException,
                                   AutomationException
The default font size for text.

Specified by:
setDefaultTextFontSize in interface IMxDocument
Parameters:
fontSize - A reference to a com.esri.arcgis.display.IFontSize (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultTextFontSize

public IFontSize getDefaultTextFontSize()
                                 throws java.io.IOException,
                                        AutomationException
The default font size for text.

Specified by:
getDefaultTextFontSize in interface IMxDocument
Returns:
A reference to a com.esri.arcgis.display.IFontSize
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultTextFont

public void setDefaultTextFont(Font fontDisp)
                        throws java.io.IOException,
                               AutomationException
The default font for text.

Specified by:
setDefaultTextFont in interface IMxDocument
Parameters:
fontDisp - 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.

getDefaultColor

public IColor getDefaultColor(int type)
                       throws java.io.IOException,
                              AutomationException
The default color for the given type.

Specified by:
getDefaultColor in interface IMxDocument
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 IMxDocument
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.

getCurrentLocation

public IPoint getCurrentLocation()
                          throws java.io.IOException,
                                 AutomationException
The current mouse location in map units.

Specified by:
getCurrentLocation in interface IBasicDocument2
Specified by:
getCurrentLocation in interface IMxDocument
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
Specified by:
setCurrentLocation in interface IMxDocument
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.

setDelayUpdateContents

public void setDelayUpdateContents(boolean rhs1)
                            throws java.io.IOException,
                                   AutomationException
Indicates document update notifications should be ignored.

Specified by:
setDelayUpdateContents in interface IMxDocument
Parameters:
rhs1 - The rhs1 (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 IMxDocument
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 IMxDocument
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.

getCurrentContentsView

public IContentsView getCurrentContentsView()
                                     throws java.io.IOException,
                                            AutomationException
The current contents view of the document.

Specified by:
getCurrentContentsView in interface IMxDocument
Returns:
A reference to a com.esri.arcgis.arcmapui.IContentsView
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentContentsViewByRef

public void setCurrentContentsViewByRef(IContentsView view)
                                 throws java.io.IOException,
                                        AutomationException
The current contents view of the document.

Specified by:
setCurrentContentsViewByRef in interface IMxDocument
Parameters:
view - 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.

getContentsViewCount

public int getContentsViewCount()
                         throws java.io.IOException,
                                AutomationException
The number of contents views in the document.

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

getContentsView

public IContentsView getContentsView(int index)
                              throws java.io.IOException,
                                     AutomationException
The contents view at the specified index.

Specified by:
getContentsView in interface IMxDocument
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.arcmapui.IContentsView
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 in ArcMap.

Specified by:
getTableProperties in interface IBasicDocument
Specified by:
getTableProperties in interface IBasicDocument2
Specified by:
getTableProperties in interface IMxDocument
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.

setDirty

public void setDirty()
              throws java.io.IOException,
                     AutomationException
Sets the dirty flag on the document.

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

setClean

public void setClean()
              throws java.io.IOException,
                     AutomationException
Resets the dirty flag on the document.

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

applies

public boolean applies(java.lang.Object pUnk)
                throws java.io.IOException,
                       AutomationException
Indicates if the receiver can apply the given object at any given time.

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

canApply

public boolean canApply(java.lang.Object pUnk)
                 throws java.io.IOException,
                        AutomationException
Indicates if the receiver can apply the given object at that particular moment.

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

getCurrent

public java.lang.Object getCurrent(java.lang.Object pUnk)
                            throws java.io.IOException,
                                   AutomationException
The object currently being used.

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

apply

public java.lang.Object apply(java.lang.Object newObject)
                       throws java.io.IOException,
                              AutomationException
Applies the given property to the receiver and returns the old object.

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

changeLayout

public boolean changeLayout()
                     throws java.io.IOException,
                            AutomationException
Indicates if the wizard used to select a new layout is shown.

Specified by:
changeLayout in interface IChangeLayout
Returns:
The changed
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.

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.

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.

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.

getDocumentTitle

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

Specified by:
getDocumentTitle in interface IDocumentInfo
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 IDocumentInfo
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 IDocumentInfo
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 IDocumentInfo
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 IDocumentInfo
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 IDocumentInfo
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 IDocumentInfo
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 IDocumentInfo
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
Comments for the document.

Specified by:
getComments in interface IDocumentInfo
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
Comments for the document.

Specified by:
setComments in interface IDocumentInfo
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 IDocumentInfo
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 IDocumentInfo
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 IDocumentInfo
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 IDocumentInfo
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.

isSavePreview

public boolean isSavePreview()
                      throws java.io.IOException,
                             AutomationException
Indicates if a preview of the document is saved when the document is saved.

Specified by:
isSavePreview in interface IDocumentInfo
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 of the document is saved when the document is saved.

Specified by:
setSavePreview in interface IDocumentInfo
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.

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.

getLatLonFormat

public ILatLonFormat getLatLonFormat()
                              throws java.io.IOException,
                                     AutomationException
The format object used for reporting lat-lon values.

Specified by:
getLatLonFormat in interface IReportUnitFormat
Specified by:
getLatLonFormat in interface IReportUnitFormat2
Returns:
A reference to a com.esri.arcgis.system.ILatLonFormat
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLatLonFormatByRef

public void setLatLonFormatByRef(ILatLonFormat format)
                          throws java.io.IOException,
                                 AutomationException
The format object used for reporting lat-lon values.

Specified by:
setLatLonFormatByRef in interface IReportUnitFormat
Specified by:
setLatLonFormatByRef in interface IReportUnitFormat2
Parameters:
format - A reference to a com.esri.arcgis.system.ILatLonFormat (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumericFormat

public INumberFormat getNumericFormat()
                               throws java.io.IOException,
                                      AutomationException
The format object used for reporting numeric values.

Specified by:
getNumericFormat in interface IReportUnitFormat
Specified by:
getNumericFormat in interface IReportUnitFormat2
Returns:
A reference to a com.esri.arcgis.system.INumberFormat
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNumericFormatByRef

public void setNumericFormatByRef(INumberFormat format)
                           throws java.io.IOException,
                                  AutomationException
The format object used for reporting numeric values.

Specified by:
setNumericFormatByRef in interface IReportUnitFormat
Specified by:
setNumericFormatByRef in interface IReportUnitFormat2
Parameters:
format - A reference to a com.esri.arcgis.system.INumberFormat (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCoordinateReadoutLatLonFormat

public ILatLonFormat getCoordinateReadoutLatLonFormat()
                                               throws java.io.IOException,
                                                      AutomationException
The format used for the coordinate readout on the status bar.

Specified by:
getCoordinateReadoutLatLonFormat in interface IReportUnitFormat2
Returns:
A reference to a com.esri.arcgis.system.ILatLonFormat
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCoordinateReadoutLatLonFormatByRef

public void setCoordinateReadoutLatLonFormatByRef(ILatLonFormat format)
                                           throws java.io.IOException,
                                                  AutomationException
The format used for the coordinate readout on the status bar.

Specified by:
setCoordinateReadoutLatLonFormatByRef in interface IReportUnitFormat2
Parameters:
format - A reference to a com.esri.arcgis.system.ILatLonFormat (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCoordinateReadoutUnits

public int getCoordinateReadoutUnits()
                              throws java.io.IOException,
                                     AutomationException
The units used for the coordinate readout on the status bar. If set to esriUnknown, map display units are used.

Specified by:
getCoordinateReadoutUnits in interface IReportUnitFormat2
Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCoordinateReadoutUnits

public void setCoordinateReadoutUnits(int units)
                               throws java.io.IOException,
                                      AutomationException
The units used for the coordinate readout on the status bar. If set to esriUnknown, map display units are used.

Specified by:
setCoordinateReadoutUnits in interface IReportUnitFormat2
Parameters:
units - A com.esri.arcgis.system.esriUnits constant (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 IMapDocument
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.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
getClassID

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isMapDocument

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

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

isPresent

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

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

isReadOnly

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

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

isRestricted

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

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

isPasswordProtected

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

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

esri_new

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

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

open

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

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

getDocumentFilename

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

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

getDocumentType

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

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

isUsesRelativePaths

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

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

getMapCount

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

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

getMap

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

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

getLayer

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

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

getPrinter

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

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

getThumbnail

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

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

close

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

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

getVersionInfo

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

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

replaceContents

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

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

setActiveView

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

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

save

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

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

saveAs

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

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

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws java.io.IOException,
                                 AutomationException
enumConnectionPoints

Specified by:
enumConnectionPoints in interface IConnectionPointContainer
Parameters:
ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws java.io.IOException,
                                AutomationException
findConnectionPoint

Specified by:
findConnectionPoint in interface IConnectionPointContainer
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD