com.esri.arcgis.system
Class IStepProgressorProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.system.IProgressorProxy
          com.esri.arcgis.system.IStepProgressorProxy

All Implemented Interfaces:

IProgressor, IStepProgressor, Externalizable, Serializable

Direct Known Subclasses:

ICheckProgressorProxy

public class IStepProgressorProxy
extends IProgressorProxy
implements IStepProgressor, Serializable

Provides access to members that report progress in stepped increments.

Description

The IStepProgressor interface has properties for setting the properties of the step progress bar, such as the message, the minimum and maximum values, and the step size. The step progressor bar is the blue moving line that displays the percentage of completeness.

Use IStatusBar::ProgressorBar to access the step progress bar.

Remarks

The IStatusBar::ShowProgressBar method provides shortcuts to the properties of the step progress bar. This method allows you to set the message, minimum and maximum values, and the step size of the step progress bar and also display the step progress bar. Therefore, it is unnecessary to use IStepProgressor to do this.

Product Availability

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

See Also:

IStatusBar, Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IStepProgressorProxy()
	IStepProgressorProxy(Object obj)
protected	IStepProgressorProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
int	getMaxRange() The maximum range of the progression.
int	getMinRange() The minimum range of the progression.
int	getPosition() The current position of the progression.
int	getStepValue() The step increment of the progression.
int	offsetPosition(int offsetValue) Offsets the position of the progression.
void	removeListener(String iidStr, Object theListener)
void	setMaxRange(int maxRange) The maximum range of the progression.
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.

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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.esri.arcgis.system.IProgressor

getMessage, hide, setMessage, show, step

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IStepProgressorProxy

public IStepProgressorProxy()

IStepProgressorProxy

public IStepProgressorProxy(Object obj)
                     throws IOException

Throws:

IOException

IStepProgressorProxy

protected IStepProgressorProxy(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 IProgressorProxy

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class IProgressorProxy

Throws:

IOException

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.