com.jwebmp.plugins.jqplot.options.legends.JQPlotLegendRendererEnhancedOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jwebmp-jqplot Show documentation
The JWebSwing implementation for JQPlot Plugin
There is a newer version: 1.2.2.1-jre17
/*
 * Copyright (C) 2017 GedMarc
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package com.jwebmp.plugins.jqplot.options.legends;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonRawValue;
import com.jwebmp.core.htmlbuilder.javascript.JavaScriptPart;
import com.jwebmp.plugins.jqplot.JQPlotGraph;
import com.jwebmp.plugins.jqplot.parts.interfaces.JQPlotLegendRenderer;

import jakarta.validation.constraints.NotNull;

/**
 * @author GedMarc
 * @since 1 Mar 2016
 */
public class JQPlotLegendRendererEnhancedOptions>
		extends JavaScriptPart
		implements JQPlotLegendRenderer
{

	@JsonIgnore
	private JQPlotGraph linkedGraph;
	/**
	 * Maximum number of rows in the legend.
	 */
	private Integer numberRows;
	/**
	 * Maximum number of columns in the legend.
	 */
	private Integer numberColumns;
	/**
	 * false to not enable series on/off toggling on the legend.
	 */
	private Boolean seriesToggle;
	/**
	 * True to replot the chart after toggling series on/off.
	 */
	private Boolean seriesToggleReplot;
	/**
	 * true to toggle series with a show/hide method only and not allow fading in/out.
	 */
	private Boolean disableIEFading;

	/**
	 * The Default Axis Label Renderer Options
	 *
	 * @param linkedGraph
	 */
	public JQPlotLegendRendererEnhancedOptions(JQPlotGraph linkedGraph)
	{
		this.linkedGraph = linkedGraph;
	}

	@JsonProperty("renderer")
	@JsonRawValue
	@JsonIgnore
	@Override
	public String getRenderer()
	{
		return "$.jqplot.EnhancedLegendRenderer";
	}

	/**
	 * Gets the linked graph
	 *
	 * @return
	 */
	public JQPlotGraph getLinkedGraph()
	{
		return linkedGraph;
	}

	/**
	 * Sets the linked graph
	 *
	 * @param linkedGraph
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setLinkedGraph(JQPlotGraph linkedGraph)
	{
		this.linkedGraph = linkedGraph;
		return (J) this;
	}

	/**
	 * Maximum number of rows in the legend.
	 *
	 * @return
	 */
	public Integer getNumberRows()
	{
		return numberRows;
	}

	/**
	 * Maximum number of rows in the legend.
	 *
	 * @param numberRows
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setNumberRows(Integer numberRows)
	{
		this.numberRows = numberRows;
		return (J) this;
	}

	/**
	 * Maximum number of columns in the legend.
	 *
	 * @return
	 */
	public Integer getNumberColumns()
	{
		return numberColumns;
	}

	/**
	 * Maximum number of columns in the legend.
	 *
	 * @param numberColumns
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setNumberColumns(Integer numberColumns)
	{
		this.numberColumns = numberColumns;
		return (J) this;
	}

	/**
	 * false to not enable series on/off toggling on the legend.
	 *
	 * @return
	 */
	public Boolean getSeriesToggle()
	{
		return seriesToggle;
	}

	/**
	 * false to not enable series on/off toggling on the legend.
	 *
	 * @param seriesToggle
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setSeriesToggle(Boolean seriesToggle)
	{
		this.seriesToggle = seriesToggle;
		return (J) this;
	}

	/**
	 * True to replot the chart after toggling series on/off.
	 *
	 * @return
	 */
	public Boolean getSeriesToggleReplot()
	{
		return seriesToggleReplot;
	}

	/**
	 * True to replot the chart after toggling series on/off.
	 *
	 * @param seriesToggleReplot
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setSeriesToggleReplot(Boolean seriesToggleReplot)
	{
		this.seriesToggleReplot = seriesToggleReplot;
		return (J) this;
	}

	/**
	 * true to toggle series with a show/hide method only and not allow fading in/out.
	 *
	 * @return
	 */
	public Boolean getDisableIEFading()
	{
		return disableIEFading;
	}

	/**
	 * true to toggle series with a show/hide method only and not allow fading in/out.
	 *
	 * @param disableIEFading
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setDisableIEFading(Boolean disableIEFading)
	{
		this.disableIEFading = disableIEFading;
		return (J) this;
	}

}