ScaleBarDecoration.java

/*
 *    Constellation - An open source and standard compliant SDI
 *    http://www.constellation-sdi.org
 *
 * Copyright 2014 Geomatys.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.constellation.configuration;

import org.geotoolkit.display2d.ext.scalebar.DefaultScaleBarTemplate;
import org.geotoolkit.display2d.ext.scalebar.ScaleBarTemplate;

import javax.measure.unit.Unit;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import java.awt.*;
import java.text.NumberFormat;

/**
 *
 * @author Quentin Boileau (Geomatys).
 */
@XmlAccessorType(XmlAccessType.FIELD)
public class ScaleBarDecoration extends PositionableDecoration {

    @XmlAttribute(name = "width")
    private Integer width;
    @XmlAttribute(name = "height")
    private Integer height;
    @XmlAttribute(name = "units")
    private String units;

    public ScaleBarDecoration() {
        super();
        this.width = 100;
        this.height = 20;
        this.units = "km";
    }

    public ScaleBarDecoration(final Integer width, final Integer height, final String units, final Background background,
            final Integer offsetX, final Integer offsetY, final String position) {
        super(background, offsetX, offsetY, position);
        this.width = width;
        this.height = height;
        this.units = units;
    }

    public Integer getWidth() {
        return width;
    }

    public void setWidth(Integer width) {
        this.width = width;
    }

    public Integer getHeight() {
        return height;
    }

    public void setHeight(Integer height) {
        this.height = height;
    }

    public String getUnits() {
        return units;
    }

    public void setUnits(String units) {
        this.units = units;
    }

    public ScaleBarTemplate toScaleBarTemplate() {
        String unit = units;
        if (unit == null || unit.isEmpty()) {
            unit = "km";
        }
        final Dimension dim = new Dimension(width != null ? width : 250, height != null ? height : 250);
        return new DefaultScaleBarTemplate(
                getBackground().toBackgroundTemplate(),
                dim,
                10,
                false,
                5,
                NumberFormat.getNumberInstance(),
                Color.BLACK,
                Color.BLACK,
                Color.WHITE,
                3,
                true,
                false,
                new Font("Serial", Font.PLAIN, 12),
                true,
                Unit.valueOf(unit));
    }
}