com.esri.arcgis.system
Interface IStatusBar

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IStatusBarProxy, MxStatusBar

public interface IStatusBar
extends java.io.Serializable

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

Description: 'Provides access to members that define the application statusbar.' 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	IID828100c1_cc80_11d0_8380_080009b996cc
static int	xxDummy Deprecated. Internal use only

Method Summary

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

Field Detail

IID828100c1_cc80_11d0_8380_080009b996cc

static final int IID828100c1_cc80_11d0_8380_080009b996cc

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

setMessage

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

The message displayed by one of the status bar panes.

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

java.lang.String getMessage(int pane)
                            throws java.io.IOException,
                                   AutomationException

The message displayed by one of the status bar panes.

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

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.

Parameters:

panes - The panes (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPanes

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

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

Returns:

The panes

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProgressBar

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

The progress bar object on the statusbar.

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

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

The progress animation object on the statusbar.

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

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

Indicates if the statusbar is visible.

Returns:

The visible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setVisible

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

Indicates if the statusbar is visible.

Parameters:

visible - The visible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

showProgressBar

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

Makes the progress bar visible.

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

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

Steps the progress bar to the next position.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hideProgressBar

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

Hides the progress bar.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

showProgressAnimation

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

Makes the progress animation visible.

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

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

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

Parameters:

playAnim - The playAnim (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

hideProgressAnimation

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

Hides the progress animation.

Throws:

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

AutomationException - If the ArcObject component throws an exception.