com.googlecode.wickedcharts.highcharts.options.Labels Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of highcharts-wrapper Show documentation
A Java wrapper dor the Highcharts javascript library to include interactive charts in your Java web application.
There is a newer version: 2.0.1
/**
 *   Copyright 2012-2013 Wicked Charts (http://wicked-charts.googlecode.com)
 *
 *   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.googlecode.wickedcharts.highcharts.options;

import java.io.Serializable;

/**
 * Defines some label in a chart.
 *
 * @author Tom Hombergs ([email protected])
 * @see http://api.highcharts.com/highcharts#Axis.plotLines.label
 * and others
 */
public class Labels implements Serializable {

    private static final long serialVersionUID = 1L;

    private HorizontalAlignment align;

    private Integer rotation;

    private CssStyle style;

    private Function formatter;

    private HorizontalAlignment textAlign;

    private VerticalAlignment verticalAlign;

    private Integer x;

    private Integer y;

    private String text;

    private Overflow overflow;

    private Integer step;

    private Boolean enabled;

    private String format;

    private Integer staggerLines;

    private Integer maxStaggerLines;

    public Labels() {

    }

    public Labels(final String text) {
        this.text = text;
    }

    public HorizontalAlignment getAlign() {
        return this.align;
    }

    public Function getFormatter() {
        return this.formatter;
    }

    public Overflow getOverflow() {
        return this.overflow;
    }

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

    public CssStyle getStyle() {
        return this.style;
    }

    public String getText() {
        return this.text;
    }

    public HorizontalAlignment getTextAlign() {
        return this.textAlign;
    }

    public VerticalAlignment getVerticalAlign() {
        return this.verticalAlign;
    }

    public Integer getX() {
        return this.x;
    }

    public Integer getY() {
        return this.y;
    }

    public Labels setAlign(final HorizontalAlignment align) {
        this.align = align;
        return this;
    }

    public Labels setFormatter(final Function formatter) {
        this.formatter = formatter;
        return this;
    }

    public Labels setOverflow(final Overflow overflow) {
        this.overflow = overflow;
        return this;
    }

    public Labels setRotation(final Integer rotation) {
        this.rotation = rotation;
        return this;
    }

    public Labels setStyle(final CssStyle style) {
        this.style = style;
        return this;
    }

    public Labels setText(final String text) {
        this.text = text;
        return this;
    }

    public Labels setTextAlign(final HorizontalAlignment textAlign) {
        this.textAlign = textAlign;
        return this;
    }

    public Labels setVerticalAlign(final VerticalAlignment verticalAlign) {
        this.verticalAlign = verticalAlign;
        return this;
    }

    public Labels setX(final Integer x) {
        this.x = x;
        return this;
    }

    public Labels setY(final Integer y) {
        this.y = y;
        return this;
    }

    public Labels setStep(Integer step) {
        this.step = step;
        return this;
    }

    public Integer getStep() {
        return step;
    }

    public Boolean getEnabled() {
        return enabled;
    }

    public Labels setEnabled(Boolean enabled) {
        this.enabled = enabled;
        return this;
    }

    public Integer getStaggerLines() {
        return staggerLines;
    }

    public Labels setStaggerLines(Integer staggerLines) {
        this.staggerLines = staggerLines;
        return this;
    }

    public String getFormat() {
        return format;
    }

    public Integer getMaxStaggerLines() {
        return maxStaggerLines;
    }

    public Labels setMaxStaggerLines(Integer maxStaggerLines) {
        this.maxStaggerLines = maxStaggerLines;
        return this;
    }

    /**
     * Sets the format string for an axis label. Defaults to "{value}".
     *
     * @param format the new format string. Use "{value}" as a placeholder for the axis value.
     * @see http://api.highcharts.com/highstock#xAxis.labels.format
     */
    public Labels setFormat(String format) {
        this.format = format;
        return this;
    }

}