ProgressSheet.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2011 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.turro.pivot.dialog;
 
import java.io.IOException;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.apache.pivot.serialization.SerializationException;
import org.apache.pivot.util.Resources;
import org.apache.pivot.wtk.Action;
import org.apache.pivot.wtk.ActivityIndicator;
import org.apache.pivot.wtk.Label;
import org.apache.pivot.wtk.Meter;
import org.apache.pivot.wtk.PushButton;
import org.apache.pivot.wtk.Sheet;
import org.apache.pivot.wtk.Window;
import org.apache.pivot.wtk.content.ButtonData;
import org.apache.pivot.wtkx.Bindable;
import org.apache.pivot.wtkx.WTKX;
import org.apache.pivot.wtkx.WTKXSerializer;
 
public class ProgressSheet extends Sheet implements Bindable {
 
  private boolean canceled = false, closeable = true;
  private Resources resources;
 
  @WTKX private PushButton progressButton;
  @WTKX private ActivityIndicator activityIndicator;
  @WTKX private Label caption;
  @WTKX private Meter meter;
 
  private Action progressAction = new Action(true) {
    @Override
    public void perform() {
      if(closeable) {
        closeProgress();
      } else {
        canceled = true;
        progressSheet.closeable = true;
        progressSheet.caption.setText((String) progressSheet.resources.get("canceled"));
        ((ButtonData) progressSheet.progressButton.getButtonData()).setText(
                (String) progressSheet.resources.get("close"));
      }
    }
  };
 
  public void initialize(Resources resources) {
    progressButton.setAction(progressAction);
    this.resources = resources;
  }
 
  public boolean isCanceled() {
    return canceled;
  }
 
  public static void startProgress(String caption, boolean canCancel) {
    progressSheet.canceled = false;
    progressSheet.closeable = false;
    progressSheet.meter.setVisible(false);
    progressSheet.meter.setText(null);
    progressSheet.meter.setPercentage(0);
    progressSheet.progressAction.setEnabled(canCancel);
    ((ButtonData) progressSheet.progressButton.getButtonData()).setText(
            (String) progressSheet.resources.get("cancel"));
    progressSheet.caption.setText(caption);
    progressSheet.activityIndicator.setActive(true);
    progressSheet.open(window);
    window.setEnabled(false);
  }
 
  public static void startMeasuredProgress(String caption, boolean canCancel) {
    progressSheet.canceled = false;
    progressSheet.closeable = false;
    progressSheet.meter.setVisible(true);
    progressSheet.meter.setText(null);
    progressSheet.meter.setPercentage(0);
    progressSheet.progressAction.setEnabled(canCancel);
    ((ButtonData) progressSheet.progressButton.getButtonData()).setText(
            (String) progressSheet.resources.get("cancel"));
    progressSheet.caption.setText(caption);
    progressSheet.activityIndicator.setActive(true);
    progressSheet.open(window);
    window.setEnabled(false);
  }
 
  public static void nextProgress(String caption, String step, double inc) {
    if(inc > 0.0) {
      double percent = progressSheet.meter.getPercentage();
      if(percent + inc > 1) {
        progressSheet.meter.setPercentage(1);
      } else {
        progressSheet.meter.setPercentage(percent + inc);
      }
    }
    if(step != null) progressSheet.meter.setText(step);
    if(caption != null) progressSheet.caption.setText(caption);
  }
 
  public static void nextProgress(String caption) {
    if(caption != null) progressSheet.caption.setText(caption);
  }
 
  public static void endProgress(String caption) {
    progressSheet.closeable = true;
    progressSheet.meter.setText(null);
    progressSheet.progressAction.setEnabled(true);
    ((ButtonData) progressSheet.progressButton.getButtonData()).setText(
            (String) progressSheet.resources.get("close"));
    if(caption != null) progressSheet.caption.setText(caption);
    progressSheet.activityIndicator.setActive(false);
  }
 
  public static void closeProgress() {
    window.setEnabled(true);
    progressSheet.close();
  }
 
  public static ProgressSheet getInstance() {
    return progressSheet;
  }
 
  public static ProgressSheet getInstance(Window parent) {
    window = parent;
    try {
      WTKXSerializer wtkxSerializer = new WTKXSerializer(new Resources(ProgressSheet.class.getName()));
      progressSheet = (ProgressSheet) wtkxSerializer.readObject("org/turro/pivot/dialog/progress_sheet.wtkx");
      wtkxSerializer.bind(progressSheet, ProgressSheet.class);
    } catch (IOException ex) {
      Logger.getLogger(ProgressSheet.class.getName()).log(Level.SEVERE, null, ex);
    } catch (SerializationException ex) {
      Logger.getLogger(ProgressSheet.class.getName()).log(Level.SEVERE, null, ex);
    }
    return progressSheet;
  }
 
  private static ProgressSheet progressSheet;
  private static Window window;
}