PlotStyle.java

/* Copyright (c) 2007-2014 by panayotis.com
 *
 * JavaPlot is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, version 2.
 *
 * JavaPlot is free 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with CrossMobile; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Created on 26 Οκτώβριος 2007, 2:58 μμ
 */
package com.panayotis.gnuplot.style;

import com.panayotis.gnuplot.PropertiesHolder;

/**
 * This object represents the styles which can be used in gnuplot to personalize
 * each prot
 *
 * @author teras
 */
public class PlotStyle extends PropertiesHolder {

    private Style type;
    private FillStyle fill;
    private int labelOffsetX;
    private int labelOffsetY;
    private int labelPointType = -1;

    /**
     * Creates a new instance of PlotStyle with default parameters
     */
    public PlotStyle() {
        this(null);
    }

    /**
     * Creates a new instance of PlotStyle with a specified style
     *
     * @param style The style to use
     */
    @SuppressWarnings("OverridableMethodCallInConstructor")
    public PlotStyle(Style style) {
        super(" ", "");
        fill = null;
        setStyle(style);
    }

    /**
     * Set the current style to the given one
     *
     * @param style the style to use
     */
    public void setStyle(Style style) {
        this.type = style;
    }

    /**
     * Gather the properties of this style. This method is used internally by
     * GNUPlot
     *
     * @param buf The Srting buffer to store this object's properties.
     */
    @Override
    public void appendProperties(StringBuilder buf) {
        if (type != null) {
            buf.append(" with ").append(type.name().toLowerCase());
            if (type.equals(Style.LABELS)){
                if (!(labelOffsetX == 0 && labelOffsetY == 0)) {
                    buf.append(" offset ").append(labelOffsetX).append(',').append(labelOffsetY);
                }
                if (labelPointType != -1) {
                    buf.append(" point pt ").append(labelPointType);
                }
            }
            super.appendProperties(buf);
            if (fill != null && type.filled)
                fill.appendProperties(buf);
        }
    }

    /**
     * Set the line width of this graph
     *
     * @param width The line width. If this number is less than zero, then the
     * default parameter will be used
     */
    public void setLineWidth(int width) {
        if (width < 0)
            unset("linewidth");
        else
            set("linewidth", String.valueOf(width));
    }

    /**
     * Set the point size of this graph
     *
     * @param width The point size. If this number is less than zero, then the
     * default parameter will be used
     */
    public void setPointSize(int width) {
        if (width < 0)
            unset("pointsize");
        else
            set("pointsize", String.valueOf(width));
    }

    /**
     * Set the line type of this graph. This option is terminal dependent.
     *
     * @param type The line type. If this number is less than zero, then the
     * default parameter will be used
     */
    public void setLineType(int type) {
        if (type < -1)
            unset("linetype");
        else
            set("linetype", String.valueOf(type));
    }

    /**
     * Set the line type of this graph to be a specific color. This option is
     * terminal dependent.
     *
     * @param col The color to use. If this parameter is null, then the default
     * parameter will be used.
     */
    public void setLineType(PlotColor col) {
        if (col == null)
            unset("linetype");
        else
            set("linetype", col.getColor());
    }

    /**
     * Set the point type of this graph. This option is terminal dependent.
     *
     * @param type The point type. If this number is less than zero, then the
     * default parameter will be used
     */
    public void setPointType(int type) {
        if (type < -1)
            unset("pointtype");
        else
            set("pointtype", String.valueOf(type));
    }

    /**
     * Set the fill style of this graph. If the desired style does not support
     * fill then this parameter will be ignored.
     *
     * @param fillstyle The fill style to use. If this parameter is null, then
     * the default parameter will be used.
     */
    public void setFill(FillStyle fillstyle) {
        this.fill = fillstyle;
    }

    /**
     * Set the offset of label relative to the point. Used when style is LABELS.
     *
     * @param x
     * @param y
     */
    public void setLabelOffset(int x, int y){
        this.labelOffsetX = x;
        this.labelOffsetY = y;
    }

    /**
     * Set the point type of label. Used instead of setPointType() when style is LABELS.
     *
     * @param pointType
     */
    public void setLabelPointType(int pointType){
        this.labelPointType = pointType;
    }
}