com.esri.arcgis.arcmapui
Class ProgressBar

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IProgressor, IStepProgressor, java.io.Serializable

public class ProgressBar
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IStepProgressor, IProgressor

COM Class 'ProgressBar'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriArcMapUI.olb'

Description 'ProgressBar object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.system.IStepProgressor

IID, IIDccdad2c7_8ebc_11d1_8732_0000f8751720, xxDummy

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

IID3141f2f1_38e2_11d1_8809_080009ec732a

Constructor Summary

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

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getMaxRange() The maximum range of the progression.
java.lang.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.
int	hashCode() the hashcode for this object
void	hide() Hides the progressor.
int	offsetPosition(int offsetValue) Offsets the position of the progression.
void	release() Release a ProgressBar.
void	setMaxRange(int maxRange) The maximum range of the progression.
void	setMessage(java.lang.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	show() Shows the progressor.
void	step() Animates or steps the progressor.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressBar

public ProgressBar(java.lang.Object obj)
            throws java.io.IOException

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

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

Throws:

java.io.IOException - if there are interop problems ProgressBar theProgressBar = (ProgressBar) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a ProgressBar.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setMinRange

public void setMinRange(int minRange)
                 throws java.io.IOException,
                        AutomationException

The minimum range of the progression.

Specified by:

setMinRange in interface IStepProgressor

Parameters:

minRange - The minRange (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinRange

public int getMinRange()
                throws java.io.IOException,
                       AutomationException

The minimum range of the progression.

Specified by:

getMinRange in interface IStepProgressor

Returns:

The minRange

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRange

public void setMaxRange(int maxRange)
                 throws java.io.IOException,
                        AutomationException

The maximum range of the progression.

Specified by:

setMaxRange in interface IStepProgressor

Parameters:

maxRange - The maxRange (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxRange

public int getMaxRange()
                throws java.io.IOException,
                       AutomationException

The maximum range of the progression.

Specified by:

getMaxRange in interface IStepProgressor

Returns:

The maxRange

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStepValue

public void setStepValue(int step)
                  throws java.io.IOException,
                         AutomationException

The step increment of the progression.

Specified by:

setStepValue in interface IStepProgressor

Parameters:

step - The step (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStepValue

public int getStepValue()
                 throws java.io.IOException,
                        AutomationException

The step increment of the progression.

Specified by:

getStepValue in interface IStepProgressor

Returns:

The step

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPosition

public void setPosition(int position)
                 throws java.io.IOException,
                        AutomationException

The current position of the progression.

Specified by:

setPosition in interface IStepProgressor

Parameters:

position - The position (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPosition

public int getPosition()
                throws java.io.IOException,
                       AutomationException

The current position of the progression.

Specified by:

getPosition in interface IStepProgressor

Returns:

The position

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

offsetPosition

public int offsetPosition(int offsetValue)
                   throws java.io.IOException,
                          AutomationException

Offsets the position of the progression.

Specified by:

offsetPosition in interface IStepProgressor

Parameters:

offsetValue - The offsetValue (in)

Returns:

The prevPos

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMessage

public void setMessage(java.lang.String message)
                throws java.io.IOException,
                       AutomationException

The message displayed by the progressor.

Specified by:

setMessage in interface IProgressor

Parameters:

message - The message (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessage

public java.lang.String getMessage()
                            throws java.io.IOException,
                                   AutomationException

The message displayed by the progressor.

Specified by:

getMessage in interface IProgressor

Returns:

The message

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

public void show()
          throws java.io.IOException,
                 AutomationException

Shows the progressor.

Specified by:

show in interface IProgressor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

step

public void step()
          throws java.io.IOException,
                 AutomationException

Animates or steps the progressor.

Specified by:

step in interface IProgressor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hide

public void hide()
          throws java.io.IOException,
                 AutomationException

Hides the progressor.

Specified by:

hide in interface IProgressor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.