com.esri.arcgis.carto
Interface IActiveView

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

Globe, IActiveViewProxy, Map, PageLayout, Scene

public interface IActiveView
extends java.io.Serializable

COM Interface 'IActiveView'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that control the active view - the main application window.' 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	IIDdd94d76b_836d_11d0_87ec_080009ec732a
static int	xxDummy Deprecated. Internal use only

Method Summary

void	activate(int hWnd) Gives this view control of the specified window.
void	clear() Empties the view contents.
void	contentsChanged() Called by clients when view objects are modified.
void	deactivate() Another view takes over the associated window.
void	draw(int hDC, ITrackCancel trackCancel) Draws the view to the specified device context.
void	getContextMenu(double x, double y, IUID[] clsidMenu) Called when a context menu should be displayed at the given xy location.
tagRECT	getExportFrame() The device rectangle to export.
IEnvelope	getExtent() The visible extent rectangle.
IExtentStack	getExtentStack() The extent stack.
IMap	getFocusMap() The map that tools and controls act on.
IEnvelope	getFullExtent() The full extent rectangle.
IGraphicsContainer	getGraphicsContainer() The active graphics container.
short	getScreenCacheID(int phase, java.lang.Object data) The screen cache ID that is used to draw the specified phase.
IScreenDisplay	getScreenDisplay() The screen display used by the view.
ISelection	getSelection() The selection.
java.lang.String	getTipText(double x, double y) The tip text to display at the given location.
IMap	hitTestMap(IPoint location) Returns any maps present in the view at the given location.
boolean	isActive() Indicates if view is active or not.
boolean	isMapActivated() Indicates if the focus map is activated.
boolean	isShowRulers() Indicates if rulers are visible.
boolean	isShowScrollBars() Indicates if scrollbars are visible.
boolean	isShowSelection() Indicates if selection is visible.
void	onMessage(int msg, int wParam, int lParam) Call from your application's message loop to enable automatic resizing and keyboard accelerators.
void	output(int hDC, int dpi, tagRECT pixelBounds, IEnvelope visibleBounds, ITrackCancel trackCancel) Renders the view to the specified DC.
void	partialRefresh(int phase, java.lang.Object data, IEnvelope envelope) Draws the specified view phase.
void	printerChanged(IPrinter printer) Called by application when printer changes.
void	refresh() Causes the entire view to draw.
void	setExtent(IEnvelope extent) The visible extent rectangle.
void	setFocusMapByRef(IMap activeMap) The map that tools and controls act on.
void	setFullExtent(IEnvelope extent) The full extent rectangle.
void	setIsMapActivated(boolean isMapActivated) Indicates if the focus map is activated.
void	setSelectionByRef(ISelection selection) The selection.
void	setShowRulers(boolean showRulers) Indicates if rulers are visible.
void	setShowScrollBars(boolean showScrollBars) Indicates if scrollbars are visible.
void	setShowSelection(boolean showRulers) Indicates if selection is visible.

Field Detail

IIDdd94d76b_836d_11d0_87ec_080009ec732a

static final int IIDdd94d76b_836d_11d0_87ec_080009ec732a

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

getFullExtent

IEnvelope getFullExtent()
                        throws java.io.IOException,
                               AutomationException

The full extent rectangle.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFullExtent

void setFullExtent(IEnvelope extent)
                   throws java.io.IOException,
                          AutomationException

The full extent rectangle.

Parameters:

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtent

IEnvelope getExtent()
                    throws java.io.IOException,
                           AutomationException

The visible extent rectangle.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExtent

void setExtent(IEnvelope extent)
               throws java.io.IOException,
                      AutomationException

The visible extent rectangle.

Parameters:

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getScreenDisplay

IScreenDisplay getScreenDisplay()
                                throws java.io.IOException,
                                       AutomationException

The screen display used by the view.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGraphicsContainer

IGraphicsContainer getGraphicsContainer()
                                        throws java.io.IOException,
                                               AutomationException

The active graphics container.

Returns:

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

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 map that tools and controls act on.

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.

setFocusMapByRef

void setFocusMapByRef(IMap activeMap)
                      throws java.io.IOException,
                             AutomationException

The map that tools and controls act on.

Parameters:

activeMap - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isMapActivated

boolean isMapActivated()
                       throws java.io.IOException,
                              AutomationException

Indicates if the focus map is activated.

Returns:

The isMapActivated

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsMapActivated

void setIsMapActivated(boolean isMapActivated)
                       throws java.io.IOException,
                              AutomationException

Indicates if the focus map is activated.

Parameters:

