com.esri.arcgis.geodatabase
Interface IInvalidArea

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IInvalidArea2, IInvalidArea3

All Known Implementing Classes:

IInvalidArea2Proxy, IInvalidArea3Proxy, IInvalidAreaProxy, InvalidArea

public interface IInvalidArea

extends java.io.Serializable

Provides access to members that modify an invalidated area object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

When To Use

To avoid graphical artifacts on the screen, instead of invalidating (refreshing) the entire display each time the rendered objects change, use this interface to create a collection of objects whose envelopes can be invalidated with one call. For example, when rotating features, use Add to add the selected features to the collection, perform the rotate operation, then call Invalidate . The same objects can be added again after the operation so that the new region is also invalidated. In summary, call Invalidate once at the end of an operation to refresh the screen within the envelopes bounding the objects that were added using the Add method.

Method Summary

void	add(java.lang.Object thing) Add IFeature, IGeometry, ISet, or IEnumFeature.
IScreenDisplay	getDisplay() The display that will be invalidated.
void	invalidate(short screenCache) Invalidate the display.
void	setDisplayByRef(IScreenDisplay dpy) The display that will be invalidated.

Method Detail

getDisplay

public IScreenDisplay getDisplay()
                          throws java.io.IOException,
                                 AutomationException

The display that will be invalidated.

Supported Platforms

Windows, Solaris, Linux

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.

setDisplayByRef

public void setDisplayByRef(IScreenDisplay dpy)
                     throws java.io.IOException,
                            AutomationException

The display that will be invalidated.

Parameters:

dpy - A reference to a com.esri.arcgis.display.IScreenDisplay (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add

public void add(java.lang.Object thing)
         throws java.io.IOException,
                AutomationException

Add IFeature, IGeometry, ISet, or IEnumFeature.

Supported Platforms

Windows, Solaris, Linux

Remarks

This method allows you to add the following object types as a collection of regions whose envelopes can be invalidated (refreshed) with the Invalidate method : ISet, IGeometry, IFeature, and IEnumFeature.

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

invalidate

public void invalidate(short screenCache)
                throws java.io.IOException,
                       AutomationException

Invalidate the display.

Supported Platforms

Windows, Solaris, Linux

Remarks

This method invalidates (refreshes) the screen in the regions specified by a collection of envelopes belonging to the objects added with this interface's Add method. The input parameter is typically the Editor's Display property, and defines the display that must be invalidated.

Parameters:

screenCache - The screenCache (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.