Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.arcmapui
Class ProgressDialog

java.lang.Object
  extended by com.esri.arcgis.arcmapui.ProgressDialog
All Implemented Interfaces:
IProgressDialog2, com.esri.arcgis.interop.RemoteObjRef, IProgressor, IStepProgressor, IProgressDialog, java.io.Serializable
public class ProgressDialog
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IProgressor, IProgressDialog, IProgressDialog2, IStepProgressor

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

Description 'Progress dialog 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.systemUI.IProgressDialog
IID, IID923a1b5a_90e5_4d23_add8_eca3d7d6b1c8, xxDummy
 
Fields inherited from interface com.esri.arcgis.framework.IProgressDialog2
IID, IID0e21fd01_1dc9_4230_95cd_64ee2c4266a1, xxDummy
 
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
ProgressDialog(java.lang.Object obj)
          Construct a ProgressDialog 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
 int getAnimation()
          The animation type displayed in the dialog.
 java.lang.String getDescription()
          The description displayed in the dialog.
 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.
 java.lang.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 release()
          Release a ProgressDialog.
 void setAnimation(int type)
          The animation type displayed in the dialog.
 void setCancelEnabled(boolean bVal)
          Indicates if the cancel button is enabled.
 void setDescription(java.lang.String status)
          The description displayed in the dialog.
 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 setTitle(java.lang.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
 

Constructor Detail

ProgressDialog

public ProgressDialog(java.lang.Object obj)
               throws java.io.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:
java.io.IOException - if there are interop problems ProgressDialog theProgressDialog = (ProgressDialog) 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 ProgressDialog.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

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.

showDialog

public void showDialog()
                throws java.io.IOException,
                       AutomationException
Shows the progress dialog.

Specified by:
showDialog in interface IProgressDialog2
Specified by:
showDialog in interface IProgressDialog
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hideDialog

public void hideDialog()
                throws java.io.IOException,
                       AutomationException
Hides the progress dialog.

Specified by:
hideDialog in interface IProgressDialog2
Specified by:
hideDialog in interface IProgressDialog
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCancelEnabled

public boolean isCancelEnabled()
                        throws java.io.IOException,
                               AutomationException
Indicates if the cancel button is enabled.

Specified by:
isCancelEnabled in interface IProgressDialog2
Specified by:
isCancelEnabled in interface IProgressDialog
Returns:
The bVal
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCancelEnabled

public void setCancelEnabled(boolean bVal)
                      throws java.io.IOException,
                             AutomationException
Indicates if the cancel button is enabled.

Specified by:
setCancelEnabled in interface IProgressDialog2
Specified by:
setCancelEnabled in interface IProgressDialog
Parameters:
bVal - The bVal (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String status)
                    throws java.io.IOException,
                           AutomationException
The description displayed in the dialog.

Specified by:
setDescription in interface IProgressDialog2
Parameters:
status - The status (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException
The description displayed in the dialog.

Specified by:
getDescription in interface IProgressDialog2
Returns:
The status
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTitle

public void setTitle(java.lang.String title)
              throws java.io.IOException,
                     AutomationException
The caption displayed in the dialog.

Specified by:
setTitle in interface IProgressDialog2
Parameters:
title - The title (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTitle

public java.lang.String getTitle()
                          throws java.io.IOException,
                                 AutomationException
The caption displayed in the dialog.

Specified by:
getTitle in interface IProgressDialog2
Returns:
The title
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnimation

public void setAnimation(int type)
                  throws java.io.IOException,
                         AutomationException
The animation type displayed in the dialog.

Specified by:
setAnimation in interface IProgressDialog2
Parameters:
type - A com.esri.arcgis.framework.esriProgressAnimationTypes constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnimation

public int getAnimation()
                 throws java.io.IOException,
                        AutomationException
The animation type displayed in the dialog.

Specified by:
getAnimation in interface IProgressDialog2
Returns:
A com.esri.arcgis.framework.esriProgressAnimationTypes constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

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.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD