ConstantWKNLegend.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.legend.structure.graphic;

import org.orbisgis.coremap.renderer.se.graphic.MarkGraphic;
import org.orbisgis.legend.structure.fill.constant.ConstantSolidFillLegend;
import org.orbisgis.legend.structure.literal.StringLiteralLegend;
import org.orbisgis.legend.structure.stroke.constant.ConstantPenStrokeLegend;
import org.orbisgis.legend.structure.viewbox.ConstantViewBox;
import org.orbisgis.legend.structure.viewbox.ViewBoxLegendFactory;

/**
 * A Markgraphic, defined with a well-known name, whose all parameters are
 * constant, whatever the input data.
 * @author Alexis Guéganno
 */
public class ConstantWKNLegend extends ConstantFormWKN{

     public ConstantWKNLegend(MarkGraphic mg){
         super(mg, ViewBoxLegendFactory.createConstantViewBox(mg.getViewBox()));
     }

    /**
     * Build a new {@code ConstantWKNLegend}, associated to the given {@code
     * MarkGraphic}.
     * @param mark
     * @param wknLegend
     * @param viewBoxLegend
     * @param fillLegend
     * @param strokeLegend
     */
    public ConstantWKNLegend(MarkGraphic mark, StringLiteralLegend wknLegend,
            ConstantViewBox viewBoxLegend, ConstantSolidFillLegend fillLegend,
            ConstantPenStrokeLegend strokeLegend){
        super(mark, wknLegend, viewBoxLegend, fillLegend, strokeLegend);
    }

    /**
     * Get the height of the {@code ViewBox} used to define the size of the
     * associated {@code MarkGraphic}.
     * @return
     * A {@code Double} that can be null. A {@code ViewBox} can be defined with
     * only one dimension set.
     */
    public Double getViewBoxHeight() {
        return ((ConstantViewBox)getViewBoxLegend()).getHeight();
    }

    /**
     * Get the width of the {@code ViewBox} used to define the size of the
     * associated {@code MarkGraphic}.
     * @return
     * A {@code Double} that can be null. A {@code ViewBox} can be defined with
     * only one dimension set.
     */
    public Double getViewBoxWidth() {
        return ((ConstantViewBox)getViewBoxLegend()).getWidth();
    }

    /**
     * Set the height of the {@code ViewBox} used to define the size of the
     * associated {@code MarkGraphic}.
     * @param d
     * A {@code Double} that can be null. A {@code ViewBox} can be defined with
     * only one dimension set.
     */
    public void setViewBoxHeight(Double d) {
        ((ConstantViewBox)getViewBoxLegend()).setHeight(d);
    }

    /**
     * Set the width of the {@code ViewBox} used to define the size of the
     * associated {@code MarkGraphic}.
     * @param d
     * A {@code Double} that can be null. A {@code ViewBox} can be defined with
     * only one dimension set.
     */
    public void setViewBoxWidth(Double d) {
        ((ConstantViewBox)getViewBoxLegend()).setWidth(d);
    }
}