com.fathzer.soft.ajlib.swing.worker.DefaultWorkInProgressPanel Maven / Gradle / Ivy

Go to download
package com.fathzer.soft.ajlib.swing.worker;

import javax.swing.Icon;
import javax.swing.SwingWorker;

import java.awt.GridBagLayout;
import javax.swing.JProgressBar;
import java.awt.GridBagConstraints;
import javax.swing.JLabel;
import java.awt.Insets;
import javax.swing.JButton;

import com.fathzer.soft.ajlib.swing.framework.Application;


import java.awt.event.ActionListener;
import java.awt.event.ActionEvent;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;

/** A default panel reporting the progress of a background task.
 * 
This panel contains a message, a progress bar and a cancel button. 
 * @author Jean-Marc Astesana
 * 
License: LGPL v3
 * @see Worker
 */
@SuppressWarnings("serial")
public class DefaultWorkInProgressPanel extends WorkInProgressPanel {
	private Worker worker;
	private JLabel message;
	private JProgressBar progressBar;
	private JButton btnCancel;
	private transient PropertyChangeListener workerListener;

	/**
	 * Constructor.
	 */
	public DefaultWorkInProgressPanel() {
		buildContent();
	}

	private PropertyChangeListener getListener() {
		if (workerListener==null) {
			workerListener = new PropertyChangeListener() {
				@Override
				public void propertyChange(PropertyChangeEvent evt) {
					if (evt.getPropertyName().equals(Worker.STATE_PROPERTY_NAME)) {
						getBtnCancel().setEnabled(evt.getNewValue().equals(SwingWorker.StateValue.STARTED));
						if (evt.getNewValue().equals(SwingWorker.StateValue.DONE) && !worker.isCancelled()) {
							getProgressBar().setIndeterminate(false);
							getProgressBar().setValue(getProgressBar().getMaximum());
						}
					} else if (evt.getPropertyName().equals(Worker.PROGRESS_PROPERTY_NAME)){
						long absoluteValue = ((Integer)evt.getNewValue())*worker.getPhaseLength()/100;
						getProgressBar().setValue((int)absoluteValue);
					} else if (evt.getPropertyName().equals(Worker.JOB_PHASE) || evt.getPropertyName().equals(Worker.PHASE_LENGTH)){
						initPhase();
					}
				}
			};
		}
		return workerListener;
	}

	/** Builds the panel content.
	 * 
You may override this method in order to implement your own panel.
	 * 
Note that this method is called once during by the panel constructor.
	 */
	protected void buildContent() {
		GridBagLayout gridBagLayout = new GridBagLayout();
		setLayout(gridBagLayout);
		
		GridBagConstraints gbcMessage = new GridBagConstraints();
		gbcMessage.insets = new Insets(5, 5, 5, 5);
		gbcMessage.anchor = GridBagConstraints.WEST;
		gbcMessage.gridwidth = 0;
		gbcMessage.gridx = 0;
		gbcMessage.gridy = 0;
		add(getLabel(), gbcMessage);
		
		GridBagConstraints gbcProgressBar = new GridBagConstraints();
		gbcProgressBar.weightx = 1.0;
		gbcProgressBar.insets = new Insets(0, 5, 5, 5);
		gbcProgressBar.fill = GridBagConstraints.HORIZONTAL;
		gbcProgressBar.gridwidth = 0;
		gbcProgressBar.gridx = 0;
		gbcProgressBar.gridy = 1;
		add(getProgressBar(), gbcProgressBar);
		
		GridBagConstraints gbcBtnCancel = new GridBagConstraints();
		gbcBtnCancel.insets = new Insets(0, 5, 5, 5);
		gbcBtnCancel.gridx = 0;
		gbcBtnCancel.gridy = 2;
		add(getBtnCancel(), gbcBtnCancel);
	}

	@Override
	public Worker getWorker() {
		return worker;
	}

	@Override
	public void setSwingWorker(Worker worker) {
		PropertyChangeListener listener = getListener();
		if (this.worker!=null) {
			this.worker.removePropertyChangeListener(listener);
		}
		this.worker = worker;
		this.worker.addPropertyChangeListener(listener);
		initPhase();
	}

	public void setMessage(String message) {
		this.message.setText(message);
	}
	
	public void setIcon(Icon icon) {
		this.message.setIcon(icon);
	}
	
	/** Inits the progress bar.
	 * 
This method is called every time the worker phase or phase length changes (or when the worker itself changes).
	 * 
The default implementation sets the progress bar in indeterminate state if the length of the worker's phase is <= 0.
	 * If it is > 0, then, it sets the maximum to the phase length and turns the StringPainted of the progress bar to true.
	 * 
if the phase wording is null, the message text is unchanged.
	 * 
You can override this method to change this behavior. 
	 */
	protected void initPhase() {
		if (worker.getPhase()!=null) {
			setMessage(worker.getPhase());					
		}
		int phaseLength = worker.getPhaseLength();
		JProgressBar pBar = getProgressBar();
		pBar.setIndeterminate(phaseLength<=0);
		pBar.setStringPainted(phaseLength>0);
		if (phaseLength>0) {
			pBar.setMaximum(phaseLength);
		} else {
			pBar.setValue(0);
		}
	}

	public JLabel getLabel() {
		if (message==null) {
			message = new JLabel(" "); //$NON-NLS-1$
		}
		return message;
	}

	public JProgressBar getProgressBar() {
		if (progressBar==null) {
			progressBar = new JProgressBar();
		}
		return progressBar;
	}
	
	public JButton getBtnCancel() {
		if (btnCancel==null) {
			btnCancel = new JButton(Application.getString("GenericButton.cancel", getLocale())); //$NON-NLS-1$
			btnCancel.setEnabled(false);
			getBtnCancel().addActionListener(new ActionListener() {
				public void actionPerformed(ActionEvent e) {
					if (worker!=null) {
						worker.cancel(false);
					}
				}
			});
		}
		return btnCancel;
	}
}