org.jorigin.task.gui.JTaskProgress Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jcommon Show documentation
A java common package that enable to deal with various functionalities
There is a newer version: 1.0.14
package org.jorigin.task.gui;

import java.awt.BorderLayout;

import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JProgressBar;

import org.jorigin.Common;


/**
 * A panel dedicated to task progress monitoring.
 * @author Julien Seinturier - COMEX S.A. - [email protected] - https://github.com/jorigin/jeometry
 * @version {@value Common#version} - b{@value Common#BUILD}
 * @since 1.0.8
 */
public class JTaskProgress extends JPanel {

  private static final long serialVersionUID = Common.BUILD;

  private JProgressBar progressBar   = null;

  private JLabel label               = null;
  
  private boolean labelVisible       = true;
  
  private boolean progressBarVisible = true;
  
  /**
   * Create a new task progress monitor.
   * @param progressBar the progress bar to use.
   * @param label the label of the monitor.
   */
  public JTaskProgress(JProgressBar progressBar, JLabel label ){
    super();
    this.progressBar = progressBar;
    this.label       = label;
  }
  
  /**
   * Create a new default task progress.
   */
  public JTaskProgress(){
    this(new JProgressBar(), new JLabel());
    initGUI();
  }
  
  /**
   * Create a new progress monitor.
   * @param labelVisible is the label is visible.
   * @param progressBarVisible is the progress bar is visible.
   */
  public JTaskProgress(boolean labelVisible, boolean progressBarVisible){
    this(new JProgressBar(), new JLabel());
    initGUI();
  }
  
  /**
   * Get if the label is visible.
   * @return true if the label is visible and false otherwise.
   * @see #setLabelVisible(boolean)
   */
  public boolean isLabelVisible() {
    return labelVisible;
  }

  /**
   * Set if the label is visible.
   * @param labelVisible true if the label is visible and false otherwise.
   * @see #isLabelVisible()
   */
  public void setLabelVisible(boolean labelVisible) {
    
    if (this.labelVisible != labelVisible){
      this.labelVisible = labelVisible;
      
      if (isLabelVisible()){
        add(label, BorderLayout.NORTH);
      } else {
        remove(label);
      }
    }
  }

  /**
   * Get if the progress bar is visible.
   * @return true if the progress bar is visible and false otherwise.
   * @see #setProgressBarVisible(boolean)
   */
  public boolean isProgressBarVisible() {
    return progressBarVisible;
  }

  /**
   * Set if the progress bar is visible.
   * @param progressBarVisible true if the progress bar is visible and false otherwise.
   * @see #isProgressBarVisible()
   */
  public void setProgressBarVisible(boolean progressBarVisible) {
    
    if (this.progressBarVisible != progressBarVisible){
      this.progressBarVisible = progressBarVisible;
      
      if (isProgressBarVisible()){
        add(progressBar, BorderLayout.CENTER);
      } else {
        remove(progressBar);
      }
    }
    
    
  }
  
  /**
   * Get the progress bar attached to this monitor.
   * @return  the progress bar attached to this monitor.
   */
  public JProgressBar getProgressBar() {
    return progressBar;
  }

  /**
   * Get the label of this monitor.
   * @return the label of this monitor.
   */
  public JLabel getLabel() {
    return label;
  }
  
  protected void initGUI(){
    setLayout(new BorderLayout());
    
    if (isLabelVisible()){
      add(label, BorderLayout.NORTH);
    }
    
    if (isProgressBarVisible()){
      add(progressBar, BorderLayout.CENTER);
    }
  }
}