AbstractOutsideFrame.java

/**
 * OrbisGIS is a java GIS application dedicated to research in GIScience.
 * OrbisGIS is developed by the GIS group of the DECIDE team of the 
 * Lab-STICC CNRS laboratory, see <http://www.lab-sticc.fr/>.
 *
 * The GIS group of the DECIDE team is located at :
 *
 * Laboratoire Lab-STICC – CNRS UMR 6285
 * Equipe DECIDE
 * UNIVERSITÉ DE BRETAGNE-SUD
 * Institut Universitaire de Technologie de Vannes
 * 8, Rue Montaigne - BP 561 56017 Vannes Cedex
 * 
 * OrbisGIS is distributed under GPL 3 license.
 *
 * Copyright (C) 2007-2014 CNRS (IRSTV FR CNRS 2488)
 * Copyright (C) 2015-2017 CNRS (Lab-STICC UMR CNRS 6285)
 *
 * This file is part of OrbisGIS.
 *
 * OrbisGIS 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 3 of the License, or (at your option) any later
 * version.
 *
 * OrbisGIS 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
 * OrbisGIS. If not, see <http://www.gnu.org/licenses/>.
 *
 * For more information, please consult: <http://www.orbisgis.org/>
 * or contact directly:
 * info_at_ orbisgis.org
 */
package org.orbisgis.sif;

import java.awt.*;
import java.awt.event.KeyEvent;
import java.awt.event.KeyListener;
import javax.swing.*;
import javax.swing.event.ChangeEvent;
import org.xnap.commons.i18n.I18n;
import org.xnap.commons.i18n.I18nFactory;

public abstract class AbstractOutsideFrame extends JDialog implements
        KeyListener {

        protected static final I18n I18N = I18nFactory.getI18n(AbstractOutsideFrame.class);
        private boolean accepted = false;
        protected JLabel errorLabel = new JLabel();

        /**
         * Implementation have to place the errorLabel
         * @param owner Parent window
         */
        public AbstractOutsideFrame(Window owner) {
                super(owner);
                errorLabel.setForeground(Color.RED.darker());
                errorLabel.setVisible(false);
        }

        @Override
        public void keyPressed(KeyEvent e) {
                int code = e.getKeyCode();
                if (code == KeyEvent.VK_ESCAPE) {
                        // Key pressed is the ESCAPE key. Hide this Dialog.
                        exit(false);
                }
        }

        protected abstract SimplePanel getSimplePanel();

        /**
         * Method to valid the panel
         *
         * @param ok
         */
        void exit(boolean ok) {
                boolean closePanel = !ok || validateInput();
                if (!closePanel) {
                        setVisible(true);
                } else {
                        setVisible(false);
                        dispose();
                }
                accepted = ok && closePanel;
        }

        /**
         * A method to validate the current panel
         *
         * @return
         */
        public boolean validateInput() {
                String err = getSimplePanel().getUIPanel().validateInput();
                if (err != null) {
                        errorLabel.setText(err);
                        errorLabel.setVisible(true);
                        return false;
                } else {
                        errorLabel.setText("");
                        errorLabel.setVisible(false);
                        return true;
                }
        }

        public boolean isAccepted() {
                return accepted;
        }

        public void stateChanged(ChangeEvent evt) {
        }

        @Override
        public void keyTyped(KeyEvent ke) {
        }

        @Override
        public void keyReleased(KeyEvent ke) {
        }
}