Interface StatusBar

All Superinterfaces:
ViewerComponent
All Known Implementing Classes:
SwingStatusBar

public interface StatusBar extends ViewerComponent
The interface for all status bars attached to the reportview. To add your own progress, simply create a class which implements Progress and add it to the status bar using "addProgress".
Since:
7.0
  • Method Details

    • setStatusMessage

      void setStatusMessage(String message, boolean isError)
      Sets and shows, if no info message is set, a status message in this StatusBar. This message will be shown until clearStatusMessage() is called or an infor or a new status message is set. If isError is set the message will be displayed as an error (red color).
      Parameters:
      message - The status message to show.
      isError - If true the status message will be displayed red.
      Since:
      7.0
    • clearStatusMessage

      void clearStatusMessage()
      Remove the current status message from the StatusBar.
      Since:
      7.0
    • getStatusMessage

      String getStatusMessage()
      Returns the current status message from the statusbar.
      Returns:
      Returns the current status message.
      Since:
      7.0
    • setInfoMessage

      void setInfoMessage(String message)
      Sets and shows a info message in this StatusBar. This message will be shown until clearInfoMessage() is called or a new info message is set. A status message cant overwrite an info message and calling clearInfoMessage() will bring the status message (if set) back to screen.
      Parameters:
      message - The info message to show.
      Since:
      7.0
    • getInfoMessage

      String getInfoMessage()
      Returns the current info message from the statusbar.
      Returns:
      Returns the current info message.
      Since:
      7.0
    • clearInfoMessage

      void clearInfoMessage()
      Remove the current info message from the StatusBar.Calling this method will bring a status message(if set) back to screen.
      Since:
      7.0
    • setVisible

      void setVisible(boolean vis)
      Shows or hides this component depending on the value of parameter b.
      Parameters:
      vis - if true, shows this component; otherwise, hides this component
      Since:
      7.0
    • isVisible

      boolean isVisible()
      Determines whether this component should be visible when its parent is visible. Components are initially visible, with the exception of top level components such as Frame objects.
      Returns:
      true if the component is visible, false otherwise
      Since:
      7.0
    • addStateChangeListener

      void addStateChangeListener(PropertyChangeListener l)
      Adds a PropertyChangeListener to the listener list. The Listener will be informed about all changed status messages of the status bar.
      Parameters:
      l - PropertyChangeListener
      Since:
      7.0
    • removeStateChangeListener

      void removeStateChangeListener(PropertyChangeListener l)
      Removes a PropertyChangeListener from this progress.
      Parameters:
      l - PropertyChangeListener
      Since:
      7.0