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

Introduction

Here is the source code for com.googlecode.gflot.client.options.ImageSeriesOptions.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 Nicolas Morel
 */
public class ImageSeriesOptions extends AbstractSeriesOptions<ImageSeriesOptions> {
    public enum ImageAnchor {
        CENTER("center"), CORNER("corner");

        private final String flotValue;

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

        public String getFlotValue() {
            return flotValue;
        }

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

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

    private static final String ANCHOR_KEY = "anchor";
    private static final String ALPHA_KEY = "alpha";

    protected ImageSeriesOptions() {
    }

    /**
     * Setting "anchor" to "center" causes the pixels in the image to be anchored at the corner pixel centers inside of
     * at the pixel corners, effectively letting half a pixel stick out to each side in the plot.
     */
    public final ImageSeriesOptions setAnchor(ImageAnchor anchor) {
        assert null != anchor : "anchor can't be null";

        put(ANCHOR_KEY, anchor.getFlotValue());
        return this;
    }

    /**
     * @return the anchor
     */
    public final ImageAnchor getAnchor() {
        return ImageAnchor.findByFlotValue(getString(ANCHOR_KEY));
    }

    /**
     * Clear the anchor
     */
    public final ImageSeriesOptions clearAnchor() {
        clear(ANCHOR_KEY);
        return this;
    }

    /**
     * Set the image alpha
     */
    public final ImageSeriesOptions setAlpha(double alpha) {
        assert alpha >= 0 && alpha <= 1 : "alpha range from 0.0 to 1.0";

        put(ALPHA_KEY, alpha);
        return this;
    }

    /**
     * @return the image alpha
     */
    public final Double getAlpha() {
        return getDouble(ALPHA_KEY);
    }

    /**
     * Clear the image alpha
     */
    public final ImageSeriesOptions clearAlpha() {
        clear(ALPHA_KEY);
        return this;
    }

}