com.esri.arcgis.carto
Interface IViewRefresh

All Superinterfaces:

Serializable

All Known Implementing Classes:

Map, PageLayout

public interface IViewRefresh
extends Serializable

Provides access to members that are useful for refreshing views.

Product Availability

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

Method Summary

void	animationRefresh(int phase, Object data, IEnvelope envelope) Use to quickly redraw a phase that has it's own cache, i.e., a tracking layer.
void	animationRefreshShape(int phase, Object data, IGeometry geometry, double symbolSizePoints) Use to quickly redraw a phase that has it's own cache, i.e., a tracking layer.
boolean	isDrawing() Indicates whether the view is currently drawing or not.
boolean	isProgressiveDrawing() Indicates whether the view should progressively update the window during drawing.
void	partialRefresh(int phase, Object data, IEnvelope envelope) Draws the specified view phase.
void	partialRefreshShape(int phase, Object data, IGeometry geometry, double symbolSizePoints) Refreshes the specified shape on the specified view phase.
void	refresh() Causes the entire view to draw.
void	refreshCaches() Reallocate the display caches.
void	refreshItem(Object data) Use to redraw a specific item and the content above it.
void	setProgressiveDrawing(boolean flag) Indicates whether the view should progressively update the window during drawing.

Method Detail

isDrawing

boolean isDrawing()
                  throws IOException,
                         AutomationException

Indicates whether the view is currently drawing or not.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The drawing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isProgressiveDrawing

boolean isProgressiveDrawing()
                             throws IOException,
                                    AutomationException

Indicates whether the view should progressively update the window during drawing. False means just update the window once when all rendering is complete.

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.

setProgressiveDrawing

void setProgressiveDrawing(boolean flag)
                           throws IOException,
                                  AutomationException

Indicates whether the view should progressively update the window during drawing. False means just update the window once when all rendering is complete.

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.

refresh

void refresh()
             throws IOException,
                    AutomationException

Causes the entire view to draw.

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.

partialRefresh

void partialRefresh(int phase,
                    Object data,
                    IEnvelope envelope)
                    throws IOException,
                           AutomationException

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

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)

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

partialRefreshShape

void partialRefreshShape(int phase,
                         Object data,
                         IGeometry geometry,
                         double symbolSizePoints)
                         throws IOException,
                                AutomationException

Refreshes the specified shape on the specified view phase. Use symbolSizePoints to indicate point and line sizes.

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)

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

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

symbolSizePoints - The symbolSizePoints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

animationRefresh

void animationRefresh(int phase,
                      Object data,
                      IEnvelope envelope)
                      throws IOException,
                             AutomationException

Use to quickly redraw a phase that has it's own cache, i.e., a tracking layer. Tradeoffs are made to ensure fast redrawing at the expense of quality.

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)

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

animationRefreshShape

void animationRefreshShape(int phase,
                           Object data,
                           IGeometry geometry,
                           double symbolSizePoints)
                           throws IOException,
                                  AutomationException

Use to quickly redraw a phase that has it's own cache, i.e., a tracking layer. Tradeoffs are made to ensure fast redrawing at the expense of quality. See PartialRefreshShape for more info.

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)

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

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

symbolSizePoints - The symbolSizePoints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshItem

void refreshItem(Object data)
                 throws IOException,
                        AutomationException

Use to redraw a specific item and the content above it. When adding items to the view (i.e., layers or graphics). Refresh can be optimized by only drawing the newly added items.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshCaches

void refreshCaches()
                   throws IOException,
                          AutomationException

Reallocate the display caches. Causes a full redraw. Normally caches are automatically maintained. Use this sparingly when programatically changing attributes that affect caching such as ILayer::Cached flag.

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.