com.esri.arcgis.system

Interface ITrackCancel

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ITrackCancel2

All Known Implementing Classes:

ITrackCancel2Proxy, ITrackCancelProxy

public interface ITrackCancel
extends java.io.Serializable

COM Interface 'ITrackCancel'. Generated 9/21/2023 10:01:45 AM from 'X:\ArcGIS\com\server\esriSystem.tlb'

Description: 'Provides access to members that control the Cancel Tracker.' 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 =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID34c20005_4d3c_11d0_92d8_00805f7c28b0
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
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.

Field Detail

IID34c20005_4d3c_11d0_92d8_00805f7c28b0

static final int IID34c20005_4d3c_11d0_92d8_00805f7c28b0

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setCheckTime

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

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

Parameters:

milliseconds - The milliseconds (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCheckTime

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

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

Returns:

The milliseconds

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProgressor

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

The progressor used to show progress during lengthy operations.

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

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

The progressor used to show progress during lengthy operations.

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

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

Cancels the associated operation.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reset

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

Resets the manager after the associated operation is finished.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_continue

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.

Returns:

The keepGoing

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProcessMessages

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

An obsolete method.

Parameters:

processMessages - The processMessages (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isProcessMessages

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

An obsolete method.

Returns:

The processMessages

Throws:

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

AutomationException - If the ArcObject component throws an exception.

startTimer

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

An obsolete method.

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

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

An obsolete method.

Returns:

The timerFired

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stopTimer

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

An obsolete method.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCancelOnClick

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

Indicates whether mouse clicks should cancel the operation.

Returns:

The pCancelOnClick

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCancelOnClick

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

Indicates whether mouse clicks should cancel the operation.

Parameters:

pCancelOnClick - The pCancelOnClick (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCancelOnKeyPress

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

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

Returns:

The pCancelOnKeyPress

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCancelOnKeyPress

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

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

Parameters:

pCancelOnKeyPress - The pCancelOnKeyPress (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.