SplashScreenHelper.java

/*
 * This file is part of Arduino.
 *
 * Code inspired by this tutorial http://wiki.netbeans.org/Splash_Screen_Beginner_Tutorial. License says "You may modify and use it as you wish."
 *
 * Copyright 2015 Arduino LLC (http://www.arduino.cc/)
 *
 * Arduino is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * As a special exception, you may use this file as part of a free software
 * library without restriction.  Specifically, if other files instantiate
 * templates or use macros or inline functions from this file, or you compile
 * this file and link it with other files to produce an executable, this
 * file does not by itself cause the resulting executable to be covered by
 * the GNU General Public License.  This exception does not however
 * invalidate any other reasons why the executable file might be covered by
 * the GNU General Public License.
 */

package cc.arduino.view;

import java.awt.*;
import java.awt.geom.Rectangle2D;
import java.util.Map;

import processing.app.Theme;

public class SplashScreenHelper {

  private static final int X_OFFSET = 0;
  private static final int Y_OFFSET = 300;
  private static final int TEXTAREA_HEIGHT = 30;
  private static final int TEXTAREA_WIDTH = 475;

  private final Map desktopHints;
  private final SplashScreen splash;
  private Rectangle2D.Double splashTextArea;
  private Graphics2D splashGraphics;
  private int progress = 0;
  private String text;

  public SplashScreenHelper(SplashScreen splash) {
    this.splash = splash;
    if (splash != null) {
      Toolkit tk = Toolkit.getDefaultToolkit();
      desktopHints = (Map) tk.getDesktopProperty("awt.font.desktophints");
    } else {
      desktopHints = null;
    }
  }
  
  public void setProgress(int progress) {
    this.progress = progress;
    splashText(text);
  }
  
  public void splashText(String text, int progress) {
    this.progress = progress;
    splashText(text);
  }

  public void splashText(String text) {
    this.text = text;
    if (splash == null) {
      printText(text);
      return;
    }

    if (!splash.isVisible()) {
      return;
    }

    if (splashTextArea == null) {
      prepareTextAreaAndGraphics();
    }

    eraseLastStatusText();

    drawText(text);
    
    if(progress > 0) drawProgress();

    ensureTextIsDiplayed();
  }


  private void ensureTextIsDiplayed() {
    synchronized (SplashScreen.class) {
      if (splash.isVisible()) {
        splash.update();
      }
    }
  }


  private void drawProgress() {
    splashGraphics.setPaint(new Color(0, 100, 104));
    splashGraphics.setStroke(new BasicStroke(2));
    int w = (int)(splashTextArea.getWidth()*(progress/100.0f));
    splashGraphics.drawLine( (int) splashTextArea.getX(), (int) splashTextArea.getY(),  (int) splashTextArea.getX() + w, (int) splashTextArea.getY());
  }
  
  private void drawText(String str) {
    splashGraphics.setPaint(Color.BLACK);
    FontMetrics metrics = splashGraphics.getFontMetrics();
    splashGraphics.drawString(str, (int) splashTextArea.getX() + 10, (int) splashTextArea.getY() + (TEXTAREA_HEIGHT - metrics.getHeight()) + 5);
  }

  private void eraseLastStatusText() {
    splashGraphics.setPaint(new Color(229, 229, 229));
    splashGraphics.fill(splashTextArea);
  }

  private void prepareTextAreaAndGraphics() {
    splashTextArea = new Rectangle2D.Double(X_OFFSET, Y_OFFSET, TEXTAREA_WIDTH, TEXTAREA_HEIGHT);

    splashGraphics = Theme.setupGraphics2D(splash.createGraphics());

    if (desktopHints != null) {
      splashGraphics.addRenderingHints(desktopHints);
    }
  }

  public void close() {
    if (splash == null) {
      return;
    }
    splash.close();
  }

  private void printText(String str) {
    System.err.println(str);
  }

}