Package net.sf.jasperreports.charts.base
Class JRBaseValueDisplay
java.lang.Object
net.sf.jasperreports.charts.base.JRBaseValueDisplay
- All Implemented Interfaces:
Serializable
,Cloneable
,JRValueDisplay
,JRCloneable
- Direct Known Subclasses:
JRDesignValueDisplay
An immutable representation of the formatting options for showing the
value of a value dataset. Used by charts that display a single value,
such as a Meter or Thermometer.
- Author:
- Barry Klawans (bklawans@users.sourceforge.net)
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionJRBaseValueDisplay
(JRValueDisplay valueDisplay, ChartsBaseObjectFactory factory) Constructs a copy of an existing value format specification and registers any expression in the new copy with the specified factory.JRBaseValueDisplay
(JRValueDisplay valueDisplay, JRChart chart) Constructs a copy of an existing value format specification. -
Method Summary
Modifier and TypeMethodDescriptionclone()
void
collectExpressions
(JRExpressionCollector collector) Adds all the expression used by this plot with the specified collector.getChart()
getColor()
Returns the color to use when writing the value.getFont()
Returns the font to use when writing the value.getMask()
Returns the formatting mask to use when writing the value.
-
Field Details
-
chart
-
color
The color to use when writing the value. -
mask
The formatting mask to use when writing the value. Must a pattern that is accepted by ajava.text.DecimalFormat
object. -
font
The font to use when writing the value.
-
-
Constructor Details
-
JRBaseValueDisplay
Constructs a copy of an existing value format specification.- Parameters:
valueDisplay
- the value formatting object to copychart
- the parent chart
-
JRBaseValueDisplay
Constructs a copy of an existing value format specification and registers any expression in the new copy with the specified factory.- Parameters:
valueDisplay
- the value formatting object to copyfactory
- the factory object to register expressions with
-
-
Method Details
-
getChart
- Specified by:
getChart
in interfaceJRValueDisplay
-
getColor
Description copied from interface:JRValueDisplay
Returns the color to use when writing the value.- Specified by:
getColor
in interfaceJRValueDisplay
- Returns:
- the color to use when writing the value
-
getMask
Description copied from interface:JRValueDisplay
Returns the formatting mask to use when writing the value. The mask will be specified using the patterns defined injava.text.DecimalFormat
.- Specified by:
getMask
in interfaceJRValueDisplay
- Returns:
- the formatting mask to use when writing the value
-
getFont
Description copied from interface:JRValueDisplay
Returns the font to use when writing the value.- Specified by:
getFont
in interfaceJRValueDisplay
- Returns:
- the font to use when writing the value
-
collectExpressions
Adds all the expression used by this plot with the specified collector. All collected expression that are also registered with a factory will be included with the report is compiled.- Parameters:
collector
- the expression collector to use
-
clone
- Specified by:
clone
in interfaceJRCloneable
- Overrides:
clone
in classObject
-
clone
- Specified by:
clone
in interfaceJRValueDisplay
-