ModalDialogProgressIndicator.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011-2019 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * 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
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 org.sleuthkit.autopsy.progress;

import java.awt.Dialog;
import java.awt.Frame;
import java.awt.event.ActionListener;
import javax.annotation.concurrent.GuardedBy;
import javax.annotation.concurrent.ThreadSafe;
import javax.swing.JDialog;
import javax.swing.SwingUtilities;
import org.apache.commons.lang3.SerializationUtils;
import org.openide.DialogDescriptor;
import org.openide.DialogDisplayer;
import org.openide.util.HelpCtx;

@ThreadSafe
public final class ModalDialogProgressIndicator implements ProgressIndicator {

    private final Frame parent;
    private final String title;
    private final ProgressPanel progressPanel;
    private final Object[] buttonLabels;
    private final Object focusedButtonLabel;
    private final ActionListener buttonListener;
    private Dialog dialog;
    @GuardedBy("this")
    private boolean cancelling;

    public ModalDialogProgressIndicator(Frame parent, String title, Object[] buttonLabels, Object focusedButtonLabel, ActionListener buttonListener) {
        this.parent = parent;
        this.title = title;
        progressPanel = new ProgressPanel();
        progressPanel.setIndeterminate(true);
        this.buttonLabels = SerializationUtils.clone(buttonLabels);
        this.focusedButtonLabel = focusedButtonLabel;
        this.buttonListener = buttonListener;
    }

    public ModalDialogProgressIndicator(Frame parent, String title) {
        this.parent = parent;
        this.title = title;
        progressPanel = new ProgressPanel();
        progressPanel.setIndeterminate(true);
        this.buttonLabels = null;
        this.focusedButtonLabel = null;
        this.buttonListener = null;
    }

    @Override
    public synchronized void start(String message, int totalWorkUnits) {
        cancelling = false;
        SwingUtilities.invokeLater(() -> {
            progressPanel.setIndeterminate(false);
            progressPanel.setMessage(message);
            progressPanel.setMaximum(totalWorkUnits);
            displayDialog();
        });
    }

    @Override
    public synchronized void start(String message) {
        cancelling = false;
        SwingUtilities.invokeLater(() -> {
            progressPanel.setIndeterminate(true);
            progressPanel.setMessage(message);
            displayDialog();
        });
    }

    @Override
    public synchronized void setCancelling(String cancellingMessage) {
        cancelling = true;
        SwingUtilities.invokeLater(() -> {
            progressPanel.setIndeterminate(false);
            progressPanel.setMessage(cancellingMessage);
        });
    }

    @Override
    public synchronized void switchToIndeterminate(String message) {
        if (!cancelling) {
            SwingUtilities.invokeLater(() -> {
                progressPanel.setIndeterminate(true);
                progressPanel.setMessage(message);
            });
        }
    }

    @Override
    public synchronized void switchToDeterminate(String message, int workUnitsCompleted, int totalWorkUnits) {
        if (!cancelling) {
            SwingUtilities.invokeLater(() -> {
                progressPanel.setIndeterminate(false);
                progressPanel.setMessage(message);
                progressPanel.setMaximum(totalWorkUnits);
                progressPanel.setCurrent(workUnitsCompleted);
            });
        }
    }

    @Override
    public synchronized void progress(String message) {
        if (!cancelling) {
            SwingUtilities.invokeLater(() -> {
                progressPanel.setMessage(message);
            });
        }
    }

    @Override
    public synchronized void progress(int workUnitsCompleted) {
        if (!cancelling) {
            SwingUtilities.invokeLater(() -> {
                progressPanel.setCurrent(workUnitsCompleted);
            });
        }
    }

    @Override
    public synchronized void progress(String message, int workUnitsCompleted) {
        if (!cancelling) {
            SwingUtilities.invokeLater(() -> {
                progressPanel.setMessage(message);
                progressPanel.setCurrent(workUnitsCompleted);
            });
        }
    }

    @Override
    public synchronized void finish() {
        SwingUtilities.invokeLater(() -> {
            this.dialog.setVisible(false);
            this.dialog.dispose();
        });
    }

    private void displayDialog() {
        if (null != buttonLabels && null != focusedButtonLabel && null != buttonListener) {
            /*
             * Dialog with buttons.
             */
            DialogDescriptor dialogDescriptor = new DialogDescriptor(
                    progressPanel,
                    title,
                    true,
                    buttonLabels,
                    focusedButtonLabel,
                    DialogDescriptor.BOTTOM_ALIGN,
                    HelpCtx.DEFAULT_HELP,
                    buttonListener);
            dialog = DialogDisplayer.getDefault().createDialog(dialogDescriptor, parent);
        } else {
            /*
             * Dialog without buttons.
             */
            dialog = new JDialog(parent, title, true);
            dialog.add(progressPanel);
            dialog.pack();
        }
        dialog.setResizable(false);
        dialog.setLocationRelativeTo(parent);
        this.dialog.setVisible(true);
    }
    
    public Dialog getDialog() {
        return this.dialog;
    }
}