com.esri.arcgis.arcmapui
Interface IBasicDocument2

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

GMxDocument, IBasicDocument2Proxy, MxDocument, SxDocument

public interface IBasicDocument2
extends java.io.Serializable

COM Interface 'IBasicDocument2'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriArcMapUI.olb'

Description: 'Provides additional access to members that control the Basic 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 =

Field Summary

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

Method Summary

void	addLayer(ILayer pLayer) Adds a layer to the current focus map or scene.
IActiveView	getActivatedView() The activated view.
java.lang.Object	getContextItem() The last item that was right-clicked.
IPoint	getCurrentLocation() The current mouse location in map units.
IMap	getFocusMap() The current focus map.
IMaps	getMaps() The collection of maps in the document.
IOperationStack	getOperationStack() The operation stack.
IPageLayout	getPageLayout() The page layout.
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.
ITableProperties	getTableProperties() Table properties, for Layers and Tables.
void	setContextItem(java.lang.Object ppItem) The last item that was right-clicked.
void	setCurrentLocation(IPoint mouseLoc) The current mouse location in map units.
void	setPageLayoutByRef(IPageLayout pageLayout) The page layout.
void	setSearchTolerancePixels(int tol) The global search tolerance in pixels for selection.
void	updateContents() Notifies the document that the contents have been updated.

Field Detail

IIDef2ec034_c197_48a0_90ee_c6b7db797eb8

static final int IIDef2ec034_c197_48a0_90ee_c6b7db797eb8

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getSelectedLayer

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

The selected layer in the layer control.

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

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

The selected item in the layer control.

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

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

The last item that was right-clicked.

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

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

The last item that was right-clicked.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addLayer

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

Adds a layer to the current focus map or scene.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateContents

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

Notifies the document that the contents have been updated.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTableProperties

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

Table properties, for Layers and Tables.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPageLayoutByRef

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

The page layout.

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

IPageLayout getPageLayout()
                          throws java.io.IOException,
                                 AutomationException

The page layout.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActivatedView

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.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFocusMap

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

The current focus map.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStyleGallery

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

Reference to the document's Style Gallery.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSearchTolerance

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

The global search tolerance in geographic units for selection.

Returns:

The tol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSearchTolerancePixels

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

The global search tolerance in pixels for selection.

Returns:

The tol

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSearchTolerancePixels

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

The global search tolerance in pixels for selection.

Parameters:

tol - The tol (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaps

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

The collection of maps in the document.

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

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

The operation stack.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentLocation

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

The current mouse location in map units.

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

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

The current mouse location in map units.

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.