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 SummaryFields
- 
Constructor SummaryConstructorsConstructorDescriptionJRBaseValueDisplay(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 SummaryModifier and TypeMethodDescriptionclone()voidcollectExpressions(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
- 
colorThe color to use when writing the value.
- 
maskThe formatting mask to use when writing the value. Must a pattern that is accepted by ajava.text.DecimalFormatobject.
- 
fontThe font to use when writing the value.
 
- 
- 
Constructor Details- 
JRBaseValueDisplayConstructs a copy of an existing value format specification.- Parameters:
- valueDisplay- the value formatting object to copy
- chart- the parent chart
 
- 
JRBaseValueDisplayConstructs 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 copy
- factory- the factory object to register expressions with
 
 
- 
- 
Method Details- 
getChart- Specified by:
- getChartin interface- JRValueDisplay
 
- 
getColorDescription copied from interface:JRValueDisplayReturns the color to use when writing the value.- Specified by:
- getColorin interface- JRValueDisplay
- Returns:
- the color to use when writing the value
 
- 
getMaskDescription copied from interface:JRValueDisplayReturns the formatting mask to use when writing the value. The mask will be specified using the patterns defined injava.text.DecimalFormat.- Specified by:
- getMaskin interface- JRValueDisplay
- Returns:
- the formatting mask to use when writing the value
 
- 
getFontDescription copied from interface:JRValueDisplayReturns the font to use when writing the value.- Specified by:
- getFontin interface- JRValueDisplay
- Returns:
- the font to use when writing the value
 
- 
collectExpressionsAdds 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:
- clonein interface- JRCloneable
- Overrides:
- clonein class- Object
 
- 
clone- Specified by:
- clonein interface- JRValueDisplay
 
 
-