com.sothawo.mapjfx.MapCoordinateElement Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mapjfx Show documentation
a JavaFX map component build by using OpenLayers
There is a newer version: 3.1.0
/*
 Copyright 2015-2020 Peter-Josef Meisch ([email protected])

   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 com.sothawo.mapjfx;

import javafx.beans.property.SimpleIntegerProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.beans.property.SimpleStringProperty;

/**
 * Common base class for elements on the map that have a defined position on the map.
 *
 * @author P.J. Meisch ([email protected]).
 */
public abstract class MapCoordinateElement extends MapElement {

    /** the coordinate */
    protected final SimpleObjectProperty position = new SimpleObjectProperty<>();
    /** horizontal offset */
    protected final int offsetX;
    /** the vertical offset */
    protected final int offsetY;
    /** custom css style name. */
    protected SimpleStringProperty cssClass = new SimpleStringProperty("");
    /** the rotation of the element. */
    protected SimpleIntegerProperty rotation = new SimpleIntegerProperty(0);

    public MapCoordinateElement() {
        this(0, 0);
    }

    public MapCoordinateElement(int offsetX, int offsetY) {
        this.offsetX = offsetX;
        this.offsetY = offsetY;
    }


    public int getOffsetX() {
        return offsetX;
    }

    public int getOffsetY() {
        return offsetY;
    }

    public String getCssClass() {
        return cssClass.get();
    }

    /**
     * sets the cssClass for the Label
     *
     * @param cssClass
     *     class name
     * @return this object
     */
    public MapCoordinateElement setCssClass(final String cssClass) {
        this.cssClass.set((null == cssClass) ? "" : cssClass);
        return this;
    }

    public SimpleStringProperty cssClassProperty() {
        return cssClass;
    }

    public Integer getRotation() {
        return rotation.get();
    }

    /**
     * sets the rotation of the element on the map.
     *
     * @param rotation
     *     rotation value
     * @return this object
     */
    public MapCoordinateElement setRotation(final Integer rotation) {
        this.rotation.set(rotation == null ? 0 : rotation);
        return this;
    }

    public SimpleIntegerProperty rotationProperty() {
        return rotation;
    }

    /**
     * @return the marker's id
     */
    public abstract String getId();

    @Override
    public String toString() {
        return "MapCoordinateElement{" +
            "position=" + position +
            ", offsetX=" + offsetX +
            ", offsetY=" + offsetY +
            ", cssClass=" + cssClass +
            ", rotation=" + rotation +
            ", visible=" + visible +
            "} " + super.toString();
    }

    public Coordinate getPosition() {
        return position.get();
    }

    public SimpleObjectProperty positionProperty() {
        return position;
    }

    /**
     * sets the marker's new position
     *
     * @param position
     *     new position
     * @return this object
     */
    public MapCoordinateElement setPosition(Coordinate position) {
        this.position.set(position);
        return this;
    }
}