gate.gui.creole.manager.ProgressPanel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gate-core Show documentation
GATE - general achitecture for text engineering - is open source software capable of solving almost any text processing problem. This artifact enables you to embed the core GATE Embedded with its essential dependencies. You will able to use the GATE Embedded API and load and store GATE XML documents. This artifact is the perfect dependency for CREOLE plugins or for applications that need to customize the GATE dependencies due to confict with their own dependencies or for lower footprint.
The newest version!
/*
 * ProgressPanel.java
 * 
 * Copyright (c) 2011, The University of Sheffield. See the file COPYRIGHT.txt
 * in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
 * 
 * This file is part of GATE (see http://gate.ac.uk/), and is free software,
 * licenced under the GNU Library General Public License, Version 2, June 1991
 * (in the distribution as file licence.html, and also available at
 * http://gate.ac.uk/gate/licence.html).
 * 
 * Mark A. Greenwood, 30/10/2011
 */

package gate.gui.creole.manager;

import java.awt.Dimension;
import java.awt.event.ComponentEvent;
import java.awt.event.ComponentListener;
import java.util.HashMap;
import java.util.Map;

import javax.swing.Box;
import javax.swing.BoxLayout;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JProgressBar;
import javax.swing.JScrollPane;
import javax.swing.SwingConstants;
import javax.swing.SwingUtilities;
import javax.swing.UIManager;

import gate.Gate;
import gate.creole.Plugin;
import gate.resources.img.svg.DownloadIcon;
import gate.resources.img.svg.ProgressIcon;

