com.esri.arcgis.arcmapui
Class ProgressDialog

java.lang.Object
  com.esri.arcgis.arcmapui.ProgressDialog

All Implemented Interfaces:

IProgressDialog2, com.esri.arcgis.interop.RemoteObjRef, IProgressor, IStepProgressor, IProgressDialog, Serializable

public class ProgressDialog
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IProgressor, IProgressDialog, IProgressDialog2, IStepProgressor

Progress dialog object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

ProgressDialog(Object obj)
Construct a ProgressDialog using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
int	getAnimation() The animation type displayed in the dialog.
String	getDescription() The description displayed in the dialog.
int	getMaxRange() The maximum range of the progression.
String	getMessage() The message displayed by the progressor.
int	getMinRange() The minimum range of the progression.
int	getPosition() The current position of the progression.
int	getStepValue() The step increment of the progression.
String	getTitle() The caption displayed in the dialog.
int	hashCode() the hashcode for this object
void	hide() Hides the progressor.
void	hideDialog() Hides the progress dialog.
boolean	isCancelEnabled() Indicates if the cancel button is enabled.
int	offsetPosition(int offsetValue) Offsets the position of the progression.
void	setAnimation(int type) The animation type displayed in the dialog.
void	setCancelEnabled(boolean bVal) Indicates if the cancel button is enabled.
void	setDescription(String status) The description displayed in the dialog.
void	setMaxRange(int maxRange) The maximum range of the progression.
void	setMessage(String message) The message displayed by the progressor.
void	setMinRange(int minRange) The minimum range of the progression.
void	setPosition(int position) The current position of the progression.
void	setStepValue(int step) The step increment of the progression.
void	setTitle(String title) The caption displayed in the dialog.
void	show() Shows the progressor.
void	showDialog() Shows the progress dialog.
void	step() Animates or steps the progressor.

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

ProgressDialog

public ProgressDialog(Object obj)
               throws IOException

Construct a ProgressDialog using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ProgressDialog.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ProgressDialog o = (ProgressDialog)obj; // will not work

ProgressDialog o = new ProgressDialog(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems ProgressDialog theProgressDialog = (ProgressDialog) obj;

Method Detail

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

setMessage

public 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

Specified by:

setMessage in interface IProgressor

Parameters:

message - The message (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessage

public 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

Specified by:

getMessage in interface IProgressor

Returns:

The message

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

public 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

Specified by:

show in interface IProgressor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

step

public 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

Specified by:

step in interface IProgressor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hide

public 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

Specified by:

hide in interface IProgressor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

showDialog

public void showDialog()
                throws IOException,
                       AutomationException

Shows the progress dialog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

showDialog in interface IProgressDialog2

Specified by:

showDialog in interface IProgressDialog

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hideDialog

public void hideDialog()
                throws IOException,
                       AutomationException

Hides the progress dialog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

hideDialog in interface IProgressDialog2

Specified by:

hideDialog in interface IProgressDialog

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCancelEnabled

public boolean isCancelEnabled()
                        throws IOException,
                               AutomationException

Indicates if the cancel button is enabled.

Description

The CancelEnabled property specifies if the Cancel button is enabled. If CancelEnabled is set to True, you can use the Continue method on the CancelTracker object to determine if the user hit Cancel and the operations should be stopped.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isCancelEnabled in interface IProgressDialog2

Specified by:

isCancelEnabled in interface IProgressDialog

Returns:

The bVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCancelEnabled

public void setCancelEnabled(boolean bVal)
                      throws IOException,
                             AutomationException

Indicates if the cancel button is enabled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setCancelEnabled in interface IProgressDialog2

Specified by:

setCancelEnabled in interface IProgressDialog

Parameters:

bVal - The bVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String status)
                    throws IOException,
                           AutomationException

The description displayed in the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setDescription in interface IProgressDialog2

Parameters:

status - The status (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

The description displayed in the dialog.

Remarks

The Description property can be used to provide the user with information about the process that the dialog box is tracking.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getDescription in interface IProgressDialog2

Returns:

The status

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTitle

public void setTitle(String title)
              throws IOException,
                     AutomationException

The caption displayed in the dialog.

Remarks

The Title property can be used to provide the user with information about the process that the dialog box is tracking.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setTitle in interface IProgressDialog2

Parameters:

title - The title (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTitle

public String getTitle()
                throws IOException,
                       AutomationException

The caption displayed in the dialog.

Remarks

The Title property can be used to provide the user with information about the process that the dialog box is tracking.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getTitle in interface IProgressDialog2

Returns:

The title

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnimation

public void setAnimation(int type)
                  throws IOException,
                         AutomationException

The animation type displayed in the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setAnimation in interface IProgressDialog2

Parameters:

type - A com.esri.arcgis.framework.esriProgressAnimationTypes constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnimation

public int getAnimation()
                 throws IOException,
                        AutomationException

The animation type displayed in the dialog.

Remarks

The Animation property specifies the type of animation displayed in the dialog box. The animation in the dialog box can either be the spinning globe animation or the downloading file animation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getAnimation in interface IProgressDialog2

Returns:

A com.esri.arcgis.framework.esriProgressAnimationTypes constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinRange

public void setMinRange(int minRange)
                 throws IOException,
                        AutomationException

The minimum range of the progression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinRange in interface IStepProgressor

Parameters:

minRange - The minRange (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinRange

public int getMinRange()
                throws IOException,
                       AutomationException

The minimum range of the progression.

Description

The minimum value of the step progressor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinRange in interface IStepProgressor

Returns:

The minRange

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRange

public void setMaxRange(int maxRange)
                 throws IOException,
                        AutomationException

The maximum range of the progression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaxRange in interface IStepProgressor

Parameters:

maxRange - The maxRange (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxRange

public int getMaxRange()
                throws IOException,
                       AutomationException

The maximum range of the progression.

Description

The maximum value of the step progressor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaxRange in interface IStepProgressor

Returns:

The maxRange

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStepValue

public void setStepValue(int step)
                  throws IOException,
                         AutomationException

The step increment of the progression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setStepValue in interface IStepProgressor

Parameters:

step - The step (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStepValue

public int getStepValue()
                 throws IOException,
                        AutomationException

The step increment of the progression.

Description

The increment value taken by the progression with each step.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getStepValue in interface IStepProgressor

Returns:

The step

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPosition

public void setPosition(int position)
                 throws IOException,
                        AutomationException

The current position of the progression.

Description

The current position of the progression between the MinRange and MaxRange values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPosition in interface IStepProgressor

Parameters:

position - The position (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPosition

public int getPosition()
                throws IOException,
                       AutomationException

The current position of the progression.

Description

The current position of the progression between the MinRange and MaxRange values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPosition in interface IStepProgressor

Returns:

The position

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

offsetPosition

public int offsetPosition(int offsetValue)
                   throws IOException,
                          AutomationException

Offsets the position of the progression.

Description

Offsets the current Position by the specified value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

offsetPosition in interface IStepProgressor

Parameters:

offsetValue - The offsetValue (in)

Returns:

The prevPos

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.