org.scijava.app
Interface StatusService

All Superinterfaces:

Comparable<Prioritized>, Contextual, Disposable, HasPluginInfo, Prioritized, RichPlugin, SciJavaPlugin, SciJavaService, Service

All Known Implementing Classes:

DefaultStatusService

public interface StatusService
extends SciJavaService

Interface for the status notification service.

Author:

Curtis Rueden

Method Summary

void	clearStatus() Clears the status message.
String	getStatusMessage(String appName, StatusEvent statusEvent) Gets the status message of the given event.
void	showProgress(int value, int maximum) Updates the progress bar.
void	showStatus(int progress, int maximum, String message) Updates the status message and progress bar.
void	showStatus(int progress, int maximum, String message, boolean warn) Updates the status message and progress bar, optionally flagging the status notification as a warning.
void	showStatus(String message) Updates the status message.
void	warn(String message) Issues a warning message.

Methods inherited from interface org.scijava.service.Service

initialize, registerEventHandlers

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

getPriority, setPriority

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Disposable

dispose

Method Detail

showProgress

void showProgress(int value,
                  int maximum)

Updates the progress bar.

showStatus

void showStatus(String message)

Updates the status message.

showStatus

void showStatus(int progress,
                int maximum,
                String message)

Updates the status message and progress bar.

showStatus

void showStatus(int progress,
                int maximum,
                String message,
                boolean warn)

Updates the status message and progress bar, optionally flagging the status notification as a warning.

Parameters:

progress - New progress value

maximum - New progress maximum

message - New status message

warn - Whether or not this notification constitutes a warning

warn

void warn(String message)

Issues a warning message.

clearStatus

void clearStatus()

Clears the status message.

getStatusMessage

String getStatusMessage(String appName,
                        StatusEvent statusEvent)

Gets the status message of the given event. In the case of the empty string (""), an alternative default string will be returned instead using the application version of the given application.

See Also:

StatusEvent.getStatusMessage(), App.getInfo(boolean)