org.jscience.net.progress
Class ProgressWindow

java.lang.Object
  org.jscience.net.progress.ProgressWindow

All Implemented Interfaces:

ProgressListener

public class ProgressWindow
extends java.lang.Object
implements ProgressListener

Informe l'utilisateur des progr�s d'une op�ration � l'aide de messages dans une fen�tre. Cette classe peut aussi �crire des avertissements, ce qui est utile entre autre lors de la lecture d'un fichier de donn�es durant laquelle on veut signaler les erreurs mais sans arr�ter la lecture pour autant.

Cette classe est con�ue pour fonctionner correctement m�me si ses m�thodes sont appell�es dans un autre thread que celui de Swing. Il est donc possible de faire la longue op�ration en arri�re plan et d'appeller les m�thodes de cette classe sans se soucier des probl�mes de synchronisation. En g�n�ral, faire l'op�ration en arri�re plan est recommand� afin de permettre le rafraichissement de l'�cran par Swing.

Constructor Summary

ProgressWindow(java.awt.Component parent)
Construit une fen�tre qui informera des progr�s d'une op�ration.

Method Summary

void	complete() Indique que l'op�ration est termin�e.
void	dispose() Lib�re les ressources utilis�es par l'�tat d'avancement.
void	exceptionOccurred(java.lang.Throwable exception) Indique qu'une exception est survenue pendant le traitement de l'op�ration.
java.lang.String	getDescription() Retourne le message d'�crivant l'op�ration en cours.
java.lang.String	getTitle() Retourne le titre de la fen�tre.
void	progress(float percent) Indique l'�tat d'avancement de l'op�ration.
void	setDescription(java.lang.String description) Sp�cifie un message qui d�crit l'op�ration en cours.
void	setTitle(java.lang.String name) D�finit le titre de la fen�tre des progr�s.
void	started() Indique que l'op�ration a commenc�e.
void	warningOccurred(java.lang.String source, java.lang.String margin, java.lang.String warning) �crit un message d'avertissement.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProgressWindow

public ProgressWindow(java.awt.Component parent)

Construit une fen�tre qui informera des progr�s d'une op�ration. La fen�tre n'appara�tra pas im�diatement. Elle n'appara�tra que lorsque la m�thode started() sera appel�e.

Parameters:

parent - Composante parente. La fen�tre des progr�s sera construite dans le m�me cadre que cette composante. Ce param�tre peut �tre nul s'il n'y a pas de parent.

Method Detail

getTitle

public java.lang.String getTitle()

Retourne le titre de la fen�tre. Il s'agira en g�n�ral du titre de la bo�te de dialogue. Par d�faut, ce titre sera "Progression" dans la langue de l'utilisateur.

setTitle

public void setTitle(java.lang.String name)

D�finit le titre de la fen�tre des progr�s. Un argument nul r�tablira le titre par d�faut de la fen�tre.

getDescription

public java.lang.String getDescription()

Retourne le message d'�crivant l'op�ration en cours. Si aucun message n'a �t� d�finie, retourne null.

Specified by:

getDescription in interface ProgressListener

Returns:

DOCUMENT ME!

setDescription

public void setDescription(java.lang.String description)

Sp�cifie un message qui d�crit l'op�ration en cours. Ce message est typiquement sp�cifi�e avant le d�but de l'op�ration. Toutefois, cette m�thode peut aussi �tre appel�e � tout moment pendant l'op�ration sans que cela affecte le pourcentage accompli. La valeur null signifie qu'on ne souhaite plus afficher de description.

Specified by:

setDescription in interface ProgressListener

Parameters:

description - DOCUMENT ME!

started

public void started()

Indique que l'op�ration a commenc�e. L'appel de cette m�thode provoque l'apparition de la fen�tre si elle n'�tait pas d�j� visible.

Specified by:

started in interface ProgressListener

progress

public void progress(float percent)

Indique l'�tat d'avancement de l'op�ration. Le progr�s est repr�sent� par un pourcentage variant de 0 � 100 inclusivement. Si la valeur sp�cifi�e est en dehors de ces limites, elle sera automatiquement ramen�e entre 0 et 100.

Specified by:

progress in interface ProgressListener

Parameters:

percent - DOCUMENT ME!

complete

public void complete()

Indique que l'op�ration est termin�e. L'indicateur visuel informant des progr�s dispara�tra, sauf si des messages d'erreurs ou d'avertissements ont �t� affich�s.

Specified by:

complete in interface ProgressListener

dispose

public void dispose()

Lib�re les ressources utilis�es par l'�tat d'avancement. Si l'�tat d'avancement �tait affich�e dans une fen�tre, cette fen�tre peut �tre d�truite.

Specified by:

dispose in interface ProgressListener

warningOccurred

public void warningOccurred(java.lang.String source,
                            java.lang.String margin,
                            java.lang.String warning)

�crit un message d'avertissement. Les messages appara�tront dans une zone de texte sous la barre des progr�s. Cette zone de texte ne deviendra visible qu'apr�s l'�criture d'au moins un message.

Specified by:

warningOccurred in interface ProgressListener

Parameters:

source - Cha�ne de caract�re d�crivant la source de l'avertissement. Il s'agira par exemple du nom du fichier dans lequel une anomalie a �t� d�tect�e. Peut �tre nul si la source n'est pas connue.

margin - Texte � placer dans la marge de l'avertissement warning, ou null s'il n'y en a pas. Il s'agira le plus souvent du num�ro de ligne o� s'est produite l'erreur dans le fichier source. Ce texte sera automatiquement plac� entre parenth�ses.

warning - Message d'avertissement � �crire.

exceptionOccurred

public void exceptionOccurred(java.lang.Throwable exception)

Indique qu'une exception est survenue pendant le traitement de l'op�ration. L'impl�mentation par d�faut fait appara�tre le message de l'exception dans une fen�tre s�par�e.

Specified by:

exceptionOccurred in interface ProgressListener

Parameters:

exception - DOCUMENT ME!