com.esri.arcgis.carto
Class InvalidArea

java.lang.Object
  com.esri.arcgis.carto.InvalidArea

All Implemented Interfaces:

IInvalidArea2, IInvalidArea3, IInvalidArea, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class InvalidArea
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IInvalidArea, IInvalidArea2, IInvalidArea3

Accumulates a region from multiple objects and invalidates this area on the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

InvalidArea()
Constructs a InvalidArea using ArcGIS Engine.

InvalidArea(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
InvalidArea theInvalidArea = (InvalidArea) obj;

Method Summary

void	add(Object thing) Add IFeature, IGeometry, ISet, or IEnumFeature.
void	addFeature(IFeature feature, ISymbol symbol) Invalidates the area occupied by the feature, using the symbolol specified.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
IScreenDisplay	getDisplay() The display that will be invalidated.
int	hashCode() the hashcode for this object
void	invalidate(short screenCache) Invalidate the display.
void	invalidateEx(short screenCache, double symSizePoints) Invalidates the display and considers a symbol's size in points.
void	setDisplayByRef(IScreenDisplay dpy) The display that will be invalidated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

InvalidArea

public InvalidArea()
            throws IOException,
                   UnknownHostException

Constructs a InvalidArea using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

InvalidArea

public InvalidArea(Object obj)
            throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
InvalidArea theInvalidArea = (InvalidArea) obj;

Construct a InvalidArea using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to InvalidArea.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getDisplay

public IScreenDisplay getDisplay()
                          throws IOException,
                                 AutomationException

The display that will be invalidated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDisplay in interface IInvalidArea

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayByRef

public void setDisplayByRef(IScreenDisplay dpy)
                     throws IOException,
                            AutomationException

The display that will be invalidated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDisplayByRef in interface IInvalidArea

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

public void add(Object thing)
         throws IOException,
                AutomationException

Add IFeature, IGeometry, ISet, or IEnumFeature.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

add in interface IInvalidArea

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

invalidate

public void invalidate(short screenCache)
                throws IOException,
                       AutomationException

Invalidate the display.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

invalidate in interface IInvalidArea

Parameters:

screenCache - The screenCache (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addFeature

public void addFeature(IFeature feature,
                       ISymbol symbol)
                throws IOException,
                       AutomationException

Invalidates the area occupied by the feature, using the symbolol specified.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

addFeature in interface IInvalidArea2

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

invalidateEx

public void invalidateEx(short screenCache,
                         double symSizePoints)
                  throws IOException,
                         AutomationException

Invalidates the display and considers a symbol's size in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

invalidateEx in interface IInvalidArea3

Parameters:

screenCache - The screenCache (in)

symSizePoints - The symSizePoints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.