com.esri.arcgis.arcmapui
Class MxStatusBar

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, IStatusBar, java.io.Serializable

public class MxStatusBar
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IStatusBar

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

Description 'MxStatusBar 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.IStatusBar

IID, IID828100c1_cc80_11d0_8380_080009b996cc, xxDummy

Constructor Summary

MxStatusBar(java.lang.Object obj)
Construct a MxStatusBar 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
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getMessage(int pane) The message displayed by one of the status bar panes.
int	getPanes() Indicates which standard panes are shown by the status bar.
IAnimationProgressor	getProgressAnimation() The progress animation object on the statusbar.
IStepProgressor	getProgressBar() The progress bar object on the statusbar.
int	hashCode() the hashcode for this object
void	hideProgressAnimation() Hides the progress animation.
void	hideProgressBar() Hides the progress bar.
boolean	isVisible() Indicates if the statusbar is visible.
void	playProgressAnimation(boolean playAnim) Plays the progress animation if the parameter is true; otherwise stops it.
void	release() Release a MxStatusBar.
void	setMessage(int pane, java.lang.String message) The message displayed by one of the status bar panes.
void	setPanes(int panes) Indicates which standard panes are shown by the status bar.
void	setVisible(boolean visible) Indicates if the statusbar is visible.
void	showProgressAnimation(java.lang.String message, java.lang.String animationPath) Makes the progress animation visible.
void	showProgressBar(java.lang.String message, int min, int max, int step, boolean onePanel) Makes the progress bar visible.
void	stepProgressBar() Steps the progress bar to the next position.

Methods inherited from class java.lang.Object

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

Constructor Detail

MxStatusBar

public MxStatusBar(java.lang.Object obj)
            throws java.io.IOException

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

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

Throws:

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

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setMessage

public void setMessage(int pane,
                       java.lang.String message)
                throws java.io.IOException,
                       AutomationException

The message displayed by one of the status bar panes.

Specified by:

setMessage in interface IStatusBar

Parameters:

pane - The pane (in)

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(int pane)
                            throws java.io.IOException,
                                   AutomationException

The message displayed by one of the status bar panes.

Specified by:

getMessage in interface IStatusBar

Parameters:

pane - The pane (in)

Returns:

The message

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPanes

public void setPanes(int panes)
              throws java.io.IOException,
                     AutomationException

Indicates which standard panes are shown by the status bar. Use a combination of esriStatusBarPanes constants.

Specified by:

setPanes in interface IStatusBar

Parameters:

panes - The panes (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPanes

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

Indicates which standard panes are shown by the status bar. Use a combination of esriStatusBarPanes constants.

Specified by:

getPanes in interface IStatusBar

Returns:

The panes

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProgressBar

public IStepProgressor getProgressBar()
                               throws java.io.IOException,
                                      AutomationException

The progress bar object on the statusbar.

Specified by:

getProgressBar in interface IStatusBar

Returns:

A reference to a com.esri.arcgis.system.IStepProgressor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProgressAnimation

public IAnimationProgressor getProgressAnimation()
                                          throws java.io.IOException,
                                                 AutomationException

The progress animation object on the statusbar.

Specified by:

getProgressAnimation in interface IStatusBar

Returns:

A reference to a com.esri.arcgis.system.IAnimationProgressor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws java.io.IOException,
                         AutomationException

Indicates if the statusbar is visible.

Specified by:

isVisible in interface IStatusBar

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws java.io.IOException,
                       AutomationException

Indicates if the statusbar is visible.

Specified by:

setVisible in interface IStatusBar

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

showProgressBar

public void showProgressBar(java.lang.String message,
                            int min,
                            int max,
                            int step,
                            boolean onePanel)
                     throws java.io.IOException,
                            AutomationException

Makes the progress bar visible.

Specified by:

showProgressBar in interface IStatusBar

Parameters:

message - The message (in)

min - The min (in)

max - The max (in)

step - The step (in)

onePanel - The onePanel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

stepProgressBar

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

Steps the progress bar to the next position.

Specified by:

stepProgressBar in interface IStatusBar

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hideProgressBar

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

Hides the progress bar.

Specified by:

hideProgressBar in interface IStatusBar

Throws:

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

AutomationException - If the ArcObject component throws an exception.

showProgressAnimation

public void showProgressAnimation(java.lang.String message,
                                  java.lang.String animationPath)
                           throws java.io.IOException,
                                  AutomationException

Makes the progress animation visible.

Specified by:

showProgressAnimation in interface IStatusBar

Parameters:

message - The message (in)

animationPath - The animationPath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

playProgressAnimation

public void playProgressAnimation(boolean playAnim)
                           throws java.io.IOException,
                                  AutomationException

Plays the progress animation if the parameter is true; otherwise stops it.

Specified by:

playProgressAnimation in interface IStatusBar

Parameters:

playAnim - The playAnim (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hideProgressAnimation

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

Hides the progress animation.

Specified by:

hideProgressAnimation in interface IStatusBar

Throws:

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

AutomationException - If the ArcObject component throws an exception.