com.esri.arcgis.system
Interface IProgressor

All Superinterfaces:

Serializable

All Known Subinterfaces:

IAnimationProgressor, ICheckProgressor, IStepProgressor

All Known Implementing Classes:

GPServerTrackCancel, IAnimationProgressorProxy, ICheckProgressorProxy, IProgressorProxy, IStepProgressorProxy, ProgressAnimation, ProgressBar, ProgressDialog

public interface IProgressor
extends Serializable

Provides access to members that report progress.

Description

The IProgressor interface is a generic interface for progressors (for example a progress bar). There are methods to show, step, and hide the progressor and a property to set the message of the progressor.

Product Availability

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

See Also:

IStepProgressor

Method Summary

String	getMessage() The message displayed by the progressor.
void	hide() Hides the progressor.
void	setMessage(String message) The message displayed by the progressor.
void	show() Shows the progressor.
void	step() Animates or steps the progressor.

Method Detail

setMessage

void setMessage(String message)
                throws IOException,
                       AutomationException

The message displayed by the progressor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

message - The message (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessage

String getMessage()
                  throws IOException,
                         AutomationException

The message displayed by the progressor.

Description

This is a generic Message property for progressors (for example a progress bar).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The message

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

void show()
          throws IOException,
                 AutomationException

Shows the progressor.

Description

This is a generic Show method for progressors (for example a progress bar).

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.

step

void step()
          throws IOException,
                 AutomationException

Animates or steps the progressor.

Description

This is a generic Step method for progressors (for example a progress bar).

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.

hide

void hide()
          throws IOException,
                 AutomationException

Hides the progressor.

Description

This is a generic Hide method for progressors (for example a progress bar).

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.