@SuppressWarnings("serial")
public class ProgressPanel extends JPanel implements ComponentListener,
                           Plugin.DownloadListener {
  private static class SafeJProgressBar extends JProgressBar {
    @Override
    public void setIndeterminate(boolean indeterminate) {
      // workaround for bug in some versions of Aqua L&F that prevents GATE
      // from exiting if indeterminate progress bars are used
      if(Gate.runningOnMac() && (UIManager.getLookAndFeel() == null
          || UIManager.getLookAndFeel().getClass().getName()
              .equals(UIManager.getSystemLookAndFeelClassName()))) {
        return;
      } else {
        super.setIndeterminate(indeterminate);
      }
    }
  }
  
  private Map progressMapping =
      new HashMap();

  private JProgressBar progressTotal;

  private JLabel message, dlMsg;

  private JScrollPane scroller;

  private JPanel partProgress;

  public ProgressPanel() {
    super();

    setLayout(new BoxLayout(this, BoxLayout.Y_AXIS));
    
    int width = 400;

    progressTotal = new SafeJProgressBar();
    progressTotal.setAlignmentX(CENTER_ALIGNMENT);
    progressTotal.setMaximumSize(
        new Dimension(width, progressTotal.getPreferredSize().height));
    progressTotal.setIndeterminate(true);

    message = new JLabel("");
    message.setIcon(new ProgressIcon(48, 48));
    message.setHorizontalTextPosition(SwingConstants.RIGHT);
    message.setHorizontalAlignment(SwingConstants.CENTER);
    message.setAlignmentX(CENTER_ALIGNMENT);

    dlMsg = new JLabel("Downloading CREOLE Plugin...");
    dlMsg.setIcon(new DownloadIcon(48, 48));
    dlMsg.setHorizontalTextPosition(SwingConstants.RIGHT);
    dlMsg.setHorizontalAlignment(SwingConstants.CENTER);
    dlMsg.setAlignmentX(CENTER_ALIGNMENT);
    dlMsg.setVisible(false);

    partProgress = new JPanel();
    partProgress.setLayout(new BoxLayout(partProgress, BoxLayout.Y_AXIS));

    scroller = new JScrollPane(partProgress);
    scroller.setAlignmentX(CENTER_ALIGNMENT);
    scroller.setMaximumSize(
        new Dimension(width, progressTotal.getPreferredSize().height*6));
    scroller.setPreferredSize(
        new Dimension(width, progressTotal.getPreferredSize().height*6));
    

    add(Box.createVerticalGlue());
    add(message);
    add(Box.createVerticalStrut(5));
    add(progressTotal);
    add(Box.createVerticalStrut(10));
    add(dlMsg);
    add(Box.createVerticalStrut(5));
    add(scroller);

    add(Box.createVerticalGlue());

    addComponentListener(this);
  }

  /*
   * public void downloadStarting(final String name, final boolean sizeUnknown)
   * { SwingUtilities.invokeLater(new Thread() {
   * 
   * @Override public void run() { progressSingle.setValue(0);
   * progressSingle.setIndeterminate(sizeUnknown); dlMsg.setText("Downloading "
   * + name + " CREOLE Plugin..."); dlMsg.setVisible(true);
   * progressSingle.setVisible(true); } }); }
   * 
   * public void downloadFinished() { SwingUtilities.invokeLater(new Thread() {
   * 
   * @Override public void run() { dlMsg.setVisible(false);
   * progressSingle.setVisible(false); } }); }
   * 
   * public void downloadProgress(final int progress) {
   * SwingUtilities.invokeLater(new Thread() {
   * 
   * @Override public void run() { progressSingle.setValue(progress); } }); }
   */

  /*
   * public void valueIncrement() { SwingUtilities.invokeLater(new Thread() {
   * 
   * @Override public void run() {
   * progressTotal.setValue(progressTotal.getValue() + 1); } }); }
   * 
   * public void valueChanged(final int value) { SwingUtilities.invokeLater(new
   * Thread() {
   * 
   * @Override public void run() { progressTotal.setValue(value); } }); }
   */

  public void rangeChanged(final int min, final int max) {
    SwingUtilities.invokeLater(new Thread() {
      @Override
      public void run() {
        progressTotal.setMinimum(min);
        progressTotal.setMaximum(max);
        progressTotal.setIndeterminate(min == max);
      }
    });
  }
  
  public void reset() {
    SwingUtilities.invokeLater(new Thread() {
      @Override
      public void run() {
        progressTotal.setMinimum(0);
        progressTotal.setMaximum(0);
        progressTotal.setIndeterminate(true);
        partProgress.removeAll();
        partProgress.validate();
        progressMapping.clear();
      }
    });
  }

  public void messageChanged(final String newMessage) {
    SwingUtilities.invokeLater(new Thread() {
      @Override
      public void run() {
        message.setText("" + newMessage + "");
      }
    });
  }

  @Override
  public void componentHidden(ComponentEvent e) {
    // we don't currently need this
  }

  @Override
  public void componentMoved(ComponentEvent e) {
    // we don't currently need this
  }

  @Override
  public void componentResized(ComponentEvent e) {
    int width = Math.min(400, (int)(getSize().width * (2f / 3)));
    progressTotal.setMaximumSize(
        new Dimension(width, progressTotal.getPreferredSize().height));
    scroller.setMaximumSize(
        new Dimension(width, progressTotal.getPreferredSize().height*6));
    scroller.setPreferredSize(
        new Dimension(width, progressTotal.getPreferredSize().height*6));}

  @Override
  public void componentShown(ComponentEvent e) {
    // valueChanged(0);
    componentResized(e);
  }

  @Override
  public void downloadStarted(String name) {
    
  }

  @Override
  public void downloadProgressed(String name, long totalBytes,
      long transferredBytes) {

    SwingUtilities.invokeLater(new Runnable() {
      @Override
      public void run() {
        JProgressBar progressBar = progressMapping.get(name);
        if(progressBar == null) {
          progressBar = new JProgressBar(JProgressBar.HORIZONTAL);
          progressBar.setMinimum(0);
          progressBar.setMaximum(100);
          progressBar.setValue(0);
          progressBar.setStringPainted(true);
          progressBar.setString(name);
          progressBar.setIndeterminate(true);

          progressMapping.put(name, progressBar);

          partProgress.add(progressBar);
          partProgress.validate();
        }

        if(totalBytes > 0 && transferredBytes > 0) {
          progressBar.setIndeterminate(false);
          progressBar.setString(name + ": "
              + (int)Math.floor((transferredBytes * 100) / totalBytes) + "%");
          progressBar
              .setValue((int)Math.floor((transferredBytes * 100) / totalBytes));

        }
      }
    });

  }

  @Override
  public void downloadSucceeded(String name) {
    // TODO Auto-generated method stub

  }

  @Override
  public void downloadFailed(String name, Throwable cause) {
    // TODO Auto-generated method stub

  }
}