net.sf.jasperreports.charts.util.JRAxisFormat Maven / Gradle / Ivy
/*
* ============================================================================
* GNU Lesser General Public License
* ============================================================================
*
* JasperReports - Free Java report-generating library.
* Copyright (C) 2001-2009 JasperSoft Corporation http://www.jaspersoft.com
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
*
* JasperSoft Corporation
* 539 Bryant Street, Suite 100
* San Francisco, CA 94107
* http://www.jaspersoft.com
*/
package net.sf.jasperreports.charts.util;
import java.awt.Color;
import java.io.Serializable;
import net.sf.jasperreports.engine.JRConstants;
import net.sf.jasperreports.engine.JRFont;
/**
* Represents all the formatting options of a chart axis. The axis can be either a domain or
* a range axis, and any options that do not apply to the current axis are simply ignored.
*
* @author Barry Klawans ([email protected])
* @version $Id: JRAxisFormat.java 2693 2009-03-24 17:38:19Z teodord $
*/
public class JRAxisFormat implements Serializable {
private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;
/**
* The color to use when writing the label of the axis.
*/
protected Color labelColor = null;
/**
* The font to use when writing the label of the axis.
*/
protected JRFont labelFont = null;
/**
* The color to use when writing the label of each tick mark. Ignored if tick marks are
* disabled.
*/
protected Color tickLabelColor = null;
/**
* The font to use when writing the label of each tick mark. Ignored if tick marks
* are disabled.
*/
protected JRFont tickLabelFont = null;
/**
* The mask to use for formatting the label of each tick mark. Ignored if tick marks
* are disabled, or if the axis being formatted is not either numeric or a date axis.
*/
protected String tickLabelMask = null;
/**
* The color to use when drawing the axis line and tick marks, if enabled.
*/
protected Color lineColor = null;
/**
* Constructor.
*
*/
public JRAxisFormat() {}
/**
* Returns the color used when writing the label of the axis.
*
* @return the color used when writing the label of the axis
*/
public Color getLabelColor()
{
return labelColor;
}
/**
* Sets the color used when writing the label of the axis.
*
* @param labelColor the color to use when writing the label of the axis
*/
public void setLabelColor(Color labelColor)
{
this.labelColor = labelColor;
}
/**
* Returns the font used when writing the label of the axis.
*
* @return the font used when writing the label of the axis
*/
public JRFont getLabelFont()
{
return labelFont;
}
/**
* Sets the font used when writing the label of the axis.
*
* @param labelFont the font to use when writing the label of the axis
*/
public void setLabelFont(JRFont labelFont)
{
this.labelFont = labelFont;
}
/**
* Returns the color used when drawing the axis. This color is used for both
* the axis line itself and any tick marks present on the axis.
*
* @return the color used when drawing the axis.
*/
public Color getLineColor() {
return lineColor;
}
/**
* Sets the color used when drawing the axis. This color is used for both
* the axis line itself and any tick marks present on the axis.
*
* @param lineColor the color to use when drawing the axis.
*/
public void setLineColor(Color lineColor) {
this.lineColor = lineColor;
}
/**
* Returns the color used when writing the label of each tick mark.
*
* @return the color used when writing the label of each tick mark
*/
public Color getTickLabelColor() {
return tickLabelColor;
}
/**
* Sets the color to use when writing the label of each tick mark.
*
* @param tickLabelColor the color to use when writing the label of each tick mark
*/
public void setTickLabelColor(Color tickLabelColor) {
this.tickLabelColor = tickLabelColor;
}
/**
* Returns the font used when writing the label of each tick mark.
*
* @return the font used when writing the label of each tick mark
*/
public JRFont getTickLabelFont() {
return tickLabelFont;
}
/**
* Sets the font to use when writing the label of each tick mark.
*
* @param tickLabelFont the font to use when writing the label of each tick mark
*/
public void setTickLabelFont(JRFont tickLabelFont) {
this.tickLabelFont = tickLabelFont;
}
/**
* Returns the formatting mask used when writing the label of each tick mark.
*
* @return the formatting mask used when writing the label of each tick mark
*/
public String getTickLabelMask() {
return tickLabelMask;
}
/**
* Sets the formatting mask to user when writing the label of each tick mark.
*
* @param mask the formatting mask to use when writing the label of each tick mark
*/
public void setTickLabelMask(String mask) {
this.tickLabelMask = mask;
}
}