Aplicación gvSIG con fines educativos

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * 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 General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.educa.thematicmap.impl.editor;

import java.awt.BorderLayout;

import java.net.URL;

import java.util.ArrayList;

import java.util.List;

import javax.swing.BorderFactory;

import javax.swing.ImageIcon;

import javax.swing.JComponent;

import javax.swing.JPanel;

import org.gvsig.educa.thematicmap.ThematicMapLocator;

import org.gvsig.educa.thematicmap.ThematicMapManager;

import org.gvsig.educa.thematicmap.ThematicMapWindowManager.MESSAGE_DIALOG_TYPE;

import org.gvsig.educa.thematicmap.compilation.CompilationValidationMessage;

import org.gvsig.educa.thematicmap.compilation.ThematicMapCompilation;

import org.gvsig.educa.thematicmap.editor.ThematicMapCompilationEditor;

import org.gvsig.educa.thematicmap.editor.ThematicMapCompilationEditorListener;

import org.gvsig.educa.thematicmap.impl.IconThemeHelper;

import org.gvsig.gui.beans.wizard.WizardPanel;

import org.gvsig.gui.beans.wizard.WizardPanelActionListener;

import org.gvsig.gui.beans.wizard.WizardPanelWithLogo;

/**

 * <p>

 * Default implementation of {@link ThematicMapCompilationEditor}

 * </p>

 * <p>

 * This uses <i>org.gvsig.ui</i> Wizard implementation.

 * </p>

 * <p>

 * There are three steps:

 * <ol>

 * <li>{@link StepIdentification}: Base values for <i>Thematic Map</i>

 * identification</li>

 * <li>{@link StepLayers}: Layers definition which will compound the <i>Thematic

 * Map</i></li>

 * <li>{@link StepValidation}: validation of all data</li>

 * </ol>

 * </p>

 * 

 * @author gvSIG Team

 * @version $Id$

 * 

 */

