com.esri.arcgis.display
Class CancelTracker

java.lang.Object
  com.esri.arcgis.display.CancelTracker

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ITrackCancel, ITrackCancel2, java.io.Serializable

public class CancelTracker
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITrackCancel, ITrackCancel2

COM Class 'CancelTracker'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description 'Cancel tracker class for interrupting drawing.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.system.ITrackCancel2

IID, IID73f93cba_5d93_4d2d_b27e_30eeb4ca3b64, xxDummy

Fields inherited from interface com.esri.arcgis.system.ITrackCancel

IID34c20005_4d3c_11d0_92d8_00805f7c28b0

Constructor Summary

CancelTracker()
Constructs a CancelTracker using ArcGIS Engine.

CancelTracker(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CancelTracker theCancelTracker = (CancelTracker) obj;

Method Summary

void	cancel() Cancels the associated operation.
boolean	equals(java.lang.Object o) Compare this object with another
boolean	esri_continue() Called frequently while associated operation is progressing.
int	getCheckTime() The interval at which the operation will be interrupted to advance progressors and process messages.
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IProgressor	getProgressor() The progressor used to show progress during lengthy operations.
int	getTimeout() The time out in ms interval for a lengthy operation.
int	hashCode() the hashcode for this object
boolean	isCancelOnClick() Indicates whether mouse clicks should cancel the operation.
boolean	isCancelOnKeyPress() Indicates whether the escape key and spacebar should cancel the operation.
boolean	isProcessMessages() An obsolete method.
boolean	isTimerFired() An obsolete method.
void	release() Release a CancelTracker.
void	reset() Resets the manager after the associated operation is finished.
void	setCancelOnClick(boolean pCancelOnClick) Indicates whether mouse clicks should cancel the operation.
void	setCancelOnKeyPress(boolean pCancelOnKeyPress) Indicates whether the escape key and spacebar should cancel the operation.
void	setCheckTime(int milliseconds) The interval at which the operation will be interrupted to advance progressors and process messages.
void	setProcessMessages(boolean processMessages) An obsolete method.
void	setProgressor(IProgressor progressor) The progressor used to show progress during lengthy operations.
void	setTimeout(int timeoutMS) The time out in ms interval for a lengthy operation.
void	startTimer(int hWnd, int milliseconds) An obsolete method.
void	stopTimer() An obsolete method.
void	trackMouseMove(boolean bYesNo) Turns on/off tracking of mouse movements.
void	trackNavigationKeys(boolean bYesNo) Turns on/off tracking of navigation keys.

Methods inherited from class java.lang.Object

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

Constructor Detail

CancelTracker

public CancelTracker()
              throws java.io.IOException,
                     java.net.UnknownHostException

Constructs a CancelTracker using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

CancelTracker

public CancelTracker(java.lang.Object obj)
              throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a CancelTracker.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setCheckTime

public void setCheckTime(int milliseconds)
                  throws java.io.IOException,
                         AutomationException

The interval at which the operation will be interrupted to advance progressors and process messages.

Specified by:

setCheckTime in interface ITrackCancel

Parameters:

milliseconds - The milliseconds (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCheckTime

public int getCheckTime()
                 throws java.io.IOException,
                        AutomationException

The interval at which the operation will be interrupted to advance progressors and process messages.

Specified by:

getCheckTime in interface ITrackCancel

Returns:

The milliseconds

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProgressor

public void setProgressor(IProgressor progressor)
                   throws java.io.IOException,
                          AutomationException

The progressor used to show progress during lengthy operations.

Specified by:

setProgressor in interface ITrackCancel

Parameters:

progressor - A reference to a com.esri.arcgis.system.IProgressor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProgressor

public IProgressor getProgressor()
                          throws java.io.IOException,
                                 AutomationException

The progressor used to show progress during lengthy operations.

Specified by:

getProgressor in interface ITrackCancel

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

cancel

public void cancel()
            throws java.io.IOException,
                   AutomationException

Cancels the associated operation.

Specified by:

cancel in interface ITrackCancel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws java.io.IOException,
                  AutomationException

Resets the manager after the associated operation is finished.

Specified by:

reset in interface ITrackCancel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_continue

public boolean esri_continue()
                      throws java.io.IOException,
                             AutomationException

Called frequently while associated operation is progressing. A return value of false indicates that the operation should stop.

Specified by:

esri_continue in interface ITrackCancel

Returns:

The keepGoing

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProcessMessages

public void setProcessMessages(boolean processMessages)
                        throws java.io.IOException,
                               AutomationException

An obsolete method.

Specified by:

setProcessMessages in interface ITrackCancel

Parameters:

processMessages - The processMessages (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isProcessMessages

public boolean isProcessMessages()
                          throws java.io.IOException,
                                 AutomationException

An obsolete method.

Specified by:

isProcessMessages in interface ITrackCancel

Returns:

The processMessages

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startTimer

public void startTimer(int hWnd,
                       int milliseconds)
                throws java.io.IOException,
                       AutomationException

An obsolete method.

Specified by:

startTimer in interface ITrackCancel

Parameters:

hWnd - The hWnd (in)

milliseconds - The milliseconds (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isTimerFired

public boolean isTimerFired()
                     throws java.io.IOException,
                            AutomationException

An obsolete method.

Specified by:

isTimerFired in interface ITrackCancel

Returns:

The timerFired

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stopTimer

public void stopTimer()
               throws java.io.IOException,
                      AutomationException

An obsolete method.

Specified by:

stopTimer in interface ITrackCancel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCancelOnClick

public boolean isCancelOnClick()
                        throws java.io.IOException,
                               AutomationException

Indicates whether mouse clicks should cancel the operation.

Specified by:

isCancelOnClick in interface ITrackCancel

Returns:

The pCancelOnClick

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCancelOnClick

public void setCancelOnClick(boolean pCancelOnClick)
                      throws java.io.IOException,
                             AutomationException

Indicates whether mouse clicks should cancel the operation.

Specified by:

setCancelOnClick in interface ITrackCancel

Parameters:

pCancelOnClick - The pCancelOnClick (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCancelOnKeyPress

public boolean isCancelOnKeyPress()
                           throws java.io.IOException,
                                  AutomationException

Indicates whether the escape key and spacebar should cancel the operation.

Specified by:

isCancelOnKeyPress in interface ITrackCancel

Returns:

The pCancelOnKeyPress

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCancelOnKeyPress

public void setCancelOnKeyPress(boolean pCancelOnKeyPress)
                         throws java.io.IOException,
                                AutomationException

Indicates whether the escape key and spacebar should cancel the operation.

Specified by:

setCancelOnKeyPress in interface ITrackCancel

Parameters:

pCancelOnKeyPress - The pCancelOnKeyPress (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeout

public void setTimeout(int timeoutMS)
                throws java.io.IOException,
                       AutomationException

The time out in ms interval for a lengthy operation. The negative value means no timeout.

Specified by:

setTimeout in interface ITrackCancel2

Parameters:

timeoutMS - The timeoutMS (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeout

public int getTimeout()
               throws java.io.IOException,
                      AutomationException

The time out in ms interval for a lengthy operation. The negative value means no timeout.

Specified by:

getTimeout in interface ITrackCancel2

Returns:

The timeoutMS

Throws:

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

AutomationException - If the ArcObject component throws an exception.

trackMouseMove

public void trackMouseMove(boolean bYesNo)
                    throws java.io.IOException,
                           AutomationException

Turns on/off tracking of mouse movements. If bYesNo is true, the cancel is triggered by the mouse move.

Specified by:

trackMouseMove in interface ITrackCancel2

Parameters:

bYesNo - The bYesNo (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

trackNavigationKeys

public void trackNavigationKeys(boolean bYesNo)
                         throws java.io.IOException,
                                AutomationException

Turns on/off tracking of navigation keys. If bYesNo is true, the cancel is triggered by the navigation key press.

Specified by:

trackNavigationKeys in interface ITrackCancel2

Parameters:

bYesNo - The bYesNo (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.