com.esri.arcgis.system
Interface IStatusBar

All Superinterfaces:
Serializable
All Known Implementing Classes:
IStatusBarProxy

public interface IStatusBar
extends Serializable

Provides access to members that define the application statusbar.

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.

The status bar provides information about the selected command, and may also display a progress bar while something is being processed. 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.

The IStatusBar interface allows you to set the properties of the status bar. Use IApplication::StatusBar to get a reference to the status bar object of the application.

Remarks

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

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

The ProgressAnimation property and the HideProgressAnimation, ShowProgressAnimation, and PlayProgressAnimation methods control the animation progressor (spinning globe) on the status bar. The animation progressor displays in the animation pane. You can use the default spinning globe for the animation progressor or specify your own animation file (.avi).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
com.esri.arcgis.system.IApplication, IAnimationProgressor

Method Summary
 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.
 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.
 

Method Detail

setMessage

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.

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

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.

Parameters:
pane - The pane (in)
Returns:
The message
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPanes

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

Parameters:
panes - The panes (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
com.esri.arcgis.framework.esriStatusBarPanes

getPanes

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

Returns:
The panes
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
com.esri.arcgis.framework.esriStatusBarPanes

getProgressBar

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

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

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

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

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

Returns:
The visible
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVisible

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

Parameters:
visible - The visible (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

showProgressBar

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

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

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hideProgressBar

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

showProgressAnimation

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

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

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

Parameters:
playAnim - The playAnim (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

hideProgressAnimation

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

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.