com.esri.arcgis.system
Interface IAnimationProgressor

All Superinterfaces:

IProgressor, Serializable

All Known Implementing Classes:

IAnimationProgressorProxy, ProgressAnimation

public interface IAnimationProgressor
extends IProgressor, Serializable

Provides access to members that report progress using an animation.

Description

The IAnimationProgresor interface has methods for controlling the animation progessor. The animation progressor displays in the animation pane of a status bar. You can use the default spinning globe for the animation progressor or specify your own animation file (.avi). Use the IStatusBar::ProgressAnimation property to get access to the animation progressor.

Product Availability

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

See Also:

IStatusBar.getProgressAnimation()

Method Summary

int	getAnimation() The animation displayed by the progressor as one of the esriAnimation constants.
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	stop() Stops the animation.

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

getMessage, hide, setMessage, show, step

Method Detail

setAnimation

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

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

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

Returns:

A com.esri.arcgis.system.esriAnimations constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openPath

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

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

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

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

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

Parameters:

frameTo - The frameTo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stop

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IStatusBar.playProgressAnimation(boolean)