com.esri.arcgis.carto
Interface IViewManager

All Superinterfaces:

Serializable

All Known Implementing Classes:

Map, PageLayout

public interface IViewManager
extends Serializable

Provides access to members used to describe or define view behavior.

Remarks

IViewManager is a low-level interface to the properties defining the behavior of the active view.

One commonly used property managed by the IViewManager interface is VerboseEvents. When VerboseEvents is set to False, the default, IActiveViewEvents::AfterItemDraw, is not fired. To listen for this event, you must set VerboseEvents equal to True.

Product Availability

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

Method Summary

ISelection	getElementSelection() Object to use for element selection.
int	getOutputBandSize() Size allocated for each band when banding output.
int	getTopFilterIndex() Phase index that supplements TopFilterPhase.
int	getTopFilterPhase() The highest phase in the drawing order that uses a display filter.
boolean	isConserveMemory() Indicates whether to be conservative when allocating resources.
boolean	isDelayBackgroundDraw() Indicates if the background should draw immediately.
boolean	isExternalDrawing(int phase) Indicates if external clients are drawing in response to the specified phase.
boolean	isUsesPageCoordinates() Indicates whether view uses page coordinates.
boolean	isVerboseEvents() Indicates whether to expand or limit the number of events that are fired.
void	setConserveMemory(boolean flag) Indicates whether to be conservative when allocating resources.
void	setDelayBackgroundDraw(boolean flag) Indicates if the background should draw immediately.
void	setElementSelectionByRef(ISelection selectionObject) Object to use for element selection.
void	setExternalDrawing(int phase, boolean externalDrawing) Indicates if external clients are drawing in response to the specified phase.
void	setOutputBandSize(int kilobytes) Size allocated for each band when banding output.
void	setTopFilterIndex(int phaseIndex) Phase index that supplements TopFilterPhase.
void	setTopFilterPhase(int phase) The highest phase in the drawing order that uses a display filter.
void	setVerboseEvents(boolean verboseEvents) Indicates whether to expand or limit the number of events that are fired.

Method Detail

setElementSelectionByRef

void setElementSelectionByRef(ISelection selectionObject)
                              throws IOException,
                                     AutomationException

Object to use for element selection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IActiveView.getSelection()

getElementSelection

ISelection getElementSelection()
                               throws IOException,
                                      AutomationException

Object to use for element selection.

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.ISelection

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IGraphicsContainerSelect.getSelectedElements()

setConserveMemory

void setConserveMemory(boolean flag)
                       throws IOException,
                              AutomationException

Indicates whether to be conservative when allocating resources.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isConserveMemory

boolean isConserveMemory()
                         throws IOException,
                                AutomationException

Indicates whether to be conservative when allocating resources.

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.

setTopFilterPhase

void setTopFilterPhase(int phase)
                       throws IOException,
                              AutomationException

The highest phase in the drawing order that uses a display filter. Clients should set this when they draw in response to AfterDraw and they use a display filter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTopFilterPhase

int getTopFilterPhase()
                      throws IOException,
                             AutomationException

The highest phase in the drawing order that uses a display filter. Clients should set this when they draw in response to AfterDraw and they use a display filter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.esriViewDrawPhase constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTopFilterIndex

void setTopFilterIndex(int phaseIndex)
                       throws IOException,
                              AutomationException

Phase index that supplements TopFilterPhase. Clients should set the item index here if they draw in response to AfterDrawItem and they use a display filter. TopFilterPhase must also be specified.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

phaseIndex - The phaseIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTopFilterIndex

int getTopFilterIndex()
                      throws IOException,
                             AutomationException

Phase index that supplements TopFilterPhase. Clients should set the item index here if they draw in response to AfterDrawItem and they use a display filter. TopFilterPhase must also be specified.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The phaseIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputBandSize

void setOutputBandSize(int kilobytes)
                       throws IOException,
                              AutomationException

Size allocated for each band when banding output.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

kilobytes - The kilobytes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputBandSize

int getOutputBandSize()
                      throws IOException,
                             AutomationException

Size allocated for each band when banding output.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The kilobytes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUsesPageCoordinates

boolean isUsesPageCoordinates()
                              throws IOException,
                                     AutomationException

Indicates whether view uses page coordinates.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The usesPageCoordinates

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVerboseEvents

boolean isVerboseEvents()
                        throws IOException,
                               AutomationException

Indicates whether to expand or limit the number of events that are fired. The following events are not fired if VerboseEvents is false: AfterItemDraw.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The verboseEvents

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerboseEvents

void setVerboseEvents(boolean verboseEvents)
                      throws IOException,
                             AutomationException

Indicates whether to expand or limit the number of events that are fired. The following events are not fired if VerboseEvents is false: AfterItemDraw.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

verboseEvents - The verboseEvents (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDelayBackgroundDraw

boolean isDelayBackgroundDraw()
                              throws IOException,
                                     AutomationException

Indicates if the background should draw immediately. Set to true to eliminate flashing during animation.

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.

setDelayBackgroundDraw

void setDelayBackgroundDraw(boolean flag)
                            throws IOException,
                                   AutomationException

Indicates if the background should draw immediately. Set to true to eliminate flashing during animation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExternalDrawing

boolean isExternalDrawing(int phase)
                          throws IOException,
                                 AutomationException

Indicates if external clients are drawing in response to the specified phase.

Product Availability

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

Parameters:

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

Returns:

The externalDrawing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExternalDrawing

void setExternalDrawing(int phase,
                        boolean externalDrawing)
                        throws IOException,
                               AutomationException

Indicates if external clients are drawing in response to the specified phase.

Product Availability

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

Parameters:

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

externalDrawing - The externalDrawing (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.