com.esri.arcgis.arcmapui
Class ProgressAnimation

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

All Implemented Interfaces:

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

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

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

Description 'ProgressAnimation 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.IAnimationProgressor

IID, IID80cb7e35_85e4_11d1_872c_0000f8751720, xxDummy

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

IID3141f2f1_38e2_11d1_8809_080009ec732a

Constructor Summary

ProgressAnimation(java.lang.Object obj)
Construct a ProgressAnimation 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 displayed by the progressor as one of the esriAnimation constants.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getMessage() The message displayed by the progressor.
int	hashCode() the hashcode for this object
void	hide() Hides the progressor.
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	release() Release a ProgressAnimation.
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(java.lang.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

Constructor Detail

ProgressAnimation

public ProgressAnimation(java.lang.Object obj)
                  throws java.io.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:

java.io.IOException - if there are interop problems ProgressAnimation theProgressAnimation = (ProgressAnimation) 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 ProgressAnimation.

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.

setAnimation

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

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

Specified by:

setAnimation in interface IAnimationProgressor

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

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

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

Specified by:

getAnimation in interface IAnimationProgressor

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

public 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.

Specified by:

openPath in interface IAnimationProgressor

Parameters:

animationPath - The animationPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

play

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

Plays the animation.

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:

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

AutomationException - If the ArcObject component throws an exception.

seek

public 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.

Specified by:

seek in interface IAnimationProgressor

Parameters:

frameTo - The frameTo (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stop

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

Stops the animation.

Specified by:

stop in interface IAnimationProgressor

Throws:

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

AutomationException - If the ArcObject component throws an exception.