/**
    * Copyright 2011, Aiki IT, FotoRenamer
    * <p/>
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    * <p/>
    * http://www.apache.org/licenses/LICENSE-2.0
    * <p/>
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package de.aikiit.fotorenamer.gui;
  
  import de.aikiit.fotorenamer.util.ComponentGaugeUtil;
  import org.apache.logging.log4j.LogManager;
  import org.apache.logging.log4j.Logger;
  
  import javax.swing.*;
  import java.awt.*;
  import java.util.concurrent.TimeUnit;
  import java.util.concurrent.atomic.AtomicInteger;
  
  import static de.aikiit.fotorenamer.util.LocalizationHelper.getBundleString;
  
  /**
   * This class provides a progressbar with 2 lines. One is the progress bar
   * itself, the other is a String for text messages.
   *
   * @author hirsch, 13.10.2003
   * @version 2004-01-08
   */
  public class ProgressBar extends JFrame {
      /**
       * Logger for this class.
       */
      private static final Logger LOG = LogManager.getLogger(ProgressBar.class);
      /**
       * By default the UI sleeps for 200 ms to be able to read the file names
       * during operation.
       */
      private static final int DEFAULT_UI_DELAY = 200;
  
      /**
       * Text field to show current file or other information during run.
       */
      private JLabel textInfo = null;
      /**
       * The visual progress bar.
       */
      private JProgressBar progressBar = null;
      /**
       * Amount of seconds the UI sleeps in order to give a
       * user a chance to read the screen,
       * this value is calculated dynamically
       * depending on the amount of pictures to be processed.
       */
      private int delayInUI = -1;
  
      /**
      * Current success rate/counter.
      */
      private final AtomicInteger currentState;
  
      /**
       * Creates a progress bar with the given amount as 100 percent.
       *
       * @param maxCapacity Defines the 100%-scale for this progress bar.
       */
      public ProgressBar(final int maxCapacity) {
          currentState = new AtomicInteger(0);
          init(maxCapacity);
      }
  
      /**
       * Perform internal initialization of UI components.
       *
       * @param maxCapacity Sets the 100% value of this component to this absolute
       *                    value.
       */
      private void init(final int maxCapacity) {
          // set window title
          this.setTitle(
                  getBundleString("fotorenamer.ui.progress"));
  
          this.setResizable(false);
          this.progressBar = new JProgressBar(0, maxCapacity);
  
          JLabel info = new JLabel(
                  getBundleString(
                          "fotorenamer.ui.progress.title"));
          this.textInfo = new JLabel();
          this.progressBar.setValue(0);
          this.progressBar.setStringPainted(true);
          // default value: 200 ms
          // calculate delay in UI depending on maximum capacity of the bar
         // itself; the more files the lower the delay
         this.delayInUI = maxCapacity < 35
                 ? DEFAULT_UI_DELAY : DEFAULT_UI_DELAY / 3;
 
         this.getContentPane().setLayout(new GridLayout(3, 1));
         this.getContentPane().add(info);
         this.getContentPane().add(textInfo);
         this.getContentPane().add(progressBar);
         ComponentGaugeUtil.makeCentered(this);
         this.pack();
         this.setVisible(true);
     } // end of init
 
     /**
      * After any changes the UI needs to be repainted and recentered which is
      * done by that method. This method waits 200ms in order to make the UI more
      * human readable.
      */
     public final void updateUI() {
         this.pack();
         ComponentGaugeUtil.makeCentered(this);
 
         // TODO replace with a Timer - see
         // http://download.oracle.com/javase/tutorial/uiswing/misc/timer.html
         try {
             TimeUnit.MILLISECONDS.sleep(this.delayInUI);
         } catch (InterruptedException e) {
             Thread.currentThread().interrupt();
             LOG.error("Thread sleep error during repaint of ProgressBar, " + e.getMessage());
         }
     }
 
     /**
      * Set progress by setting the amount of items that are processed
      * successfully.
      */
     public final void setProgress() {
         this.progressBar.setValue(currentState.getAndIncrement());
     }
 
     /**
      * Sets the part of this component that shows above the graphical bar.
      *
      * @param textContent Content to show under the graphical progress bar.
      */
     public final void setText(final String textContent) {
         this.textInfo.setText(textContent);
     }
 
     /**
      * Getter for text value.
      *
      * @return Current text value.
      */
     public final String getText() {
         return textInfo.getText();
     }
 
     /**
      * Getter for current step/progress.
      *
      * @return Current absolute progress value (step).
      */
     public final int getProgress() {
         return progressBar.getValue();
     }
 }