com.esri.arcgis.arcmapui
Class MxStatusBar

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

All Implemented Interfaces:

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

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

MxStatusBar object.

Description

The status bar is the horizontal area at the bottom of an ArcGIS application window. It provides information about the current state of the application and the selected command. For example, if you select a layer in the table of contents in ArcMap, the status bar will tell you how many features are currently selected. It may also display a progress bar while something is being processed. The StatusBar property on the esriFramework.IApplication interface can be used to get a reference to the StatusBar object.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

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

Method Summary

boolean	equals(Object o) Compare this object with another
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	setMessage(int pane, 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(String message, String animationPath) Makes the progress animation visible.
void	showProgressBar(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

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

getJintegraDispatch, release

Constructor Detail

MxStatusBar

public MxStatusBar(Object obj)
            throws 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:

IOException - if there are interop problems MxStatusBar theMxStatusBar = (MxStatusBar) 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(int pane,
                       String message)
                throws IOException,
                       AutomationException

The message displayed by one of the status bar panes.

Product Availability

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

Specified by:

setMessage in interface IStatusBar

Parameters:

pane - The pane (in)

message - The message (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessage

public String getMessage(int pane)
                  throws IOException,
                         AutomationException

The message displayed by one of the status bar panes.

Product Availability

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

Specified by:

getMessage in interface IStatusBar

Parameters:

pane - The pane (in)

Returns:

The message

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPanes

public void setPanes(int panes)
              throws IOException,
                     AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setPanes in interface IStatusBar

Parameters:

panes - The panes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

esriStatusBarPanes

getPanes

public int getPanes()
             throws IOException,
                    AutomationException

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

Remarks

The status bar is divided into sections called panes. The Panes property specifies which panes of the status bar are currently visible.

The esriStatusBarPanes constants define which panes are shown. The Panes property is a bit field; this means that you can use a combination of the esriStatusBarPanes constants. Add up the values of the panes you want shown and set the Panes property to the total.

Although, the esriStatusBarPanes enumeration is only available to developers with ArcGIS for Desktop, all developers can work with this property as a long.

The default value of Panes is 7; this means that the main (0), animation (1), position (2), and page position (4) panes are visible (0 + 1 + 2 + 4 = 7).

You can set the Panes property to 255 to show all panes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getPanes in interface IStatusBar

Returns:

The panes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

esriStatusBarPanes

getProgressBar

public IStepProgressor getProgressBar()
                               throws IOException,
                                      AutomationException

The progress bar object on the statusbar.

Remarks

Use the ProgressBar property to get access to the step progress bar. The step progress bar is the blue moving line that displays the percentage of completeness.

The ProgressBar property and the HideProgressBar, ShowProgressBar, and StepProgressBar methods are used to control the step progress bar on the status bar. The step progress bar displays in the main status bar pane.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getProgressBar in interface IStatusBar

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IStepProgressor

getProgressAnimation

public IAnimationProgressor getProgressAnimation()
                                          throws IOException,
                                                 AutomationException

The progress animation object on the statusbar.

Remarks

The ProgressAnimation property controls the animation progressor (spinning globe) on the status that displays in the animation pane.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getProgressAnimation in interface IStatusBar

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IAnimationProgressor

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the statusbar is visible.

Remarks

The Visible property indicates whether the status bar is visible in the ArcGIS application window, providing information about the current state of the application.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVisible in interface IStatusBar

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException

Indicates if the statusbar is visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVisible in interface IStatusBar

Parameters:

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

showProgressBar

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

Makes the progress bar visible.

Description

Message is the string that is to be displayed beside the step progressor on the status bar.

min specifies the minimum range of the progression.

max specifies the maximum range of the progression.

Step specifies step increment of the progression.

onePanel (this parameter is no longer used)

Remarks

The ShowProgressBar method provides shortcuts to the properties of the step progress bar (IStepProgressor). This method allows you to set the message, minimum and maximum values, and the step size of the step progress bar and also display the step progress bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stepProgressBar

public void stepProgressBar()
                     throws IOException,
                            AutomationException

Steps the progress bar to the next position.

Remarks

The ProgressBar property and the HideProgressBar, ShowProgressBar, and StepProgressBar methods are used to control the step progress bar on the status bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

stepProgressBar in interface IStatusBar

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hideProgressBar

public void hideProgressBar()
                     throws IOException,
                            AutomationException

Hides the progress bar.

Remarks

The ProgressBar property and the HideProgressBar, ShowProgressBar, and StepProgressBar methods are used to control the step progress bar on the status bar.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

hideProgressBar in interface IStatusBar

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

showProgressAnimation

public void showProgressAnimation(String message,
                                  String animationPath)
                           throws IOException,
                                  AutomationException

Makes the progress animation visible.

Remarks

The ShowProgressAnimation method provides shortcuts to the properties of the animation progressor. This method allows you to set the message, and the animation file to be played.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

showProgressAnimation in interface IStatusBar

Parameters:

message - The message (in)

animationPath - The animationPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

playProgressAnimation

public void playProgressAnimation(boolean playAnim)
                           throws IOException,
                                  AutomationException

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

Remarks

The PlayProgressAnimation method starts or stops playing the animation. Pass True to start playing the animation and False to stop playing the animation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

playProgressAnimation in interface IStatusBar

Parameters:

playAnim - The playAnim (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hideProgressAnimation

public void hideProgressAnimation()
                           throws IOException,
                                  AutomationException

Hides the progress animation.

Remarks

Hides the animation progressor. Use the ShowProgressAnimation method to show the animation progressor and the PlayProgressAnimation method to start or stop the animation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

hideProgressAnimation in interface IStatusBar

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.