isMapActivated - The isMapActivated (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSelection

ISelection getSelection()
                        throws java.io.IOException,
                               AutomationException

The selection.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSelectionByRef

void setSelectionByRef(ISelection selection)
                       throws java.io.IOException,
                              AutomationException

The selection.

Parameters:

selection - A reference to a com.esri.arcgis.carto.ISelection (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTipText

java.lang.String getTipText(double x,
                            double y)
                            throws java.io.IOException,
                                   AutomationException

The tip text to display at the given location.

Parameters:

x - The x (in)

y - The y (in)

Returns:

The tipText

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExportFrame

tagRECT getExportFrame()
                       throws java.io.IOException,
                              AutomationException

The device rectangle to export.

Returns:

A Structure: com.esri.arcgis.system.tagRECT

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowScrollBars

boolean isShowScrollBars()
                         throws java.io.IOException,
                                AutomationException

Indicates if scrollbars are visible.

Returns:

The showScrollBars

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowScrollBars

void setShowScrollBars(boolean showScrollBars)
                       throws java.io.IOException,
                              AutomationException

Indicates if scrollbars are visible.

Parameters:

showScrollBars - The showScrollBars (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowRulers

boolean isShowRulers()
                     throws java.io.IOException,
                            AutomationException

Indicates if rulers are visible.

Returns:

The showRulers

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowRulers

void setShowRulers(boolean showRulers)
                   throws java.io.IOException,
                          AutomationException

Indicates if rulers are visible.

Parameters:

showRulers - The showRulers (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowSelection

boolean isShowSelection()
                        throws java.io.IOException,
                               AutomationException

Indicates if selection is visible.

Returns:

The showRulers

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowSelection

void setShowSelection(boolean showRulers)
                      throws java.io.IOException,
                             AutomationException

Indicates if selection is visible.

Parameters:

showRulers - The showRulers (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtentStack

IExtentStack getExtentStack()
                            throws java.io.IOException,
                                   AutomationException

The extent stack.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getScreenCacheID

short getScreenCacheID(int phase,
                       java.lang.Object data)
                       throws java.io.IOException,
                              AutomationException

The screen cache ID that is used to draw the specified phase.

Parameters:

phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in)

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

Returns:

The cacheID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hitTestMap

IMap hitTestMap(IPoint location)
                throws java.io.IOException,
                       AutomationException

Returns any maps present in the view at the given location. Return value may be zero if there are no maps or the coordinate is not over a map.

Parameters:

location - A reference to a com.esri.arcgis.geometry.IPoint (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.

isActive

boolean isActive()
                 throws java.io.IOException,
                        AutomationException

Indicates if view is active or not.

Returns:

The isActive

Throws:

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

AutomationException - If the ArcObject component throws an exception.

activate

void activate(int hWnd)
              throws java.io.IOException,
                     AutomationException

Gives this view control of the specified window.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deactivate

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

Another view takes over the associated window.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

void draw(int hDC,
          ITrackCancel trackCancel)
          throws java.io.IOException,
                 AutomationException

Draws the view to the specified device context.

Parameters:

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

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

output

void output(int hDC,
            int dpi,
            tagRECT pixelBounds,
            IEnvelope visibleBounds,
            ITrackCancel trackCancel)
            throws java.io.IOException,
                   AutomationException

Renders the view to the specified DC.

Parameters:

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

dpi - The dpi (in)

pixelBounds - A Structure: com.esri.arcgis.system.tagRECT (in)

visibleBounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

refresh

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

Causes the entire view to draw.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

partialRefresh

void partialRefresh(int phase,
                    java.lang.Object data,
                    IEnvelope envelope)
                    throws java.io.IOException,
                           AutomationException

Draws the specified view phase. Use an envelope of zero to draw the entire phase.

Parameters:

phase - A com.esri.arcgis.carto.esriViewDrawPhase constant (in)

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

envelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clear

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

Empties the view contents.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

printerChanged

void printerChanged(IPrinter printer)
                    throws java.io.IOException,
                           AutomationException

Called by application when printer changes.

Parameters:

printer - A reference to a com.esri.arcgis.output.IPrinter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

contentsChanged

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

Called by clients when view objects are modified.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onMessage

void onMessage(int msg,
               int wParam,
               int lParam)
               throws java.io.IOException,
                      AutomationException

Call from your application's message loop to enable automatic resizing and keyboard accelerators.

Parameters:

msg - The msg (in)

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContextMenu

void getContextMenu(double x,
                    double y,
                    IUID[] clsidMenu)
                    throws java.io.IOException,
                           AutomationException

Called when a context menu should be displayed at the given xy location. Return menu that should be displayed.

Parameters:

x - The x (in)

y - The y (in)

clsidMenu - A reference to a com.esri.arcgis.system.IUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.