com.esri.arcgis.system
Interface IAnimationProgressor

All Superinterfaces:

IProgressor, java.io.Serializable

All Known Implementing Classes:

IAnimationProgressorProxy, ProgressAnimation

public interface IAnimationProgressor
extends IProgressor, java.io.Serializable

COM Interface 'IAnimationProgressor'. Generated 3/19/2015 1:20:51 PM from 'C:\ArcGIS\COM\esriSystem.olb'

Description: 'Provides access to members that report progress using an animation.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID80cb7e35_85e4_11d1_872c_0000f8751720
static int	xxDummy Deprecated. Internal use only

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

IID3141f2f1_38e2_11d1_8809_080009ec732a

Method Summary

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

Field Detail

IID80cb7e35_85e4_11d1_872c_0000f8751720

static final int IID80cb7e35_85e4_11d1_872c_0000f8751720

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setAnimation

void setAnimation(int animation)
                  throws java.io.IOException,
                         AutomationException

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

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAnimation

int getAnimation()
                 throws java.io.IOException,
                        AutomationException

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

Returns:

A com.esri.arcgis.system.esriAnimations constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openPath

void openPath(java.lang.String animationPath)
              throws java.io.IOException,
                     AutomationException

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

Parameters:

animationPath - The animationPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

play

void play(int frameFrom,
          int frameTo,
          int repeat)
          throws java.io.IOException,
                 AutomationException

Plays the animation.

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:

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

AutomationException - If the ArcObject component throws an exception.

seek

void seek(int frameTo)
          throws java.io.IOException,
                 AutomationException

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

Parameters:

frameTo - The frameTo (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stop

void stop()
          throws java.io.IOException,
                 AutomationException

Stops the animation.

Throws:

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

AutomationException - If the ArcObject component throws an exception.