public class DefaultThematicMapCompilationEditor extends JPanel implements

    ThematicMapCompilationEditor, WizardPanel, WizardPanelActionListener {

    /**

     *

     */

    private static final long serialVersionUID = -9153359086582532100L;

    private final ThematicMapManager manager;

    private final ThematicMapCompilation compilation;

    /**

     * Wizard component

     */

    private WizardPanelWithLogo wizard;

    /**

     * Wizard step for input Thematic Map information values

     */

    private StepIdentification stepIdentification;

    /**

     * Wizard step to configure layer composition

     */

    private StepLayers stepLayers;

    /**

     * Wizard step to validate all data

     */

    private StepValidation stepValidation;

    /**

     * UI initialized flag

     */

    private boolean initialized = false;

    private ThematicMapCompilationEditorListener listener;

    private final boolean editLayers;

    private boolean allowChangeId = true;

    public DefaultThematicMapCompilationEditor(

        ThematicMapCompilation compilation) {

        this(compilation, true);

    }

    /**

     * @param thematicMapCompilation

     * @param editLayers

     */

    public DefaultThematicMapCompilationEditor(

        ThematicMapCompilation compilation, boolean editLayers) {

        manager = ThematicMapLocator.getManager();

        this.compilation = compilation;

        this.editLayers = editLayers;

    }

    /**

     * Initialize all UI component of the panel

     */

    private void initializeUI() {

        if (initialized) {

            return;

        }

        setBorder(BorderFactory.createEmptyBorder(5, 5, 5, 5));

//        URL iconURL =

//            getClass().getClassLoader().getResource(

//                "images/thematicmap-editor.png");

        ImageIcon icon = IconThemeHelper.getImageIcon("thematicmap-editor-wizard");

        wizard = new WizardPanelWithLogo(icon);

        stepIdentification = new StepIdentification(this, allowChangeId);

        stepValidation = new StepValidation(this);

        // TODO: if thematicmap is a game, add the list of optionPanels to the wizard.

        wizard.addOptionPanel(stepIdentification);

        if (editLayers) {

            stepLayers = new StepLayers(this);

            wizard.addOptionPanel(stepLayers);

        }

        wizard.addOptionPanel(stepValidation);

        wizard.setWizardListener(this);

        setFinishButtonEnabled(false);

        this.setLayout(new BorderLayout());

        this.add(wizard, BorderLayout.CENTER);

        wizard.show();

        initialized = true;

    }

    /** {@inheridDoc} */

    public JComponent getSwingComponent() {

        initializeUI();

        return this;

    }

    /** {@inheridDoc} */

    public ThematicMapCompilation getCompilation() {

        return compilation;

    }

    /** {@inheridDoc} */

    public boolean goToFirstStep() {

        wizard.doAction(WizardPanelWithLogo.ACTION_FINISH);

        return true;

    }

    /** {@inheridDoc} */

    public boolean goNextStep() {

        wizard.doAction(WizardPanelWithLogo.ACTION_NEXT);

        return true;

    }

    /** {@inheridDoc} */

    public boolean goPreviousStep() {

        wizard.doAction(WizardPanelWithLogo.ACTION_PREVIOUS);

        return true;

    }

    /** {@inheridDoc} */

    public boolean goToLastStep() {

        wizard.doAction(WizardPanelWithLogo.ACTION_FINISH);

        return true;

    }

    /** {@inheridDoc} */

    public boolean isLastStep() {

        return wizard.getWizardComponents().getCurrentIndex() == wizard

            .getWizardComponents().getWizardPanelList().size() - 1;

    }

    /** {@inheridDoc} */

    public boolean isFirstStep() {

        return wizard.getWizardComponents().getCurrentIndex() == 0;

    }

    /** {@inheridDoc} */

    public boolean isCompilationValid() {

        List<CompilationValidationMessage> messages =

            new ArrayList<CompilationValidationMessage>();

        return compilation.isValid(messages);

    }

    public void setNextButtonEnabled(boolean isEnabled) {

        wizard.setNextButtonEnabled(isEnabled);

    }

    public void setCancelButtonEnabled(boolean isEnabled) {

        wizard.setCancelButtonEnabled(isEnabled);

    }

    public void setFinishButtonEnabled(boolean isEnabled) {

        wizard.setFinishButtonEnabled(isEnabled);

    }

    public void setBackButtonEnabled(boolean isEnabled) {

        wizard.setBackButtonEnabled(isEnabled);

    }

    /**

     * Finalizes wizard

     */

    public void finish() {

        // Checks all steps

        if (!updateFinishButton()) {

            return;

        }

        // Checks that compilation is valid

        if (!isCompilationValid()) {

            manager.getWindowManager().showMessageDialog(

                this.getSwingComponent(),

                manager.getTranslation("thematic_map_compilation_editor"),

                manager.getTranslation("current_values_are_not_valid"),

                MESSAGE_DIALOG_TYPE.ERROR);

            return;

        }

        close();

        this.listener.finished(this);

    }

    /**

     * Cancels wizard

     */

    public void cancel() {

        close();

        this.listener.canceled(this);

    }

    /**

     * Close this panel

     */

    private void close() {

        this.setVisible(false);

    }

    /** {@inheridDoc} */

    public void setListener(ThematicMapCompilationEditorListener listener) {

        this.listener = listener;

    }

    /**

     * Checks all steps states

     * 

     * @return true if all steps are ok

     */

    public boolean updateFinishButton() {

        if (!stepIdentification.isPanelDataOk()) {

            setFinishButtonEnabled(false);

            return false;

        }

        if (editLayers && !stepLayers.isPanelDataOk()) {

            setFinishButtonEnabled(false);

            return false;

        }

        if (!stepValidation.isPanelDataOk()) {

            setFinishButtonEnabled(false);

            return false;

        }

        setFinishButtonEnabled(true);

        return true;

    }

    /** {@inheridDoc} */

    public void setWizardPanelActionListener(

        WizardPanelActionListener wizardActionListener) {

        // Nothing to do

    }

    /** {@inheridDoc} */

    public WizardPanelActionListener getWizardPanelActionListener() {

        return this;

    }

    /** {@inheridDoc} */

    public void finish(WizardPanel wizardPanel) {

        finish();

    }

    /** {@inheridDoc} */

    public void cancel(WizardPanel wizardPanel) {

        cancel();

    }

    public void allowChangeId(boolean allow) {

        allowChangeId = allow;

        if (stepIdentification != null) {

            stepIdentification.allowChangeId(allow);

        }

    }

    public boolean isAllowedChangeId() {

        return allowChangeId;

    }

}