com.esri.arcgis.system
Class ICheckProgressorProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.system.IProgressorProxy
          extended by com.esri.arcgis.system.IStepProgressorProxy
              extended by com.esri.arcgis.system.ICheckProgressorProxy
All Implemented Interfaces:
ICheckProgressor, IProgressor, IStepProgressor, Externalizable, Serializable

public class ICheckProgressorProxy
extends IStepProgressorProxy
implements ICheckProgressor, Serializable

Provides access to members that report progress in stepped increments with checkmarks.

Remarks

Used the ICheckProgressor interface to report progress on the step progress bar in stepped increments with checkmarks.

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
  ICheckProgressorProxy()
           
  ICheckProgressorProxy(Object obj)
           
protected ICheckProgressorProxy(Object obj, String iid)
           
 
Method Summary
 void addCheck(int index, String msg)
          Adds a field that a checkmark can be added to.
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void hideCheck(int index)
          Hides the checkmark.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void showCheck(int index)
          Displays the checkmark.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.system.IStepProgressorProxy
getMaxRange, getMinRange, getPosition, getStepValue, offsetPosition, setMaxRange, setMinRange, setPosition, setStepValue
 
Methods inherited from class com.esri.arcgis.system.IProgressorProxy
getMessage, hide, setMessage, show, step
 
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
 
Methods inherited from interface com.esri.arcgis.system.IStepProgressor
getMaxRange, getMinRange, getPosition, getStepValue, offsetPosition, setMaxRange, setMinRange, setPosition, setStepValue
 
Methods inherited from interface com.esri.arcgis.system.IProgressor
getMessage, hide, setMessage, show, step
 

Constructor Detail

ICheckProgressorProxy

public ICheckProgressorProxy()

ICheckProgressorProxy

public ICheckProgressorProxy(Object obj)
                      throws IOException
Throws:
IOException

ICheckProgressorProxy

protected ICheckProgressorProxy(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 IStepProgressorProxy
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class IStepProgressorProxy
Throws:
IOException

addCheck

public void addCheck(int index,
                     String msg)
              throws IOException,
                     AutomationException
Adds a field that a checkmark can be added to.

Description

Adds a checkmark at the specified index with the specified message.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
addCheck in interface ICheckProgressor
Parameters:
index - The index (in)
msg - The msg (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

showCheck

public void showCheck(int index)
               throws IOException,
                      AutomationException
Displays the checkmark.

Description

Shows the checkmark at the specified index. Use the HideCheck method to hide the checkmark.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
showCheck in interface ICheckProgressor
Parameters:
index - The index (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hideCheck

public void hideCheck(int index)
               throws IOException,
                      AutomationException
Hides the checkmark.

Description

Hides the checkmark at the specified index. Use the ShowCheck method to show the checkmark.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
hideCheck in interface ICheckProgressor
Parameters:
index - The index (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 IStepProgressorProxy
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class IStepProgressorProxy
Throws:
IOException
ClassNotFoundException