com.googlecode.gflot.client.Axes.java Source code

Introduction

Here is the source code for com.googlecode.gflot.client.Axes.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;

import com.google.gwt.core.client.JavaScriptObject;
import com.googlecode.gflot.client.jsni.JsonObject;

/**
 * @author Nicolas Morel
 */
public class Axes extends JsonObject {
    /**
     * Creates a {@link Axes}
     *
     * @return a {@link Axes}
     */
    public static Axes create() {
        return JavaScriptObject.createObject().cast();
    }

    private static final String X_AXIS_KEY_PREFIX = "x";
    private static final String X_AXIS_KEY_SUFFIX = "axis";
    private static final String Y_AXIS_KEY_PREFIX = "y";
    private static final String Y_AXIS_KEY_SUFFIX = "axis";

    protected Axes() {
    }

    /**
     * @return the x axis
     */
    public final Axis getX() {
        return getX(1);
    }

    /**
     * @param xAxisNumber the x axis number
     *
     * @return the x axis
     */
    public final Axis getX(int xAxisNumber) {
        assert xAxisNumber > 0 : "xAxisNumber starts at 1";
        if (xAxisNumber == 1) {
            return getJsObject(X_AXIS_KEY_PREFIX + X_AXIS_KEY_SUFFIX);
        } else {
            return getJsObject(X_AXIS_KEY_PREFIX + xAxisNumber + X_AXIS_KEY_SUFFIX);
        }
    }

    /**
     * @return the y axis
     */
    public final Axis getY() {
        return getY(1);
    }

    /**
     * @param yAxisNumber the y axis number
     *
     * @return the y axis
     */
    public final Axis getY(int yAxisNumber) {
        assert yAxisNumber > 0 : "yAxisNumber starts at 1";
        if (yAxisNumber == 1) {
            return getJsObject(Y_AXIS_KEY_PREFIX + Y_AXIS_KEY_SUFFIX);
        } else {
            return getJsObject(Y_AXIS_KEY_PREFIX + yAxisNumber + Y_AXIS_KEY_SUFFIX);
        }
    }

}