org.springframework.richclient.application.statusbar
Interface StatusBar

All Superinterfaces:

ControlFactory

All Known Implementing Classes:

DefaultStatusBar

public interface StatusBar
extends ControlFactory

StatusBar abstraction.

Author:

Peter De Bruycker

Method Summary

void	clear() Clears the messages of this status bar.
ProgressMonitor	getProgressMonitor() Returns the ProgressMonitor in use by this StatusBar
void	setCancelEnabled(boolean enabled) Provides a hint whether the current running operation can be canceled.
void	setErrorMessage(Message message) Sets the error message of this status bar.
void	setErrorMessage(String message) Sets the error message of this status bar.
void	setMessage(Message message) Sets the message of this status bar.
void	setMessage(String message) Sets the message of this status bar.
void	setVisible(boolean visible) Sets the visible state of this status bar.

Methods inherited from interface org.springframework.richclient.factory.ControlFactory

getControl

Method Detail

getProgressMonitor

ProgressMonitor getProgressMonitor()

Returns the ProgressMonitor in use by this StatusBar

Returns:

the progress monitor

setMessage

void setMessage(String message)

Sets the message of this status bar.

Parameters:

message - the message, null clears the message

setMessage

void setMessage(Message message)

Sets the message of this status bar.

Parameters:

message - the message, null clears the message

setErrorMessage

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

Parameters:

message - the error message, null clears the error message

setErrorMessage

void setErrorMessage(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

Parameters:

message - the error message, null clears the error message

setVisible

void setVisible(boolean visible)

Sets the visible state of this status bar.

Parameters:

visible - true or false

setCancelEnabled

void setCancelEnabled(boolean enabled)

Provides a hint whether the current running operation can be canceled.

Parameters:

enabled - true or false

clear

void clear()

Clears the messages of this status bar.