com.anrisoftware.prefdialog.csvimportdialog.dialog.CsvImportDialog Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2013-2015 Erwin Müller 
 *
 * This file is part of prefdialog-csvimportdialog.
 *
 * prefdialog-csvimportdialog 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-csvimportdialog 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-csvimportdialog. If not, see .
 */
package com.anrisoftware.prefdialog.csvimportdialog.dialog;

import static com.anrisoftware.prefdialog.csvimportdialog.dialog.CsvImportDialogModule.getFactory;

import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.beans.PropertyVetoException;
import java.beans.VetoableChangeListener;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;

import javax.inject.Inject;
import javax.swing.JDialog;
import javax.swing.JFrame;
import javax.swing.JPanel;

import com.anrisoftware.globalpom.dataimport.CsvImportProperties;
import com.anrisoftware.prefdialog.csvimportdialog.importpanel.CsvImportPanel;
import com.anrisoftware.prefdialog.csvimportdialog.importpaneldock.ImportPanelDock;
import com.anrisoftware.prefdialog.csvimportdialog.panelproperties.panelproperties.CsvPanelProperties;
import com.anrisoftware.prefdialog.csvimportdialog.previewpaneldock.PreviewPanelDock;
import com.anrisoftware.prefdialog.fields.FieldComponent;
import com.anrisoftware.prefdialog.miscswing.awtcheck.OnAwt;
import com.anrisoftware.prefdialog.miscswing.docks.api.Dock;
import com.anrisoftware.prefdialog.miscswing.docks.api.DockFactory;
import com.anrisoftware.prefdialog.miscswing.docks.api.LayoutTask;
import com.anrisoftware.prefdialog.simpledialog.SimpleDialog;
import com.anrisoftware.resources.texts.api.Texts;
import com.anrisoftware.resources.texts.api.TextsFactory;
import com.google.inject.Injector;
import com.google.inject.assistedinject.Assisted;

/**
 * Dialog to import CSV data.
 *
 * @author Erwin Mueller, [email protected]
 * @since 3.0
 */
public class CsvImportDialog extends SimpleDialog {

    private static final String IMPORT_ACTION_NAME = "import_action";

    /**
     * @see #decorate(CsvImportProperties, JDialog, JFrame)
     */
    public static CsvImportDialog decorateCsvImportDialog(
            CsvImportProperties properties, JDialog dialog, JFrame frame) {
        return decorate(properties, dialog, frame);
    }

    /**
     * Decorates the dialog with the CSV import panel and dialog actions.
     *
     * @param properties
     *            the {@link CsvImportProperties}.
     *
     * @param dialog
     *            the {@link JDialog}.
     *
     * @param frame
     *            the {@link JFrame} owner or {@code null}.
     *
     * @return the {@link CsvImportDialog}.
     *
     * @see CsvImportDialogFactory#create(CsvImportProperties)
     */
    @OnAwt
    public static CsvImportDialog decorate(CsvImportProperties properties,
            JDialog dialog, JFrame frame) {
        CsvImportDialog importDialog;
        importDialog = getFactory().create(properties);
        importDialog.setDialog(dialog);
        importDialog.createDialog(frame);
        return importDialog;
    }

    private final CsvImportProperties properties;

    private final PropertyChangeListener propertyChangeListener;

    private final Dock dock;

    @Inject
    private ImportPanelDock importPanelDock;

    @Inject
    private PreviewPanelDock previewPanelDock;

    @Inject
    private Injector parent;

    @Inject
    private ValidListener validListener;

    @Inject
    private PropertiesWorkerFactory propertiesWorkerFactory;

    private Texts texts;

    /**
     * @see CsvImportDialogFactory#create(CsvImportProperties)
     */
    @Inject
    CsvImportDialog(DockFactory dockFactory,
            @Assisted CsvImportProperties properties) {
        this.dock = dockFactory.create();
        this.properties = properties;
        this.propertyChangeListener = new PropertyChangeListener() {

            @Override
            public void propertyChange(PropertyChangeEvent evt) {
                previewPanelDock.setProperties(importPanelDock.getProperties());
            }
        };
        setupDock();
    }

    @Inject
    void setTextsFactory(TextsFactory factory) {
        this.texts = factory.create(CsvImportDialog.class.getSimpleName());
    }

    /**
     * Sets the parent dependency modules.
     *
     * @param parent
     *            the parent {@link Inject}.
     */
    public void setParent(Injector parent) {
        this.parent = parent;
    }

    @Override
    @OnAwt
    public CsvImportDialog createDialog() {
        return createDialog(null);
    }

    /**
     * @see #createDialog()
     *
     * @param frame
     *            the parent {@link JFrame} owner or {@code null}.
     */
    @OnAwt
    public CsvImportDialog createDialog(JFrame frame) {
        dock.createDock(frame);
        setApproveActionName(IMPORT_ACTION_NAME);
        importPanelDock.createPanel(parent, properties);
        importPanelDock.addPropertyChangeListener(propertyChangeListener);
        setFieldsPanel(dock.getAWTComponent());
        previewPanelDock.createPanel(parent);
        previewPanelDock.setProperties(properties);
        dock.addViewDock(previewPanelDock);
        dock.addEditorDock(importPanelDock);
        setTexts(texts);
        validListener.installDialog(this);
        return (CsvImportDialog) super.createDialog();
    }

