com.esri.arcgis.system
Interface ITrackCancel

All Superinterfaces:

Serializable

All Known Subinterfaces:

ITrackCancel2

All Known Implementing Classes:

CancelTracker, GPServerTrackCancel, ITrackCancel2Proxy, ITrackCancelProxy, ThreadedJobTrackCancel, TrackCancel

public interface ITrackCancel
extends Serializable

Provides access to members that control the Cancel Tracker.

Description

The CancelTracker object is the object used by ArcObjects to monitor the Esc key (optionally, the space bar and mouse clicks as well) and to terminate processes at the request of the user. A CancelTracker is typically handed into or created just prior to functions that execute a lengthy operation such as, printing, exporting and drawing.

The ITrackCancel interface provides access to properties and methods that determine if a cancellation has been executed by the user, and also allows developers to specify what actions constitute a cancellation.

Product Availability

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

Method Summary

void	cancel() Cancels the associated operation.
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.
IProgressor	getProgressor() The progressor used to show progress during lengthy operations.
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	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	startTimer(int hWnd, int milliseconds) An obsolete method.
void	stopTimer() An obsolete method.

Method Detail

setCheckTime

void setCheckTime(int milliseconds)
                  throws IOException,
                         AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

milliseconds - The milliseconds (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCheckTime

int getCheckTime()
                 throws IOException,
                        AutomationException

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

Description

The CheckTime property indicates the frequency the CancelTracker will process any pending Windows (mouse and keyboard) messages. By default the CheckTime is 1000 milliseconds.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The milliseconds

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProgressor

void setProgressor(IProgressor progressor)
                   throws IOException,
                          AutomationException

The progressor used to show progress during lengthy operations.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProgressor

IProgressor getProgressor()
                          throws IOException,
                                 AutomationException

The progressor used to show progress during lengthy operations.

Description

Use the Progressor property to bind the CancelTracker with a progress object (for example, a progress bar, a progress dialog or a progress animation) that displays the progress of the lengthy operation. Once the Progressor has been set it will be updated automatically as the operation is executed.

Remarks

If the progressor is a step progressor, the MaxRange should be set to equal the number of iterations that the operation will progress through; this number should also match the number of times Continue will be called in the operation’s innermost loop.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancel

void cancel()
            throws IOException,
                   AutomationException

Cancels the associated operation.

Description

By default a cancel will occur under the following circumstances:

• The Esc key was pressed.
• The space bar was pressed. Use the CancelOnKeyPress property to disable this action.
• The left or right mouse button was pressed. Use the CancelOnClick property to disable this action.

Whether a cancel occurs will depend on when the key or button was pressed and the CheckTime property. For example, if a map redraw was cancelled by a key press then it is possible that some phases of the redraw will complete before the key press is handled.

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.

reset

void reset()
           throws IOException,
                  AutomationException

Resets the manager after the associated operation is finished.

Description

The Reset method should be called just before a process that may be cancelled, such as a lengthy operation, begins. The Reset method sets the state of the CancelTracker to uncancelled and returns the internal counter, which is used to update the Progressor to zero.

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.

esri_continue

boolean esri_continue()
                      throws IOException,
                             AutomationException

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

Product Availability

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

Returns:

The keepGoing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProcessMessages

void setProcessMessages(boolean processMessages)
                        throws IOException,
                               AutomationException

An obsolete method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

processMessages - The processMessages (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isProcessMessages

boolean isProcessMessages()
                          throws IOException,
                                 AutomationException

An obsolete method.

Description

Do not use this method as it is obsolete.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The processMessages

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startTimer

void startTimer(int hWnd,
                int milliseconds)
                throws IOException,
                       AutomationException

An obsolete method.

Description

Do not use this method as it is obsolete.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

hWnd - The hWnd (in)

milliseconds - The milliseconds (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTimerFired

boolean isTimerFired()
                     throws IOException,
                            AutomationException

An obsolete method.

Description

Do not use this method as it is obsolete.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The timerFired

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopTimer

void stopTimer()
               throws IOException,
                      AutomationException

An obsolete method.

Description

Do not use this method as it is obsolete.

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.

isCancelOnClick

boolean isCancelOnClick()
                        throws IOException,
                               AutomationException

Indicates whether mouse clicks should cancel the operation.

Description

Indicates whether the user can use the left and right mouse buttons to cancel the operation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pCancelOnClick

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCancelOnClick

void setCancelOnClick(boolean pCancelOnClick)
                      throws IOException,
                             AutomationException

Indicates whether mouse clicks should cancel the operation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pCancelOnClick - The pCancelOnClick (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCancelOnKeyPress

boolean isCancelOnKeyPress()
                           throws IOException,
                                  AutomationException

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

Description

Indicates whether the user can use the space bar to cancel the operation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The pCancelOnKeyPress

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCancelOnKeyPress

void setCancelOnKeyPress(boolean pCancelOnKeyPress)
                         throws IOException,
                                AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

pCancelOnKeyPress - The pCancelOnKeyPress (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.