com.esri.arcgis.datasourcesraster
Class CancelListener

java.lang.Object
  com.esri.arcgis.datasourcesraster.CancelListener

All Implemented Interfaces:

ICancelListener, IRasterStatusEvent2, com.esri.arcgis.interop.RemoteObjRef, Serializable, EventListener

public class CancelListener
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterStatusEvent2, ICancelListener

A raster status event listener for handling cancel events.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

CancelListener()
Constructs a CancelListener using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
void	esri_continue(IRasterStatusEvent2Esri_continueEvent theEvent) Indicates whether the operation should be continued.
ITrackCancel	getCancelTracker() The current cancel tracker.
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
void	message(IRasterStatusEvent2MessageEvent theEvent) The message of the event.
void	setCancelTrackerByRef(ITrackCancel ppCancel) The current cancel tracker.
void	title(IRasterStatusEvent2TitleEvent theEvent) The title of the event.

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

CancelListener

public CancelListener()
               throws IOException,
                      UnknownHostException

Constructs a CancelListener using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

CancelListener

public CancelListener(Object obj)
               throws IOException

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

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

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

title

public void title(IRasterStatusEvent2TitleEvent theEvent)
           throws IOException,
                  AutomationException

The title of the event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

title in interface IRasterStatusEvent2

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

message

public void message(IRasterStatusEvent2MessageEvent theEvent)
             throws IOException,
                    AutomationException

The message of the event.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

message in interface IRasterStatusEvent2

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_continue

public void esri_continue(IRasterStatusEvent2Esri_continueEvent theEvent)
                   throws IOException,
                          AutomationException

Indicates whether the operation should be continued.

Product Availability

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

Specified by:

esri_continue in interface IRasterStatusEvent2

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCancelTracker

public ITrackCancel getCancelTracker()
                              throws IOException,
                                     AutomationException

The current cancel tracker.

Product Availability

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

Specified by:

getCancelTracker in interface ICancelListener

Returns:

A reference to a com.esri.arcgis.system.ITrackCancel

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCancelTrackerByRef

public void setCancelTrackerByRef(ITrackCancel ppCancel)
                           throws IOException,
                                  AutomationException

The current cancel tracker.

Product Availability

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

Specified by:

setCancelTrackerByRef in interface ICancelListener

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.