org.valkyriercp.application.StatusBar Maven / Gradle / Ivy
package org.valkyriercp.application;
import org.valkyriercp.core.Message;
import org.valkyriercp.factory.ControlFactory;
public interface StatusBar extends ControlFactory {
/**
* Returns the ProgressMonitor in use by this
* StatusBar
*
* @return the progress monitor
*/
org.valkyriercp.progress.ProgressMonitor getProgressMonitor();
/**
* Sets the message of this status bar.
*
* @param message
* the message, null clears the message
*/
void setMessage(String message);
/**
* Sets the message of this status bar.
*
* @param message
* the message, null clears the message
*/
void setMessage(Message message);
/**
* Sets the error message of this status bar.
*
* An error message is usualy painted in another color,
* StatusBar implementations are free to choose the way they
* display the error message
*
* @param message
* the error message, null clears the error
* message
*/
void setErrorMessage(String message);
/**
* Sets the error message of this status bar.
*
* An error message is usualy painted in another color,
* StatusBar implementations are free to choose the way they
* display the error message
*
* @param message
* the error message, null clears the error
* message
*/
void setErrorMessage(Message message);
/**
* Sets the visible state of this status bar.
*
* @param visible
* true or false
*/
void setVisible(boolean visible);
/**
* Provides a hint whether the current running operation can be canceled.
*
* @param enabled
* true or false
*/
void setCancelEnabled(boolean enabled);
/**
* Clears the messages of this status bar.
*/
void clear();
}