com.esri.arcgis.arcmapui
Class ProgressAnimation

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IAnimationProgressor, IProgressor, Serializable

public class ProgressAnimation
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IProgressor, IAnimationProgressor

ProgressAnimation object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

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

Method Summary

boolean	equals(Object o) Compare this object with another
int	getAnimation() The animation displayed by the progressor as one of the esriAnimation constants.
String	getMessage() The message displayed by the progressor.
int	hashCode() the hashcode for this object
void	hide() Hides the progressor.
void	openPath(String animationPath) Opens the AVI file specified in the path and displays its first frame.
void	play(int frameFrom, int frameTo, int repeat) Plays the animation.
void	seek(int frameTo) Moves to the specified frame of the animation.
void	setAnimation(int animation) The animation displayed by the progressor as one of the esriAnimation constants.
void	setMessage(String message) The message displayed by the progressor.
void	show() Shows the progressor.
void	step() Animates or steps the progressor.
void	stop() Stops the animation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ProgressAnimation

public ProgressAnimation(Object obj)
                  throws IOException

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

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

Throws:

IOException - if there are interop problems ProgressAnimation theProgressAnimation = (ProgressAnimation) obj;

Method Detail

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setMessage

public void setMessage(String message)
                throws IOException,
                       AutomationException

The message displayed by the progressor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMessage in interface IProgressor

Parameters:

message - The message (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessage

public String getMessage()
                  throws IOException,
                         AutomationException

The message displayed by the progressor.

Description

This is a generic Message property for progressors (for example a progress bar).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMessage in interface IProgressor

Returns:

The message

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

public void show()
          throws IOException,
                 AutomationException

Shows the progressor.

Description

This is a generic Show method for progressors (for example a progress bar).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

show in interface IProgressor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

step

public void step()
          throws IOException,
                 AutomationException

Animates or steps the progressor.

Description

This is a generic Step method for progressors (for example a progress bar).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

step in interface IProgressor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hide

public void hide()
          throws IOException,
                 AutomationException

Hides the progressor.

Description

This is a generic Hide method for progressors (for example a progress bar).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

hide in interface IProgressor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnimation

public void setAnimation(int animation)
                  throws IOException,
                         AutomationException

The animation displayed by the progressor as one of the esriAnimation constants. (Not implemented).

Description

Animation maintains information about particular functionality...


This is a test. This is a test. This is a test.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setAnimation in interface IAnimationProgressor

Parameters:

animation - A com.esri.arcgis.system.esriAnimations constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnimation

public int getAnimation()
                 throws IOException,
                        AutomationException

The animation displayed by the progressor as one of the esriAnimation constants. (Not implemented).

Description

This property is not implemented; do not try to use it.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getAnimation in interface IAnimationProgressor

Returns:

A com.esri.arcgis.system.esriAnimations constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openPath

public void openPath(String animationPath)
              throws IOException,
                     AutomationException

Opens the AVI file specified in the path and displays its first frame. The AVI file specified must not contain audio.

Description

Opens the specified *.avi file and displays the first frame. Use the Play method to play the other frames.

Remarks

You can use the default spinning globe for the animation progressor or specify your own animation file (.avi).

The IStatusBar::ShowProgressAnimation method provides a shortcut to the OpenPath and Show methods of the animation progressor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

openPath in interface IAnimationProgressor

Parameters:

animationPath - The animationPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IStatusBar.showProgressAnimation(String, String)

play

public void play(int frameFrom,
                 int frameTo,
                 int repeat)
          throws IOException,
                 AutomationException

Plays the animation.

Description

Plays the animation from between the specified frames. If the frameFrom, frameTo and repeat arguments are not supplied the animation will be played once from the first frame to the last frame.

Remarks

The IStatusBar::PlayProgressAnimation method provides a shortcut to the Play and Stop methods of the animation progressor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

play in interface IAnimationProgressor

Parameters:

frameFrom - The frameFrom (in, optional, pass 0 if not required)

frameTo - The frameTo (in, optional, pass -1 if not required)

repeat - The repeat (in, optional, pass -1 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IStatusBar.playProgressAnimation(boolean)

seek

public void seek(int frameTo)
          throws IOException,
                 AutomationException

Moves to the specified frame of the animation. The animation starts at this frame the next time it is played.

Description

The Seek method moves to the specified frame in the animation. The first frame in the animation has an index of 0. The next time the Play method is used the animation will start from this frame.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

seek in interface IAnimationProgressor

Parameters:

frameTo - The frameTo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stop

public void stop()
          throws IOException,
                 AutomationException

Stops the animation.

Description

Stops the animation at the current frame. The next time the Play method is used the animation will start from this frame.

Remarks

The IStatusBar::PlayProgressAnimation method provides a shortcut to the Play and Stop methods of the animation progressor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

stop in interface IAnimationProgressor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IStatusBar.playProgressAnimation(boolean)