Package com.inet.viewer
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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddStateChangeListener(java.beans.PropertyChangeListener l)Adds a PropertyChangeListener to the listener list.voidclearInfoMessage()Remove the current info message from the StatusBar.Calling this method will bring a status message(if set) back to screen.voidclearStatusMessage()Remove the current status message from the StatusBar.java.lang.StringgetInfoMessage()Returns the current info message from the statusbar.java.lang.StringgetStatusMessage()Returns the current status message from the statusbar.booleanisVisible()Determines whether this component should be visible when its parent is visible.voidremoveStateChangeListener(java.beans.PropertyChangeListener l)Removes a PropertyChangeListener from this progress.voidsetInfoMessage(java.lang.String message)Sets and shows a info message in this StatusBar.voidsetStatusMessage(java.lang.String message, boolean isError)Sets and shows, if no info message is set, a status message in this StatusBar.voidsetVisible(boolean vis)Shows or hides this component depending on the value of parameterb.-
Methods inherited from interface com.inet.viewer.ViewerComponent
getComponent
-
-
-
-
Method Detail
-
setStatusMessage
void setStatusMessage(java.lang.String message, boolean isError)Sets and shows, if no info message is set, a status message in this StatusBar. This message will be shown untilclearStatusMessage()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
java.lang.String getStatusMessage()
Returns the current status message from the statusbar.- Returns:
- Returns the current status message.
- Since:
- 7.0
-
setInfoMessage
void setInfoMessage(java.lang.String message)
Sets and shows a info message in this StatusBar. This message will be shown untilclearInfoMessage()is called or a new info message is set. A status message cant overwrite an info message and callingclearInfoMessage()will bring the status message (if set) back to screen.- Parameters:
message- The info message to show.- Since:
- 7.0
-
getInfoMessage
java.lang.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 parameterb.- Parameters:
vis- iftrue, 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 asFrameobjects.- Returns:
trueif the component is visible,falseotherwise- Since:
- 7.0
-
addStateChangeListener
void addStateChangeListener(java.beans.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(java.beans.PropertyChangeListener l)
Removes a PropertyChangeListener from this progress.- Parameters:
l- PropertyChangeListener- Since:
- 7.0
-
-