de.mpg.biochem.mars.molecule

Interface MoleculeArchiveWindow

public interface MoleculeArchiveWindow

This interface must be implemented by Mars GUIs that provide MoleculeArchive windows with access to archive information. mars-swing and mars-fx both contain concrete implementations of this interface.

This provides direct access to the MoleculeArchive window that is currently displaying the archive contents using the getWindow method. Using this interface the window can be updated, locked, unlocked, closed, Log Messages can be printed to the lock mode background and the Progress of a running job can be provided.

Method Summary

Modifier and Type	Method and Description
void	lock() Lock the MoleculeArchive window to prevent changes from being made at the same time as calculations are running on the archive.
void	lock(java.lang.String message) Lock the MoleculeArchive window to prevent changes from being made at the same time as calculations are running on the archive.
void	log(java.lang.String message) Add a message to the log that is presented in the background of the lock screen.
void	logln(java.lang.String message) Add a message and start a new line in the log that is presented in the background of the lock screen.
void	setProgress(double progress) This is used to report the progress for a long-running task working on the archive when it is locked.
void	unlock() Unlock the MoleculeArchive window once processing is complete.
void	updateLockMessage(java.lang.String message) Update the message presented on the lock screen.

Method Detail

setProgress

void setProgress(double progress)

This is used to report the progress for a long-running task working on the archive when it is locked. This should be a value between 0 and 1 with 1 representing completion.

Parameters:

progress - Fraction of job that is complete.

updateLockMessage

void updateLockMessage(java.lang.String message)

Update the message presented on the lock screen.

Parameters:

message - Message presented on the lock screen.

log

void log(java.lang.String message)

Add a message to the log that is presented in the background of the lock screen. All log messages sent to the method addLogMessage(String message) are printed to the lock screen background using this method.

Parameters:

message - String message to add to the lock screen log background.

logln

void logln(java.lang.String message)

Add a message and start a new line in the log that is presented in the background of the lock screen. All log messages sent to the method addLogMessage(String message) are printed to the lock screen background using this method.

Parameters:

message - String message to add to the lock screen log background.

lock

void lock(java.lang.String message)

Lock the MoleculeArchive window to prevent changes from being made at the same time as calculations are running on the archive. Allow for setting a specific message in the lock screen such as the calculation that is currently running.

Parameters:

message - Message to present in the lock screen.

lock

void lock()

Lock the MoleculeArchive window to prevent changes from being made at the same time as calculations are running on the archive.

unlock

void unlock()

Unlock the MoleculeArchive window once processing is complete.