com.esri.arcgis.carto
Interface IMapAdmin3

All Superinterfaces:

Serializable

All Known Implementing Classes:

Map

public interface IMapAdmin3
extends Serializable

Provides access to Map administration methods.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

boolean	completeRedrawNeeded() Check if a complete redraw is needed.
void	fireAfterDraw(int hDC) Fire AfterDraw(esriViewForeground) event.
void	fireChangeFeatureClass(IFeatureClass oldClass, IFeatureClass newClass) Notifies listeners that the a layer's class has changed.
void	fireChangeTable(ITable oldTable, ITable newTable) Notifies listeners that the a layer's class has changed.
void	fireChangeVersion(IVersion oldVersion, IVersion newVersion) Notifies listeners that a version in the map changed.
void	fireLayerAdded(ILayer layer) Notifies listeners that a layer has been added to the map.
void	fireLayerDeleted(ILayer layer) Notifies listeners that a layer has been removed from the map.
void	fireLayerReordered(ILayer layer, int toIndex) Notifies listeners that a layer has been reordered the map.
void	forceGraphicSelectionDraw() Call before using Output to cause graphic selection to be drawn.
IBackground	getNonFrameBackground() Specify the background to use when drawing to destinations other than a frame.
void	setClipBounds(IGeometry rhs1) Specify a boundary to clip to.
void	setNonFrameBackgroundByRef(IBackground background) Specify the background to use when drawing to destinations other than a frame.
void	suppressForegroundDraw() Call before using Output to prevent AfterDraw(esriViewForeground) from being fired.

Method Detail

setNonFrameBackgroundByRef

void setNonFrameBackgroundByRef(IBackground background)
                                throws IOException,
                                       AutomationException

Specify the background to use when drawing to destinations other than a frame.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

background - A reference to a com.esri.arcgis.carto.IBackground (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNonFrameBackground

IBackground getNonFrameBackground()
                                  throws IOException,
                                         AutomationException

Specify the background to use when drawing to destinations other than a frame.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClipBounds

void setClipBounds(IGeometry rhs1)
                   throws IOException,
                          AutomationException

Specify a boundary to clip to. Frame uses this to clip to border.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

rhs1 - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fireAfterDraw

void fireAfterDraw(int hDC)
                   throws IOException,
                          AutomationException

Fire AfterDraw(esriViewForeground) event.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

hDC - The hDC (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fireChangeVersion

void fireChangeVersion(IVersion oldVersion,
                       IVersion newVersion)
                       throws IOException,
                              AutomationException

Notifies listeners that a version in the map changed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

oldVersion - A reference to a com.esri.arcgis.geodatabase.IVersion (in)

newVersion - A reference to a com.esri.arcgis.geodatabase.IVersion (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fireChangeFeatureClass

void fireChangeFeatureClass(IFeatureClass oldClass,
                            IFeatureClass newClass)
                            throws IOException,
                                   AutomationException

Notifies listeners that the a layer's class has changed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

oldClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

newClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fireChangeTable

void fireChangeTable(ITable oldTable,
                     ITable newTable)
                     throws IOException,
                            AutomationException

Notifies listeners that the a layer's class has changed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

oldTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

newTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

completeRedrawNeeded

boolean completeRedrawNeeded()
                             throws IOException,
                                    AutomationException

Check if a complete redraw is needed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

forceGraphicSelectionDraw

void forceGraphicSelectionDraw()
                               throws IOException,
                                      AutomationException

Call before using Output to cause graphic selection to be drawn.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

suppressForegroundDraw

void suppressForegroundDraw()
                            throws IOException,
                                   AutomationException

Call before using Output to prevent AfterDraw(esriViewForeground) from being fired.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fireLayerDeleted

void fireLayerDeleted(ILayer layer)
                      throws IOException,
                             AutomationException

Notifies listeners that a layer has been removed from the map.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fireLayerAdded

void fireLayerAdded(ILayer layer)
                    throws IOException,
                           AutomationException

Notifies listeners that a layer has been added to the map.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fireLayerReordered

void fireLayerReordered(ILayer layer,
                        int toIndex)
                        throws IOException,
                               AutomationException

Notifies listeners that a layer has been reordered the map.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

toIndex - The toIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.