com.esri.arcgis.systemUI
Class IProgressDialogProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.systemUI.IProgressDialogProxy
All Implemented Interfaces:
IProgressDialog, Externalizable, Serializable

public class IProgressDialogProxy
extends com.esri.arcgis.interop.Dispatch
implements IProgressDialog, Serializable

Provides access to members that work with a progress dialog.

Superseded By

IProgressDialog2

Description

Instead of reporting the progress of an operation in the status bar of an ArcGIS application window, you can display a progress dialog box instead. The progress dialog box displays an animation and a step progress bar.

The IProgressDialogFactory::Create method to create and display a progress dialog box. Pass a CancelTracker object to the Create method to allow the user to cancel the process.

The IProgressDialog interface is the original interface for the progress dialog box. However, you should use the more recent IProgressDialog2 interface instead.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IProgressDialogProxy()
           
  IProgressDialogProxy(Object obj)
           
protected IProgressDialogProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void hideDialog()
          Hides the progress dialog.
 boolean isCancelEnabled()
          Indicates if the cancel button is enabled.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void setCancelEnabled(boolean bVal)
          Indicates if the cancel button is enabled.
 void showDialog()
          Shows the progress dialog.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IProgressDialogProxy

public IProgressDialogProxy()

IProgressDialogProxy

public IProgressDialogProxy(Object obj)
                     throws IOException
Throws:
IOException

IProgressDialogProxy

protected IProgressDialogProxy(Object obj,
                               String iid)
                        throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

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 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 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 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 IProgressDialog
Parameters:
bVal - The bVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException