001: /*
002: * ============================================================================
003: * GNU Lesser General Public License
004: * ============================================================================
005: *
006: * JasperReports - Free Java report-generating library.
007: * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
008: *
009: * This library is free software; you can redistribute it and/or
010: * modify it under the terms of the GNU Lesser General Public
011: * License as published by the Free Software Foundation; either
012: * version 2.1 of the License, or (at your option) any later version.
013: *
014: * This library is distributed in the hope that it will be useful,
015: * but WITHOUT ANY WARRANTY; without even the implied warranty of
016: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017: * Lesser General Public License for more details.
018: *
019: * You should have received a copy of the GNU Lesser General Public
020: * License along with this library; if not, write to the Free Software
021: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
022: *
023: * JasperSoft Corporation
024: * 303 Second Street, Suite 450 North
025: * San Francisco, CA 94107
026: * http://www.jaspersoft.com
027: */
028: package net.sf.jasperreports.charts.base;
029:
030: import net.sf.jasperreports.charts.JRValueDisplay;
031: import net.sf.jasperreports.engine.JRConstants;
032: import net.sf.jasperreports.engine.JRExpressionCollector;
033: import net.sf.jasperreports.engine.JRFont;
034: import net.sf.jasperreports.engine.base.JRBaseObjectFactory;
035:
036: import java.awt.Color;
037: import java.io.Serializable;
038:
039: /**
040: * An immutable representation of the formatting options for showing the
041: * value of a value dataset. Used by charts that display a single value,
042: * such as a Meter or Thermometer.
043: *
044: * @author Barry Klawans (bklawans@users.sourceforge.net)
045: * @version $Id: JRBaseValueDisplay.java 1793 2007-07-30 09:06:18Z teodord $
046: */
047: public class JRBaseValueDisplay implements JRValueDisplay, Serializable {
048:
049: /**
050: *
051: */
052: private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;
053:
054: /**
055: * The color to use when writing the value.
056: */
057: protected Color color = null;
058:
059: /**
060: * The formatting mask to use when writing the value. Must a pattern
061: * that is accepted by a code>java.text.DecimalFormat</code> object.
062: */
063: protected String mask = null;
064:
065: /**
066: * The font to use when writing the value.
067: */
068: protected JRFont font = null;
069:
070: /**
071: * Constructs a copy of an existing value format specification.
072: *
073: * @param valueDisplay the value formatting object to copy
074: */
075: public JRBaseValueDisplay(JRValueDisplay valueDisplay) {
076: if (valueDisplay != null) {
077: color = valueDisplay.getColor();
078: mask = valueDisplay.getMask();
079: font = valueDisplay.getFont();
080: }
081: }
082:
083: /**
084: * Constructs a copy of an existing value format specification and registers
085: * any expression in the new copy with the specified factory.
086: *
087: * @param valueDisplay the value formatting object to copy
088: * @param factory the factory object to register expressions with
089: */
090: public JRBaseValueDisplay(JRValueDisplay valueDisplay,
091: JRBaseObjectFactory factory) {
092: factory.put(valueDisplay, this );
093:
094: if (valueDisplay != null) {
095: color = valueDisplay.getColor();
096: mask = valueDisplay.getMask();
097: font = valueDisplay.getFont();
098: }
099: }
100:
101: /**
102: *
103: */
104: public Color getColor() {
105: return color;
106: }
107:
108: /**
109: *
110: */
111: public String getMask() {
112: return mask;
113: }
114:
115: /**
116: *
117: */
118: public JRFont getFont() {
119: return font;
120: }
121:
122: /**
123: * Adds all the expression used by this plot with the specified collector.
124: * All collected expression that are also registered with a factory will
125: * be included with the report is compiled.
126: *
127: * @param collector the expression collector to use
128: */
129: public void collectExpressions(JRExpressionCollector collector) {
130: }
131:
132: }
|