com.anrisoftware.prefdialog.miscswing.dialogsworker.AbstractCreateDialogWorker.java Source code

Introduction

Here is the source code for com.anrisoftware.prefdialog.miscswing.dialogsworker.AbstractCreateDialogWorker.java

Source

/*
 * Copyright 2013-2016 Erwin Mller <erwin.mueller@deventm.org>
 *
 * This file is part of prefdialog-misc-swing.
 *
 * prefdialog-misc-swing is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * prefdialog-misc-swing 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 Lesser General Public License
 * along with prefdialog-misc-swing. If not, see <http://www.gnu.org/licenses/>.
 */
package com.anrisoftware.prefdialog.miscswing.dialogsworker;

import static javax.swing.SwingUtilities.invokeAndWait;
import static org.apache.commons.lang3.Validate.notNull;

import java.awt.Container;
import java.awt.Dimension;
import java.lang.ref.SoftReference;
import java.lang.reflect.InvocationTargetException;
import java.util.Locale;

import javax.inject.Inject;

import com.anrisoftware.resources.texts.api.TextResource;
import com.anrisoftware.resources.texts.api.Texts;

/**
 * Creates a dialog on the AWT event thread.
 *
 * @author Erwin Mller, erwin.mueller@deventm.de
 * @since 3.2
 */
public abstract class AbstractCreateDialogWorker<DialogType extends Container> {

    @Inject
    private DialogSizeListener dialogSizeListener;

    private SoftReference<DialogType> dialog;

    private Locale locale;

    private Texts texts;

    private String dialogTitleResourceName;

    private String dialogTitle;

    public void setLocale(Locale locale) {
        this.locale = locale;
    }

    public Locale getLocale() {
        return locale;
    }

    public void setTexts(Texts texts) {
        this.texts = texts;
    }

    public Texts getTexts() {
        return texts;
    }

    public void setDialogTitleResourceName(String name) {
        this.dialogTitleResourceName = name;
    }

    public String getDialogTitleResourceName() {
        return dialogTitleResourceName;
    }

    public void setDialogTitle(String dialogTitle) {
        this.dialogTitle = dialogTitle;
    }

    public String getDialogTitle() {
        return dialogTitle;
    }

    public Dimension getDialogSize() {
        return dialogSizeListener.getDialogSize();
    }

    /**
     * Forces the recreation of the dialog.
     *
     * @since 3.4
     */
    public synchronized void forceRecreationDialog() {
        this.dialog = null;
    }

    /**
     * Returns the dialog. If not already created, the dialog is created on the
     * AWT event thread.
     *
     * @return the dialog.
     *
     * @throws CreateDialogWorkerException
     *             if there was an error creating the dialog.
     *
     * @throws CreateDialogInterrupedException
     *             if the dialog creation on the AWT event thread was
     *             interrupted.
     */
    public synchronized DialogType getDialog() throws CreateDialogWorkerException, CreateDialogInterrupedException {
        if (needRecreateDialog()) {
            this.dialog = new SoftReference<DialogType>(doCreateDialog());
        }
        return dialog.get();
    }

    /**
     * Checks if the dialog needs to be recreated.
     *
     * @return {@code true} if the dialog needs to be recreated.
     *
     * @since 3.5
     */
    protected boolean needRecreateDialog() {
        return dialog == null || dialog.get() == null;
    }

    /**
     * Creates the dialog. The method is called on the AWT event thread.
     *
     * @return the dialog.
     */
    protected abstract DialogType createDialog();

    /**
     * Returns the dialog title either from the specified dialog title text, or
     * retrieved from the texts resources.
     *
     * @return the dialog {@link String} title.
     *
     * @since 3.3
     */
    protected final String getDialogTitleFromResource() {
        Texts texts = getTexts();
        if (texts != null) {
            String resourceName = getDialogTitleResourceName();
            notNull(resourceName, "DialogTitleResourceName=null");
            Locale locale = getLocale();
            notNull(locale, "locale=null");
            TextResource resource = texts.getResource(resourceName, locale);
            return resource.getText();
        } else {
            return getDialogTitle();
        }
    }

    private DialogType doCreateDialog() throws CreateDialogWorkerException, CreateDialogInterrupedException {
        try {
            return createDialogAWT();
        } catch (InvocationTargetException e) {
            throw new CreateDialogWorkerException(e.getCause());
        } catch (InterruptedException e) {
            throw new CreateDialogInterrupedException(e);
        }
    }

    private DialogType createDialogAWT() throws InterruptedException, InvocationTargetException {
        DialogCreator creator = new DialogCreator();
        invokeAndWait(creator);
        return creator.getDialog();
    }

    private class DialogCreator implements Runnable {

        private DialogType dialog;

        public DialogType getDialog() {
            return dialog;
        }

        @Override
        public void run() {
            dialog = createDialog();
            dialog.addComponentListener(dialogSizeListener);
        }

    }
}