com.jwebmp.plugins.jqplot.options.title.JQPlotTitleOptions 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: 0.66.0.1
/*
 * Copyright (C) 2017 Marc Magon
 *
 * 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.title;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.jwebmp.core.htmlbuilder.css.colours.ColourHex;
import com.jwebmp.core.htmlbuilder.css.fonts.FontFamilies;
import com.jwebmp.core.htmlbuilder.css.text.TextAlignments;
import com.jwebmp.core.htmlbuilder.javascript.JavaScriptPart;
import com.jwebmp.plugins.jqplot.JQPlotGraph;
import com.jwebmp.plugins.jqplot.parts.interfaces.JQPlotTitleRenderer;

import javax.validation.constraints.NotNull;

/**
 * Handles the text attribute of the JWGraph
 * 
 *
 * @author mmagon
 * @since 2014/07/09
 */
public class JQPlotTitleOptions>
		extends JavaScriptPart
{

	@JsonIgnore
	private JQPlotGraph linkedGraph;

	/**
	 * text of the text
	 */
	private String text;
	/**
	 * Whether or not to show the text
	 */
	private Boolean show;

	/**
	 * CSS font-family spec for the text.
	 */
	private FontFamilies fontFamily;
	/**
	 * CSS font-size spec for the text.
	 */
	private Integer fontSize;
	/**
	 * CSS text-align spec for the text.
	 */
	private TextAlignments textAlign;
	/**
	 * CSS color spec for the text.
	 */
	private String textColor;
	/**
	 * for creating a DOM element for the text, see $.jqplot.DivTitleRenderer.
	 */
	private String renderer;

	private O rendererOptions;

	/**
	 * Constructs a Title Part for the JWGraph
	 * 

	 *
	 * @param title
	 * 		The text to add to the graph
	 * @param graph
	 * 		The linked graph
	 */
	public JQPlotTitleOptions(String title, JQPlotGraph graph)
	{
		text = title;
		linkedGraph = graph;
	}

	/**
	 * Whether or not to show the text
	 * 

	 *
	 * @return
	 */
	public Boolean getShow()
	{
		return show;
	}

	/**
	 * Whether or not to show the text
	 * 

	 *
	 * @param show
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setShow(Boolean show)
	{
		this.show = show;
		return (J) this;
	}

	/**
	 * Returns the actual text
	 * 

	 *
	 * @return
	 */
	public String getText()
	{
		return text;
	}

	/**
	 * Sets the actual text
	 * 

	 *
	 * @param text
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setText(String text)
	{
		this.text = text;
		return (J) this;
	}

	/**
	 * Returns the font family
	 * 

	 *
	 * @return
	 */
	public FontFamilies getFontFamily()
	{
		return fontFamily;
	}

	/**
	 * Sets the font family
	 * 

	 *
	 * @param fontFamily
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setFontFamily(FontFamilies fontFamily)
	{
		this.fontFamily = fontFamily;
		return (J) this;
	}

	/**
	 * Sets the font size
	 * 

	 *
	 * @return
	 */
	public Integer getFontSize()
	{
		return fontSize;
	}

	/**
	 * Sets the font size
	 * 

	 *
	 * @param fontSize
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setFontSize(Integer fontSize)
	{
		this.fontSize = fontSize;
		return (J) this;
	}

	/**
	 * Returns the text alignment
	 * 

	 *
	 * @return
	 */
	public TextAlignments getTextAlign()
	{
		return textAlign;
	}

	/**
	 * sets the text alignment
	 * 

	 *
	 * @param textAlign
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setTextAlign(TextAlignments textAlign)
	{
		this.textAlign = textAlign;
		return (J) this;
	}

	/**
	 * Sets the colour of the text
	 * 

	 *
	 * @return
	 */
	public String getTextColor()
	{
		return textColor;
	}

	/**
	 * Sets the text colour
	 * 

	 *
	 * @param textColor
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setTextColor(ColourHex textColor)
	{
		this.textColor = textColor.getValue();
		return (J) this;
	}

	/**
	 * Returns the text renderer
	 * 
	 *
	 * @return
	 */
	public String getRenderer()
	{
		return renderer;
	}

	/**
	 * Returns the current renderer options or the default
	 *
	 * @return
	 */
	public O getRendererOptions()
	{
		if (rendererOptions == null)
		{
			setRendererOptions((O) new JQPlotTitleOptionsDivTitle(linkedGraph));
		}
		return rendererOptions;
	}

	/**
	 * Sets the renderer options
	 *
	 * @param rendererOptions
	 */
	@SuppressWarnings("unchecked")
	@NotNull
	public J setRendererOptions(O rendererOptions)
	{
		this.rendererOptions = rendererOptions;
		renderer = rendererOptions.getRenderer();
		return (J) this;
	}

}