com.esri.arcgis.system
Class IStatusBarProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.system.IStatusBarProxy
All Implemented Interfaces:
IStatusBar, java.io.Externalizable, java.io.Serializable

public class IStatusBarProxy
extends com.esri.arcgis.interop.Dispatch
implements IStatusBar, java.io.Serializable

Internal use class Proxy for 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 =

See Also:
Serialized Form

Field Summary
 boolean noncastable
           
static java.lang.Class targetClass
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Fields inherited from interface com.esri.arcgis.system.IStatusBar
IID, IID828100c1_cc80_11d0_8380_080009b996cc
 
Constructor Summary
  IStatusBarProxy()
          For internal use only
  IStatusBarProxy(java.lang.Object obj)
           
protected IStatusBarProxy(java.lang.Object obj, java.lang.String iid)
           
  IStatusBarProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
protected IStatusBarProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
           
 
Method Summary
 void addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
           
 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 removeListener(java.lang.String iidStr, java.lang.Object theListener)
           
 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 com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable
Constructor Detail

IStatusBarProxy

public IStatusBarProxy(java.lang.String CLSID,
                       java.lang.String host,
                       com.esri.arcgis.interop.AuthInfo authInfo)
                throws java.net.UnknownHostException,
                       java.io.IOException
Throws:
java.net.UnknownHostException
java.io.IOException

IStatusBarProxy

public IStatusBarProxy()
For internal use only


IStatusBarProxy

public IStatusBarProxy(java.lang.Object obj)
                throws java.io.IOException
Throws:
java.io.IOException

IStatusBarProxy

protected IStatusBarProxy(java.lang.Object obj,
                          java.lang.String iid)
                   throws java.io.IOException
Throws:
java.io.IOException

IStatusBarProxy

protected IStatusBarProxy(java.lang.String CLSID,
                          java.lang.String iid,
                          java.lang.String host,
                          com.esri.arcgis.interop.AuthInfo authInfo)
                   throws java.io.IOException
Throws:
java.io.IOException
Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
java.io.IOException

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.