com.googlecode.gflot.client.options.BarSeriesOptions.java Source code

Introduction

Here is the source code for com.googlecode.gflot.client.options.BarSeriesOptions.java

Source

/*
 * Copyright (c) 2012 Nicolas Morel
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */
package com.googlecode.gflot.client.options;

import com.google.gwt.core.client.JavaScriptObject;

/**
 * @author AlexanderDeleon
 */
public class BarSeriesOptions extends AbstractBasicSeriesOptions<BarSeriesOptions> {
    public enum BarAlignment {
        CENTER("center"), LEFT("left"), RIGHT("right");

        private final String flotValue;

        private BarAlignment(String flotValue) {
            this.flotValue = flotValue;
        }

        public String getFlotValue() {
            return flotValue;
        }

        static BarAlignment findByFlotValue(String flotValue) {
            if (null != flotValue && !"".equals(flotValue)) {
                for (BarAlignment mode : values()) {
                    if (mode.getFlotValue().equals(flotValue)) {
                        return mode;
                    }
                }
            }
            return null;
        }
    }

    /**
     * Creates a {@link BarSeriesOptions}
     */
    public static final BarSeriesOptions create() {
        return JavaScriptObject.createObject().cast();
    }

    private static final String BAR_WIDTH_KEY = "barWidth";
    private static final String ALIGN_KEY = "align";
    private static final String HORIZONTAL_KEY = "horizontal";
    private static final String ORDER_KEY = "order";
    private static final String ZERO_KEY = "zero";

    protected BarSeriesOptions() {
    }

    /**
     * Set the width of the bars in units of the x axis (or the y axis if "horizontal" is true), contrary to most other
     * measures that are specified in pixels. For instance, for time series the unit is milliseconds so 24 * 60 * 60 *
     * 1000 produces bars with the width of a day.
     */
    public final BarSeriesOptions setBarWidth(double width) {
        put(BAR_WIDTH_KEY, new Double(width));
        return this;
    }

    /**
     * @return the width of the bars in units of the x axis (or the y axis if "horizontal" is true)
     */
    public final Double getBarWidth() {
        return getDouble(BAR_WIDTH_KEY);
    }

    /**
     * Clear the bar width
     */
    public final BarSeriesOptions clearBarWidth() {
        clear(BAR_WIDTH_KEY);
        return this;
    }

    /**
     * Set whether a bar should be left-aligned (default) or centered on top of the value it represents.
     */
    public final BarSeriesOptions setAlignment(BarAlignment alignment) {
        assert null != alignment : "alignment can't be null";

        put(ALIGN_KEY, alignment.getFlotValue());
        return this;
    }

    /**
     * @return the bar alignment
     */
    public final BarAlignment getAlignment() {
        return BarAlignment.findByFlotValue(getString(ALIGN_KEY));
    }

    /**
     * Clear the bar alignment
     */
    public final BarSeriesOptions clearAlignment() {
        clear(ALIGN_KEY);
        return this;
    }

    /**
     * Set if the bars are drawn horizontally, i.e. from the y axis instead of the x axis; note that the bar end points
     * are still defined in the same way so you'll probably want to swap the coordinates if you've been plotting
     * vertical bars first.
     */
    public final BarSeriesOptions setHorizontal(boolean horizontal) {
        put(HORIZONTAL_KEY, horizontal);
        return this;
    }

    /**
     * @return true if the bars are drawn horizontally
     */
    public final Boolean getHorizontal() {
        return getBoolean(HORIZONTAL_KEY);
    }

    /**
     * Clear if the bars are drawn horizontally
     */
    public final BarSeriesOptions clearHorizontal() {
        clear(HORIZONTAL_KEY);
        return this;
    }

    /**
     * Set the order for this serie. If two series have the same order, they are displayed in the same position
     */
    public final BarSeriesOptions setOrder(double order) {
        put(ORDER_KEY, order);
        return this;
    }

    /**
     * Set the order for this serie. If two series have the same order, they are displayed in the same position
     */
    public final BarSeriesOptions setOrder(String order) {
        put(ORDER_KEY, order);
        return this;
    }

    /**
     * @return the order as a number
     */
    public final Double getOrderAsDouble() {
        return getDouble(ORDER_KEY);
    }

    /**
     * @return the order as a String
     */
    public final String getOrderAsString() {
        return getString(ORDER_KEY);
    }

    /**
     * Clear the order
     */
    public final BarSeriesOptions clearOrder() {
        clear(ORDER_KEY);
        return this;
    }

    /**
     * Set whether the y-axis minimum is scaled to fit the data or set to zero
     */
    public final BarSeriesOptions setZero(boolean zero) {
        put(ZERO_KEY, zero);
        return this;
    }

    /**
     * @return true if the y-axis minimum is set to zero
     */
    public final Boolean getZero() {
        return getBoolean(ZERO_KEY);
    }

    /**
     * Clear whether the y-axis minimum is scaled to fit the data or set to zero
     */
    public final BarSeriesOptions clearZero() {
        clear(ZERO_KEY);
        return this;
    }
}