    /**
     * Returns the dock.
     *
     * @return the {@link Dock}.
     */
    public Dock getDock() {
        return dock;
    }

    /**
     * Sets the properties to the dialog fields.
     *
     * @param properties
     *            the {@link CsvImportProperties}.
     *
     * @throws PropertyVetoException
     *             if one of the values of the properties are vetoed.
     */
    @OnAwt
    public void setProperties(CsvImportProperties properties)
            throws PropertyVetoException {
        FieldComponent field = getImportPanelField();
        CsvPanelProperties p = (CsvPanelProperties) getProperties();
        propertiesWorkerFactory.create(field, p).setProperties(properties);
        previewPanelDock.setProperties(properties);
    }

    /**
     * Sets the properties to the dialog fields. if one of the values of the
     * properties is vetoed the value is skipped.
     *
     * @param properties
     *            the {@link CsvImportProperties}.
     */
    @OnAwt
    public void setPropertiesNoChecks(CsvImportProperties properties) {
        FieldComponent field = getImportPanelField();
        CsvPanelProperties p = (CsvPanelProperties) getProperties();
        propertiesWorkerFactory.create(field, p).setPropertiesNoChecks(
                properties);
        previewPanelDock.setProperties(properties);
    }

    /**
     * Returns the CSV import properties.
     *
     * @return the {@link CsvImportProperties}.
     */
    public CsvImportProperties getProperties() {
        return importPanelDock.getImportPanel().getProperties();
    }

    /**
     * Returns the import panel dock.
     *
     * @return the {@link ImportPanelDock}.
     */
    public ImportPanelDock getImportPanelDock() {
        return importPanelDock;
    }

    /**
     * Returns the CSV import panel field.
     *
     * @return the {@link FieldComponent}.
     */
    public FieldComponent getImportPanelField() {
        return importPanelDock.getImportPanel().getPanel();
    }

    /**
     * @see Dock#saveLayout(String, File)
     */
    public void saveLayout(String name, File file) throws IOException {
        dock.saveLayout(name, file);
    }

    /**
     * @see Dock#saveLayout(String, OutputStream)
     */
    public void saveLayout(String name, OutputStream stream) throws IOException {
        dock.saveLayout(name, stream);
    }

    /**
     * @see Dock#loadLayout(String, File, PropertyChangeListener...)
     */
    public void loadLayout(String name, File file,
            PropertyChangeListener... listeners) throws IOException {
        dock.loadLayout(name, file, listeners);
        dock.addEditorDock(importPanelDock);
    }

    /**
     * @see Dock#loadLayout(String, InputStream, PropertyChangeListener...)
     */
    public void loadLayout(String name, InputStream stream,
            PropertyChangeListener... listeners) throws IOException {
        dock.loadLayout(name, stream, listeners);
        dock.addEditorDock(importPanelDock);
    }

    /**
     * @see Dock#getCurrentLayout()
     */
    public LayoutTask getCurrentLayout() {
        return dock.getCurrentLayout();
    }

    /**
     * @see Dock#setTheme(String)
     */
    public void setTheme(String name) {
        dock.setTheme(name);
    }

    @Override
    public void openDialog() {
        importPanelDock.getImportPanel().requestFocus();
        super.openDialog();
    }

    @Override
    public void restoreDialog() {
        try {
            importPanelDock.restoreInput();
        } catch (PropertyVetoException e) {
        }
    }

    private void setupDock() {
    }

    /**
     * @see CsvImportPanel#addVetoableChangeListener(VetoableChangeListener)
     * @see SimpleDialog#addVetoableChangeListener(VetoableChangeListener)
     */
    @Override
    public void addVetoableChangeListener(VetoableChangeListener listener) {
        importPanelDock.addVetoableChangeListener(listener);
        super.addVetoableChangeListener(listener);
    }

    /**
     * @see CsvImportPanel#removeVetoableChangeListener(VetoableChangeListener)
     * @see SimpleDialog#removeVetoableChangeListener(VetoableChangeListener)
     */
    @Override
    public void removeVetoableChangeListener(VetoableChangeListener listener) {
        importPanelDock.removeVetoableChangeListener(listener);
        super.removeVetoableChangeListener(listener);
    }

    /**
     * @see CsvImportPanel#addVetoableChangeListener(String,
     *      VetoableChangeListener)
     * @see SimpleDialog#addVetoableChangeListener(String,
     *      VetoableChangeListener)
     */
    @Override
    public void addVetoableChangeListener(String propertyName,
            VetoableChangeListener listener) {
        importPanelDock.addVetoableChangeListener(propertyName, listener);
        super.addVetoableChangeListener(propertyName, listener);
    }

    /**
     * @see CsvImportPanel#removeVetoableChangeListener(String,
     *      VetoableChangeListener)
     * @see SimpleDialog#removeVetoableChangeListener(String,
     *      VetoableChangeListener)
     */
    @Override
    public void removeVetoableChangeListener(String propertyName,
            VetoableChangeListener listener) {
        importPanelDock.removeVetoableChangeListener(propertyName, listener);
        super.removeVetoableChangeListener(propertyName, listener);
    }

}