PnlUniqueAreaSE.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.view.toc.actions.cui.legend.ui;

import net.miginfocom.swing.MigLayout;
import org.orbisgis.legend.thematic.constant.UniqueSymbolArea;
import org.orbisgis.view.toc.actions.cui.legend.panels.AreaPanel;
import org.orbisgis.view.toc.actions.cui.legend.panels.PreviewPanel;
import org.orbisgis.view.toc.actions.cui.legend.panels.LinePanel;
import org.xnap.commons.i18n.I18n;
import org.xnap.commons.i18n.I18nFactory;

import javax.swing.JPanel;

/**
 * "Unique Symbol - Area" UI.
 *
 * @author Alexis Guéganno
 * @author Adam Gouge
 */
public final class PnlUniqueAreaSE extends PnlUniqueSymbolSE {

        private static final I18n I18N = I18nFactory.getI18n(PnlUniqueAreaSE.class);

        private UniqueSymbolArea uniqueArea;

        /**
         * Builds a panel based on a new legend.
         */
        public PnlUniqueAreaSE() {
            this(new UniqueSymbolArea());
        }

        /**
         * Builds a panel based on the given legend, displaying the UOM and the
         * Enable Area checkbox.
         *
         * @param legend Legend
         */
        public PnlUniqueAreaSE(UniqueSymbolArea legend) {
            this(legend, true, true, true);
        }

        /**
         * Builds a panel based on the given legend, hiding the UOM and optionally
         * displaying the Enable Area checkbox.
         *
         * @param legend         Legend
         * @param borderEnabled   Draw the Enable checkbox?
         */
        public PnlUniqueAreaSE(UniqueSymbolArea legend,
                               boolean borderEnabled) {
            this(legend, false, false, borderEnabled);
        }

        /**
         * Builds a panel based on the given legend, optionally displaying the
         * UOM and the Enable Area checkbox.
         *
         * @param legend        Legend
         * @param showCheckbox  Draw the Enable checkbox?
         * @param displayUOM    Display the unit of measure?
         * @param borderEnabled Is the border enabled?
         */
        private PnlUniqueAreaSE(UniqueSymbolArea legend,
                                boolean showCheckbox,
                                boolean displayUOM,
                                boolean borderEnabled) {
            super(showCheckbox, displayUOM, borderEnabled);
            this.uniqueArea = legend;
            initPreview();
            buildUI();
        }

        @Override
        public UniqueSymbolArea getLegend() {
                return uniqueArea;
        }

        @Override
        public void buildUI() {
                JPanel glob = new JPanel(new MigLayout());

                LinePanel linePanel = new LinePanel(uniqueArea,
                        getPreview(),
                        I18N.tr(BORDER_SETTINGS),
                        showCheckbox,
                        displayUOM);
                glob.add(linePanel,
                        "cell 0 0, span 1 2, aligny top");

                glob.add(new AreaPanel(uniqueArea,
                        getPreview(),
                        I18N.tr(FILL_SETTINGS),
                        showCheckbox),
                        "cell 1 0, growx");

                glob.add(new PreviewPanel(getPreview()),
                        "cell 1 1, growx");
                this.add(glob);
        }

        // ************************* UIPanel ***************************
        @Override
        public String getTitle() {
            return UniqueSymbolArea.NAME;
        }
}