Package org.jfree.chart.plot

Class PiePlot<K extends Comparable<K>>

java.lang.Object

org.jfree.chart.plot.Plot

org.jfree.chart.plot.PiePlot<K>

Type Parameters:

K - Key type for PieDataset

All Implemented Interfaces:

Serializable, Cloneable, EventListener, AnnotationChangeListener, AxisChangeListener, MarkerChangeListener, LegendItemSource, PublicCloneable, DatasetChangeListener

Direct Known Subclasses:

PiePlot3D, RingPlot

public class PiePlot<K extends Comparable<K>>
extends Plot
implements Cloneable, Serializable

A plot that displays data in the form of a pie chart, using data from any class that implements the PieDataset interface. The example shown here is generated by the PieChartDemo2.java program included in the JFreeChart Demo Collection:

Special notes:

1. the default starting point is 12 o'clock and the pie sections proceed in a clockwise direction, but these settings can be changed;
2. negative values in the dataset are ignored;
3. there are utility methods for creating a PieDataset from a CategoryDataset;

See Also:

• Plot
• PieDataset
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_INTERIOR_GAP	The default interior gap.
static final Paint	DEFAULT_LABEL_BACKGROUND_PAINT	The default section label background paint.
static final Font	DEFAULT_LABEL_FONT	The default section label font.
static final Paint	DEFAULT_LABEL_OUTLINE_PAINT	The default section label outline paint.
static final Stroke	DEFAULT_LABEL_OUTLINE_STROKE	The default section label outline stroke.
static final Paint	DEFAULT_LABEL_PAINT	The default section label paint.
static final Paint	DEFAULT_LABEL_SHADOW_PAINT	The default section label shadow paint.
static final double	DEFAULT_MINIMUM_ARC_ANGLE_TO_DRAW	The default minimum arc angle to draw.
static final double	DEFAULT_START_ANGLE	The default starting angle for the pie chart.
protected static ResourceBundle	localizationResources	The resourceBundle for the localization.
static final double	MAX_INTERIOR_GAP	The maximum interior gap (currently 40%).

Fields inherited from class org.jfree.chart.plot.Plot

DEFAULT_BACKGROUND_ALPHA, DEFAULT_BACKGROUND_PAINT, DEFAULT_FOREGROUND_ALPHA, DEFAULT_INSETS, DEFAULT_LEGEND_ITEM_BOX, DEFAULT_LEGEND_ITEM_CIRCLE, DEFAULT_OUTLINE_PAINT, DEFAULT_OUTLINE_STROKE, MINIMUM_HEIGHT_TO_DRAW, MINIMUM_WIDTH_TO_DRAW, ZERO

Constructor Summary

Constructors

Constructor	Description
PiePlot()	Creates a new plot.
PiePlot(PieDataset<K> dataset)	Creates a plot that will draw a pie chart for the specified dataset.

Method Summary

Modifier and Type	Method	Description
void	clearSectionOutlinePaints(boolean notify)	Clears the section outline paint settings for this plot and, if requested, sends a PlotChangeEvent to all registered listeners.
void	clearSectionOutlineStrokes(boolean notify)	Clears the section outline stroke settings for this plot and, if requested, sends a PlotChangeEvent to all registered listeners.
void	clearSectionPaints(boolean notify)	Clears the section paint settings for this plot and, if requested, sends a PlotChangeEvent to all registered listeners.
Object	clone()	Returns a clone of the plot.
void	draw(Graphics2D g2, Rectangle2D area, Point2D anchor, PlotState parentState, PlotRenderingInfo info)	Draws the plot on a Java 2D graphics device (such as the screen or a printer).
protected void	drawItem(Graphics2D g2, int section, Rectangle2D dataArea, PiePlotState state, int currentPass)	Draws a single data item.
protected void	drawLabels(Graphics2D g2, List<K> keys, double totalValue, Rectangle2D plotArea, Rectangle2D linkArea, PiePlotState state)	Draws the labels for the pie sections.
protected void	drawLeftLabel(Graphics2D g2, PiePlotState state, PieLabelRecord record)	Draws a section label on the left side of the pie chart.
protected void	drawLeftLabels(KeyedValues<K> leftKeys, Graphics2D g2, Rectangle2D plotArea, Rectangle2D linkArea, float maxLabelWidth, PiePlotState state)	Draws the left labels.
protected void	drawPie(Graphics2D g2, Rectangle2D plotArea, PlotRenderingInfo info)	Draws the pie.
protected void	drawRightLabel(Graphics2D g2, PiePlotState state, PieLabelRecord record)	Draws a section label on the right side of the pie chart.
protected void	drawRightLabels(KeyedValues<K> keys, Graphics2D g2, Rectangle2D plotArea, Rectangle2D linkArea, float maxLabelWidth, PiePlotState state)	Draws the right labels.
protected void	drawSimpleLabels(Graphics2D g2, List<K> keys, double totalValue, Rectangle2D plotArea, Rectangle2D pieArea, PiePlotState state)	Draws the pie section labels in the simple form.
boolean	equals(Object obj)	Tests this plot for equality with an arbitrary object.
protected Rectangle2D	getArcBounds(Rectangle2D unexploded, Rectangle2D exploded, double angle, double extent, double explodePercent)	Returns a rectangle that can be used to create a pie section (taking into account the amount by which the pie section is 'exploded').
protected Point2D	getArcCenter(PiePlotState state, K key)	Returns the center for the specified section.
boolean	getAutoPopulateSectionOutlinePaint()	Returns the flag that controls whether or not the section outline paint is auto-populated by the lookupSectionOutlinePaint(Comparable) method.
boolean	getAutoPopulateSectionOutlineStroke()	Returns the flag that controls whether or not the section outline stroke is auto-populated by the lookupSectionOutlinePaint(Comparable) method.
boolean	getAutoPopulateSectionPaint()	Returns the flag that controls whether or not the section paint is auto-populated by the lookupSectionPaint(Comparable) method.
PieDataset<K>	getDataset()	Returns the dataset.
Paint	getDefaultSectionOutlinePaint()	Returns the default section paint.
Stroke	getDefaultSectionOutlineStroke()	Returns the default section stroke.
Paint	getDefaultSectionPaint()	Returns the default section paint.
Rotation	getDirection()	Returns the direction in which the pie sections are drawn (clockwise or anti-clockwise).
double	getExplodePercent(K key)	Returns the amount that the section with the specified key should be exploded.
boolean	getIgnoreNullValues()	Returns the flag that controls whether null values in the dataset are ignored.
boolean	getIgnoreZeroValues()	Returns the flag that controls whether zero values in the dataset are ignored.
double	getInteriorGap()	Returns the interior gap, measured as a percentage of the available drawing space.
Paint	getLabelBackgroundPaint()	Returns the section label background paint.
AbstractPieLabelDistributor	getLabelDistributor()	Returns the object responsible for the vertical layout of the pie section labels.
Font	getLabelFont()	Returns the section label font.
double	getLabelGap()	Returns the gap between the edge of the pie and the labels, expressed as a percentage of the plot width.
PieSectionLabelGenerator	getLabelGenerator()	Returns the section label generator.
protected double	getLabelLinkDepth()	Returns the distance that the end of the label link is embedded into the plot, expressed as a percentage of the plot's radius.
double	getLabelLinkMargin()	Returns the margin (expressed as a percentage of the width or height) between the edge of the pie and the link point.
Paint	getLabelLinkPaint()	Returns the paint used for the lines that connect pie sections to their corresponding labels.
Stroke	getLabelLinkStroke()	Returns the stroke used for the label linking lines.
PieLabelLinkStyle	getLabelLinkStyle()	Returns the label link style.
boolean	getLabelLinksVisible()	Returns the flag that controls whether or not label linking lines are visible.
Paint	getLabelOutlinePaint()	Returns the section label outline paint.
Stroke	getLabelOutlineStroke()	Returns the section label outline stroke.
RectangleInsets	getLabelPadding()	Returns the label padding.
Paint	getLabelPaint()	Returns the section label paint.
Paint	getLabelShadowPaint()	Returns the section label shadow paint.
LegendItemCollection	getLegendItems()	Returns a collection of legend items for the pie chart.
Shape	getLegendItemShape()	Returns the shape used for legend items.
PieSectionLabelGenerator	getLegendLabelGenerator()	Returns the legend label generator.
PieSectionLabelGenerator	getLegendLabelToolTipGenerator()	Returns the legend label tool tip generator.
PieURLGenerator	getLegendLabelURLGenerator()	Returns the legend label URL generator.
double	getMaximumExplodePercent()	Returns the maximum explode percent.
double	getMaximumLabelWidth()	Returns the maximum label width as a percentage of the plot width.
double	getMinimumArcAngleToDraw()	Returns the minimum arc angle that will be drawn.
int	getPieIndex()	Returns the pie index (this is used by the MultiplePiePlot class to track subplots).
String	getPlotType()	Returns a short string describing the type of plot.
protected K	getSectionKey(int section)	Returns a key for the specified section.
Paint	getSectionOutlinePaint(Comparable key)	Returns the outline paint associated with the specified key, or null if there is no paint associated with the key.
Stroke	getSectionOutlineStroke(Comparable key)	Returns the outline stroke associated with the specified key, or null if there is no stroke associated with the key.
boolean	getSectionOutlinesVisible()	Returns the flag that controls whether or not the outline is drawn for each pie section.
Paint	getSectionPaint(Comparable key)	Returns the paint associated with the specified key, or null if there is no paint associated with the key.
ShadowGenerator	getShadowGenerator()	Returns the shadow generator for the plot, if any.
Paint	getShadowPaint()	Returns the shadow paint.
double	getShadowXOffset()	Returns the x-offset for the shadow effect.
double	getShadowYOffset()	Returns the y-offset for the shadow effect.
RectangleInsets	getSimpleLabelOffset()	Returns the offset used for the simple labels, if they are displayed.
boolean	getSimpleLabels()	Returns the flag that controls whether simple or extended labels are displayed on the plot.
double	getStartAngle()	Returns the start angle for the first pie section.
PieToolTipGenerator	getToolTipGenerator()	Returns the tool tip generator, an object that is responsible for generating the text items used for tool tips by the plot.
PieURLGenerator	getURLGenerator()	Returns the URL generator.
void	handleMouseWheelRotation(int rotateClicks)	Handles a mouse wheel rotation (this method is intended for use by the MouseWheelHandler class).
int	hashCode()	Generates a hashcode.
PiePlotState	initialise(Graphics2D g2, Rectangle2D plotArea, PiePlot<?> plot, Integer index, PlotRenderingInfo info)	Initialises the drawing procedure.
boolean	isCircular()	Returns a flag indicating whether the pie chart is circular, or stretched into an elliptical shape.
protected Paint	lookupSectionOutlinePaint(Comparable key)	Returns the outline paint for the specified section.
protected Paint	lookupSectionOutlinePaint(Comparable key, boolean autoPopulate)	Returns the outline paint for the specified section.
protected Stroke	lookupSectionOutlineStroke(Comparable key)	Returns the outline stroke for the specified section.
protected Stroke	lookupSectionOutlineStroke(Comparable key, boolean autoPopulate)	Returns the outline stroke for the specified section.
protected Paint	lookupSectionPaint(Comparable key)	Returns the paint for the specified section.
protected Paint	lookupSectionPaint(Comparable key, boolean autoPopulate)	Returns the paint for the specified section.
protected Paint	lookupSectionPaint(K key, PiePlotState state)	Returns the paint for the specified section.
void	setAutoPopulateSectionOutlinePaint(boolean auto)	Sets the flag that controls whether or not the section outline paint is auto-populated by the lookupSectionOutlinePaint(Comparable) method, and sends a PlotChangeEvent to all registered listeners.
void	setAutoPopulateSectionOutlineStroke(boolean auto)	Sets the flag that controls whether or not the section outline stroke is auto-populated by the lookupSectionOutlineStroke(Comparable) method, and sends a PlotChangeEvent to all registered listeners.
void	setAutoPopulateSectionPaint(boolean auto)	Sets the flag that controls whether or not the section paint is auto-populated by the lookupSectionPaint(Comparable) method, and sends a PlotChangeEvent to all registered listeners.
void	setCircular(boolean flag)	A flag indicating whether the pie chart is circular, or stretched into an elliptical shape.
void	setCircular(boolean circular, boolean notify)	Sets the circular attribute and, if requested, sends a PlotChangeEvent to all registered listeners.
void	setDataset(PieDataset<K> dataset)	Sets the dataset and sends a DatasetChangeEvent to 'this'.
void	setDefaultSectionOutlinePaint(Paint paint)	Sets the default section paint.
void	setDefaultSectionOutlineStroke(Stroke stroke)	Sets the default section stroke.
void	setDefaultSectionPaint(Paint paint)	Sets the default section paint and sends a PlotChangeEvent to all registered listeners.
void	setDirection(Rotation direction)	Sets the direction in which the pie sections are drawn and sends a PlotChangeEvent to all registered listeners.
void	setExplodePercent(K key, double percent)	Sets the amount that a pie section should be exploded and sends a PlotChangeEvent to all registered listeners.
void	setIgnoreNullValues(boolean flag)	Sets a flag that controls whether null values are ignored, and sends a PlotChangeEvent to all registered listeners.
void	setIgnoreZeroValues(boolean flag)	Sets a flag that controls whether zero values are ignored, and sends a PlotChangeEvent to all registered listeners.
void	setInteriorGap(double percent)	Sets the interior gap and sends a PlotChangeEvent to all registered listeners.
void	setLabelBackgroundPaint(Paint paint)	Sets the section label background paint and sends a PlotChangeEvent to all registered listeners.
void	setLabelDistributor(AbstractPieLabelDistributor distributor)	Sets the label distributor and sends a PlotChangeEvent to all registered listeners.
void	setLabelFont(Font font)	Sets the section label font and sends a PlotChangeEvent to all registered listeners.
void	setLabelGap(double gap)	Sets the gap between the edge of the pie and the labels (expressed as a percentage of the plot width) and sends a PlotChangeEvent to all registered listeners.
void	setLabelGenerator(PieSectionLabelGenerator generator)	Sets the section label generator and sends a PlotChangeEvent to all registered listeners.
void	setLabelLinkMargin(double margin)	Sets the link margin and sends a PlotChangeEvent to all registered listeners.
void	setLabelLinkPaint(Paint paint)	Sets the paint used for the lines that connect pie sections to their corresponding labels, and sends a PlotChangeEvent to all registered listeners.
void	setLabelLinkStroke(Stroke stroke)	Sets the link stroke and sends a PlotChangeEvent to all registered listeners.
void	setLabelLinkStyle(PieLabelLinkStyle style)	Sets the label link style and sends a PlotChangeEvent to all registered listeners.
void	setLabelLinksVisible(boolean visible)	Sets the flag that controls whether or not label linking lines are visible and sends a PlotChangeEvent to all registered listeners.
void	setLabelOutlinePaint(Paint paint)	Sets the section label outline paint and sends a PlotChangeEvent to all registered listeners.
void	setLabelOutlineStroke(Stroke stroke)	Sets the section label outline stroke and sends a PlotChangeEvent to all registered listeners.
void	setLabelPadding(RectangleInsets padding)	Sets the padding between each label and its outline and sends a PlotChangeEvent to all registered listeners.
void	setLabelPaint(Paint paint)	Sets the section label paint and sends a PlotChangeEvent to all registered listeners.
void	setLabelShadowPaint(Paint paint)	Sets the section label shadow paint and sends a PlotChangeEvent to all registered listeners.
void	setLegendItemShape(Shape shape)	Sets the shape used for legend items and sends a PlotChangeEvent to all registered listeners.
void	setLegendLabelGenerator(PieSectionLabelGenerator generator)	Sets the legend label generator and sends a PlotChangeEvent to all registered listeners.
void	setLegendLabelToolTipGenerator(PieSectionLabelGenerator generator)	Sets the legend label tool tip generator and sends a PlotChangeEvent to all registered listeners.
void	setLegendLabelURLGenerator(PieURLGenerator generator)	Sets the legend label URL generator and sends a PlotChangeEvent to all registered listeners.
void	setMaximumLabelWidth(double width)	Sets the maximum label width as a percentage of the plot width and sends a PlotChangeEvent to all registered listeners.
void	setMinimumArcAngleToDraw(double angle)	Sets the minimum arc angle that will be drawn.
void	setPieIndex(int index)	Sets the pie index (this is used by the MultiplePiePlot class to track subplots).
void	setSectionOutlinePaint(Comparable key, Paint paint)	Sets the outline paint associated with the specified key, and sends a PlotChangeEvent to all registered listeners.
void	setSectionOutlineStroke(Comparable key, Stroke stroke)	Sets the outline stroke associated with the specified key, and sends a PlotChangeEvent to all registered listeners.
void	setSectionOutlinesVisible(boolean visible)	Sets the flag that controls whether or not the outline is drawn for each pie section, and sends a PlotChangeEvent to all registered listeners.
void	setSectionPaint(Comparable key, Paint paint)	Sets the paint associated with the specified key, and sends a PlotChangeEvent to all registered listeners.
void	setShadowGenerator(ShadowGenerator generator)	Sets the shadow generator for the plot and sends a PlotChangeEvent to all registered listeners.
void	setShadowPaint(Paint paint)	Sets the shadow paint and sends a PlotChangeEvent to all registered listeners.
void	setShadowXOffset(double offset)	Sets the x-offset for the shadow effect and sends a PlotChangeEvent to all registered listeners.
void	setShadowYOffset(double offset)	Sets the y-offset for the shadow effect and sends a PlotChangeEvent to all registered listeners.
void	setSimpleLabelOffset(RectangleInsets offset)	Sets the offset for the simple labels and sends a PlotChangeEvent to all registered listeners.
void	setSimpleLabels(boolean simple)	Sets the flag that controls whether simple or extended labels are displayed on the plot, and sends a PlotChangeEvent to all registered listeners.
void	setStartAngle(double angle)	Sets the starting angle and sends a PlotChangeEvent to all registered listeners.
void	setToolTipGenerator(PieToolTipGenerator generator)	Sets the tool tip generator and sends a PlotChangeEvent to all registered listeners.
void	setURLGenerator(PieURLGenerator generator)	Sets the URL generator and sends a PlotChangeEvent to all registered listeners.

Methods inherited from class org.jfree.chart.plot.Plot

addChangeListener, annotationChanged, axisChanged, canEqual, createAndAddEntity, datasetChanged, drawBackground, drawBackgroundImage, drawNoDataMessage, drawOutline, fetchElementHintingFlag, fillBackground, fillBackground, fireChangeEvent, getBackgroundAlpha, getBackgroundImage, getBackgroundImageAlignment, getBackgroundImageAlpha, getBackgroundPaint, getChart, getDatasetGroup, getDrawingSupplier, getForegroundAlpha, getInsets, getNoDataMessage, getNoDataMessageFont, getNoDataMessagePaint, getOutlinePaint, getOutlineStroke, getParent, getRectX, getRectY, getRootPlot, handleClick, isNotify, isOutlineVisible, isSubplot, markerChanged, notifyListeners, removeChangeListener, resolveDomainAxisLocation, resolveRangeAxisLocation, setBackgroundAlpha, setBackgroundImage, setBackgroundImageAlignment, setBackgroundImageAlpha, setBackgroundPaint, setChart, setDatasetGroup, setDrawingSupplier, setDrawingSupplier, setForegroundAlpha, setInsets, setInsets, setNoDataMessage, setNoDataMessageFont, setNoDataMessagePaint, setNotify, setOutlinePaint, setOutlineStroke, setOutlineVisible, setParent, zoom

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_INTERIOR_GAP

public static final double DEFAULT_INTERIOR_GAP

The default interior gap.

See Also:

• Constant Field Values

MAX_INTERIOR_GAP

public static final double MAX_INTERIOR_GAP

The maximum interior gap (currently 40%).

See Also:

• Constant Field Values

DEFAULT_START_ANGLE

public static final double DEFAULT_START_ANGLE

The default starting angle for the pie chart.

See Also:

• Constant Field Values

DEFAULT_LABEL_FONT

public static final Font DEFAULT_LABEL_FONT

The default section label font.

DEFAULT_LABEL_PAINT

public static final Paint DEFAULT_LABEL_PAINT

The default section label paint.

DEFAULT_LABEL_BACKGROUND_PAINT

public static final Paint DEFAULT_LABEL_BACKGROUND_PAINT

The default section label background paint.

DEFAULT_LABEL_OUTLINE_PAINT

public static final Paint DEFAULT_LABEL_OUTLINE_PAINT

The default section label outline paint.

DEFAULT_LABEL_OUTLINE_STROKE

public static final Stroke DEFAULT_LABEL_OUTLINE_STROKE

The default section label outline stroke.

DEFAULT_LABEL_SHADOW_PAINT

public static final Paint DEFAULT_LABEL_SHADOW_PAINT

The default section label shadow paint.

DEFAULT_MINIMUM_ARC_ANGLE_TO_DRAW

public static final double DEFAULT_MINIMUM_ARC_ANGLE_TO_DRAW

The default minimum arc angle to draw.

See Also:

• Constant Field Values

localizationResources

protected static ResourceBundle localizationResources

The resourceBundle for the localization.

Constructor Details

PiePlot

public PiePlot()

Creates a new plot. The dataset is initially set to null.

PiePlot

public PiePlot(PieDataset<K> dataset)

Creates a plot that will draw a pie chart for the specified dataset.

Parameters:

dataset - the dataset (null permitted).

Method Details

getDataset

public PieDataset<K> getDataset()

Returns the dataset.

Returns:

The dataset (possibly null).

See Also:

• setDataset(PieDataset)

setDataset

public void setDataset(PieDataset<K> dataset)

Sets the dataset and sends a DatasetChangeEvent to 'this'.

Parameters:

dataset - the dataset (null permitted).

See Also:

• getDataset()

getPieIndex

public int getPieIndex()

Returns the pie index (this is used by the MultiplePiePlot class to track subplots).

Returns:

The pie index.

See Also:

• setPieIndex(int)

setPieIndex

public void setPieIndex(int index)

Sets the pie index (this is used by the MultiplePiePlot class to track subplots).

Parameters:

index - the index.

See Also:

• getPieIndex()

getStartAngle

public double getStartAngle()

Returns the start angle for the first pie section. This is measured in degrees starting from 3 o'clock and measuring anti-clockwise.

Returns:

The start angle.

See Also:

• setStartAngle(double)

setStartAngle

public void setStartAngle(double angle)

Sets the starting angle and sends a PlotChangeEvent to all registered listeners. The initial default value is 90 degrees, which corresponds to 12 o'clock. A value of zero corresponds to 3 o'clock... this is the encoding used by Java's Arc2D class.

Parameters:

angle - the angle (in degrees).

See Also:

• getStartAngle()

getDirection

public Rotation getDirection()

Returns the direction in which the pie sections are drawn (clockwise or anti-clockwise).

Returns:

The direction (never null).

See Also:

• setDirection(Rotation)

setDirection

public void setDirection(Rotation direction)

Sets the direction in which the pie sections are drawn and sends a PlotChangeEvent to all registered listeners.

Parameters:

direction - the direction (null not permitted).

See Also:

• getDirection()

getInteriorGap

public double getInteriorGap()

Returns the interior gap, measured as a percentage of the available drawing space.

Returns:

The gap (as a percentage of the available drawing space).

See Also:

• setInteriorGap(double)

setInteriorGap

public void setInteriorGap(double percent)

Sets the interior gap and sends a PlotChangeEvent to all registered listeners. This controls the space between the edges of the pie plot and the plot area itself (the region where the section labels appear).

Parameters:

percent - the gap (as a percentage of the available drawing space).

See Also:

• getInteriorGap()

isCircular

public boolean isCircular()

Returns a flag indicating whether the pie chart is circular, or stretched into an elliptical shape.

Returns:

A flag indicating whether the pie chart is circular.

See Also:

• setCircular(boolean)

setCircular

public void setCircular(boolean flag)

A flag indicating whether the pie chart is circular, or stretched into an elliptical shape.

Parameters:

flag - the new value.

See Also:

• isCircular()

setCircular

public void setCircular(boolean circular,
 boolean notify)

Sets the circular attribute and, if requested, sends a PlotChangeEvent to all registered listeners.

Parameters:

circular - the new value of the flag.

notify - notify listeners?

See Also:

• isCircular()

getIgnoreNullValues

public boolean getIgnoreNullValues()

Returns the flag that controls whether null values in the dataset are ignored.

Returns:

A boolean.

See Also:

• setIgnoreNullValues(boolean)

setIgnoreNullValues

public void setIgnoreNullValues(boolean flag)

Sets a flag that controls whether null values are ignored, and sends a PlotChangeEvent to all registered listeners. At present, this only affects whether or not the key is presented in the legend.

Parameters:

flag - the flag.

See Also:

• getIgnoreNullValues()
• setIgnoreZeroValues(boolean)

getIgnoreZeroValues

public boolean getIgnoreZeroValues()

Returns the flag that controls whether zero values in the dataset are ignored.

Returns:

A boolean.

See Also:

• setIgnoreZeroValues(boolean)

setIgnoreZeroValues

public void setIgnoreZeroValues(boolean flag)

Sets a flag that controls whether zero values are ignored, and sends a PlotChangeEvent to all registered listeners. This only affects whether or not a label appears for the non-visible pie section.

Parameters:

flag - the flag.

See Also:

• getIgnoreZeroValues()
• setIgnoreNullValues(boolean)

lookupSectionPaint

protected Paint lookupSectionPaint(Comparable key)

Returns the paint for the specified section. This is equivalent to lookupSectionPaint(section, getAutoPopulateSectionPaint()).

Parameters:

key - the section key.

Returns:

The paint for the specified section.

See Also:

• lookupSectionPaint(Comparable, boolean)

lookupSectionPaint

protected Paint lookupSectionPaint(Comparable key,
 boolean autoPopulate)

Returns the paint for the specified section. The lookup involves these steps:

• if getSectionPaint(Comparable) is non-null return it;
• if getSectionPaint(Comparable) is null but autoPopulate is true, attempt to fetch a new paint from the drawing supplier (Plot.getDrawingSupplier());
• if all else fails, return getDefaultSectionPaint().

Parameters:

key - the section key.

autoPopulate - a flag that controls whether the drawing supplier is used to auto-populate the section paint settings.

Returns:

The paint.

getSectionKey

protected K getSectionKey(int section)

Returns a key for the specified section. The preferred way of doing this now is to link the attributes directly to the section key (there are new methods for this, starting from version 1.0.3).

Parameters:

section - the section index.

Returns:

The key.

getSectionPaint

public Paint getSectionPaint(Comparable key)

Returns the paint associated with the specified key, or null if there is no paint associated with the key.

Parameters:

key - the key (null not permitted).

Returns:

The paint associated with the specified key, or null.

Throws:

IllegalArgumentException - if key is null.

See Also:

• setSectionPaint(Comparable, Paint)

setSectionPaint

public void setSectionPaint(Comparable key,
 Paint paint)

Sets the paint associated with the specified key, and sends a PlotChangeEvent to all registered listeners.

Parameters:

key - the key (null not permitted).

paint - the paint.

Throws:

IllegalArgumentException - if key is null.

See Also:

• getSectionPaint(Comparable)

clearSectionPaints

public void clearSectionPaints(boolean notify)

Clears the section paint settings for this plot and, if requested, sends a PlotChangeEvent to all registered listeners. Be aware that if the autoPopulateSectionPaint flag is set, the section paints may be repopulated using the same colours as before.

Parameters:

notify - notify listeners?

See Also:

• autoPopulateSectionPaint

getDefaultSectionPaint

public Paint getDefaultSectionPaint()

Returns the default section paint. This is used when no other paint is defined, which is rare. The default value is Color.GRAY.

Returns:

The paint (never null).

See Also:

• setDefaultSectionPaint(Paint)

setDefaultSectionPaint

public void setDefaultSectionPaint(Paint paint)

Sets the default section paint and sends a PlotChangeEvent to all registered listeners.

Parameters:

paint - the paint (null not permitted).

See Also:

• getDefaultSectionPaint()

getAutoPopulateSectionPaint

public boolean getAutoPopulateSectionPaint()

Returns the flag that controls whether or not the section paint is auto-populated by the lookupSectionPaint(Comparable) method.

Returns:

A boolean.

setAutoPopulateSectionPaint

public void setAutoPopulateSectionPaint(boolean auto)

Sets the flag that controls whether or not the section paint is auto-populated by the lookupSectionPaint(Comparable) method, and sends a PlotChangeEvent to all registered listeners.

Parameters:

auto - auto-populate?

getSectionOutlinesVisible

public boolean getSectionOutlinesVisible()

Returns the flag that controls whether or not the outline is drawn for each pie section.

Returns:

The flag that controls whether or not the outline is drawn for each pie section.

See Also:

• setSectionOutlinesVisible(boolean)

setSectionOutlinesVisible

public void setSectionOutlinesVisible(boolean visible)

Sets the flag that controls whether or not the outline is drawn for each pie section, and sends a PlotChangeEvent to all registered listeners.

Parameters:

visible - the flag.

See Also:

• getSectionOutlinesVisible()

lookupSectionOutlinePaint

protected Paint lookupSectionOutlinePaint(Comparable key)

Returns the outline paint for the specified section. This is equivalent to lookupSectionPaint(section, getAutoPopulateSectionOutlinePaint()).

Parameters:

key - the section key.

Returns:

The paint for the specified section.

See Also:

• lookupSectionOutlinePaint(Comparable, boolean)

lookupSectionOutlinePaint

protected Paint lookupSectionOutlinePaint(Comparable key,
 boolean autoPopulate)

Returns the outline paint for the specified section. The lookup involves these steps:

• if getSectionOutlinePaint(Comparable) is non-null return it;
• if getSectionOutlinePaint(Comparable) is null but autoPopulate is true, attempt to fetch a new outline paint from the drawing supplier (Plot.getDrawingSupplier());
• if all else fails, return getDefaultSectionOutlinePaint().

Parameters:

key - the section key.

autoPopulate - a flag that controls whether the drawing supplier is used to auto-populate the section outline paint settings.

Returns:

The paint.

getSectionOutlinePaint

public Paint getSectionOutlinePaint(Comparable key)

Returns the outline paint associated with the specified key, or null if there is no paint associated with the key.

Parameters:

key - the key (null not permitted).

Returns:

The paint associated with the specified key, or null.

Throws:

IllegalArgumentException - if key is null.

See Also:

• setSectionOutlinePaint(Comparable, Paint)

setSectionOutlinePaint

public void setSectionOutlinePaint(Comparable key,
 Paint paint)

Sets the outline paint associated with the specified key, and sends a PlotChangeEvent to all registered listeners.

Parameters:

key - the key (null not permitted).

paint - the paint.

Throws:

IllegalArgumentException - if key is null.

See Also:

• getSectionOutlinePaint(Comparable)

clearSectionOutlinePaints

public void clearSectionOutlinePaints(boolean notify)

Clears the section outline paint settings for this plot and, if requested, sends a PlotChangeEvent to all registered listeners. Be aware that if the autoPopulateSectionPaint flag is set, the section paints may be repopulated using the same colours as before.

Parameters:

notify - notify listeners?

See Also:

• autoPopulateSectionOutlinePaint

getDefaultSectionOutlinePaint

public Paint getDefaultSectionOutlinePaint()

Returns the default section paint. This is used when no other paint is available.

Returns:

The paint (never null).

See Also:

• setDefaultSectionOutlinePaint(Paint)

setDefaultSectionOutlinePaint

public void setDefaultSectionOutlinePaint(Paint paint)

Sets the default section paint.

Parameters:

paint - the paint (null not permitted).

See Also:

• getDefaultSectionOutlinePaint()

getAutoPopulateSectionOutlinePaint

public boolean getAutoPopulateSectionOutlinePaint()

Returns the flag that controls whether or not the section outline paint is auto-populated by the lookupSectionOutlinePaint(Comparable) method.

Returns:

A boolean.

setAutoPopulateSectionOutlinePaint

public void setAutoPopulateSectionOutlinePaint(boolean auto)

Sets the flag that controls whether or not the section outline paint is auto-populated by the lookupSectionOutlinePaint(Comparable) method, and sends a PlotChangeEvent to all registered listeners.

Parameters:

auto - auto-populate?

lookupSectionOutlineStroke

protected Stroke lookupSectionOutlineStroke(Comparable key)

Returns the outline stroke for the specified section. This is equivalent to lookupSectionOutlineStroke(section, getAutoPopulateSectionOutlineStroke()).

Parameters:

key - the section key.

Returns:

The stroke for the specified section.

See Also:

• lookupSectionOutlineStroke(Comparable, boolean)

lookupSectionOutlineStroke

protected Stroke lookupSectionOutlineStroke(Comparable key,
 boolean autoPopulate)

Returns the outline stroke for the specified section. The lookup involves these steps:

• if getSectionOutlineStroke(Comparable) is non-null return it;
• if getSectionOutlineStroke(Comparable) is null but autoPopulate is true, attempt to fetch a new outline stroke from the drawing supplier (Plot.getDrawingSupplier());
• if all else fails, return getDefaultSectionOutlineStroke().

Parameters:

key - the section key.

autoPopulate - a flag that controls whether the drawing supplier is used to auto-populate the section outline stroke settings.

Returns:

The stroke.

getSectionOutlineStroke

public Stroke getSectionOutlineStroke(Comparable key)

Returns the outline stroke associated with the specified key, or null if there is no stroke associated with the key.

Parameters:

key - the key (null not permitted).

Returns:

The stroke associated with the specified key, or null.

Throws:

IllegalArgumentException - if key is null.

See Also:

• setSectionOutlineStroke(Comparable, Stroke)

setSectionOutlineStroke

public void setSectionOutlineStroke(Comparable key,
 Stroke stroke)

Sets the outline stroke associated with the specified key, and sends a PlotChangeEvent to all registered listeners.

Parameters:

key - the key (null not permitted).

stroke - the stroke.

Throws:

IllegalArgumentException - if key is null.

See Also:

• getSectionOutlineStroke(Comparable)

clearSectionOutlineStrokes

public void clearSectionOutlineStrokes(boolean notify)

Clears the section outline stroke settings for this plot and, if requested, sends a PlotChangeEvent to all registered listeners. Be aware that if the autoPopulateSectionPaint flag is set, the section paints may be repopulated using the same colours as before.

Parameters:

notify - notify listeners?

See Also:

• autoPopulateSectionOutlineStroke

getDefaultSectionOutlineStroke

public Stroke getDefaultSectionOutlineStroke()

Returns the default section stroke. This is used when no other stroke is available.

Returns:

The stroke (never null).

See Also:

• setDefaultSectionOutlineStroke(Stroke)

setDefaultSectionOutlineStroke

public void setDefaultSectionOutlineStroke(Stroke stroke)

Sets the default section stroke.

Parameters:

stroke - the stroke (null not permitted).

See Also:

• getDefaultSectionOutlineStroke()

getAutoPopulateSectionOutlineStroke

public boolean getAutoPopulateSectionOutlineStroke()

Returns the flag that controls whether or not the section outline stroke is auto-populated by the lookupSectionOutlinePaint(Comparable) method.

Returns:

A boolean.

setAutoPopulateSectionOutlineStroke

public void setAutoPopulateSectionOutlineStroke(boolean auto)

Sets the flag that controls whether or not the section outline stroke is auto-populated by the lookupSectionOutlineStroke(Comparable) method, and sends a PlotChangeEvent to all registered listeners.

Parameters:

auto - auto-populate?

getShadowPaint

public Paint getShadowPaint()

Returns the shadow paint.

Returns:

The paint (possibly null).

See Also:

• setShadowPaint(Paint)

setShadowPaint

public void setShadowPaint(Paint paint)

Sets the shadow paint and sends a PlotChangeEvent to all registered listeners.

Parameters:

paint - the paint (null permitted).

See Also:

• getShadowPaint()

getShadowXOffset

public double getShadowXOffset()

Returns the x-offset for the shadow effect.

Returns:

The offset (in Java2D units).

See Also:

• setShadowXOffset(double)

setShadowXOffset

public void setShadowXOffset(double offset)

Sets the x-offset for the shadow effect and sends a PlotChangeEvent to all registered listeners.

Parameters:

offset - the offset (in Java2D units).

See Also:

• getShadowXOffset()

getShadowYOffset

public double getShadowYOffset()

Returns the y-offset for the shadow effect.

Returns:

The offset (in Java2D units).

See Also:

• setShadowYOffset(double)

setShadowYOffset

public void setShadowYOffset(double offset)

Sets the y-offset for the shadow effect and sends a PlotChangeEvent to all registered listeners.

Parameters:

offset - the offset (in Java2D units).

See Also:

• getShadowYOffset()

getExplodePercent

public double getExplodePercent(K key)

Returns the amount that the section with the specified key should be exploded.

Parameters:

key - the key (null not permitted).

Returns:

The amount that the section with the specified key should be exploded.

Throws:

IllegalArgumentException - if key is null.

See Also:

• setExplodePercent(Comparable, double)

setExplodePercent

public void setExplodePercent(K key,
 double percent)

Sets the amount that a pie section should be exploded and sends a PlotChangeEvent to all registered listeners.

Parameters:

key - the section key (null not permitted).

percent - the explode percentage (0.30 = 30 percent).

See Also:

• getExplodePercent(Comparable)

getMaximumExplodePercent

public double getMaximumExplodePercent()

Returns the maximum explode percent.

Returns:

The percent.

getLabelGenerator

public PieSectionLabelGenerator getLabelGenerator()

Returns the section label generator.

Returns:

The generator (possibly null).

See Also:

• setLabelGenerator(PieSectionLabelGenerator)

setLabelGenerator

public void setLabelGenerator(PieSectionLabelGenerator generator)

Sets the section label generator and sends a PlotChangeEvent to all registered listeners.

Parameters:

generator - the generator (null permitted).

See Also:

• getLabelGenerator()

getLabelGap

public double getLabelGap()

Returns the gap between the edge of the pie and the labels, expressed as a percentage of the plot width.

Returns:

The gap (a percentage, where 0.05 = five percent).

See Also:

• setLabelGap(double)

setLabelGap

public void setLabelGap(double gap)

Sets the gap between the edge of the pie and the labels (expressed as a percentage of the plot width) and sends a PlotChangeEvent to all registered listeners.

Parameters:

gap - the gap (a percentage, where 0.05 = five percent).

See Also:

• getLabelGap()

getMaximumLabelWidth

public double getMaximumLabelWidth()

Returns the maximum label width as a percentage of the plot width.

Returns:

The width (a percentage, where 0.20 = 20 percent).

See Also:

• setMaximumLabelWidth(double)

setMaximumLabelWidth

public void setMaximumLabelWidth(double width)

Sets the maximum label width as a percentage of the plot width and sends a PlotChangeEvent to all registered listeners.

Parameters:

width - the width (a percentage, where 0.20 = 20 percent).

See Also:

• getMaximumLabelWidth()

getLabelLinksVisible

public boolean getLabelLinksVisible()

Returns the flag that controls whether or not label linking lines are visible.

Returns:

A boolean.

See Also:

• setLabelLinksVisible(boolean)

setLabelLinksVisible

public void setLabelLinksVisible(boolean visible)

Sets the flag that controls whether or not label linking lines are visible and sends a PlotChangeEvent to all registered listeners. Please take care when hiding the linking lines - depending on the data values, the labels can be displayed some distance away from the corresponding pie section.

Parameters:

visible - the flag.

See Also:

• getLabelLinksVisible()

getLabelLinkStyle

public PieLabelLinkStyle getLabelLinkStyle()

Returns the label link style.

Returns:

The label link style (never null).

See Also:

• setLabelLinkStyle(PieLabelLinkStyle)

setLabelLinkStyle

public void setLabelLinkStyle(PieLabelLinkStyle style)

Sets the label link style and sends a PlotChangeEvent to all registered listeners.

Parameters:

style - the new style (null not permitted).

See Also:

• getLabelLinkStyle()

getLabelLinkMargin

public double getLabelLinkMargin()

Returns the margin (expressed as a percentage of the width or height) between the edge of the pie and the link point.

Returns:

The link margin (as a percentage, where 0.05 is five percent).

See Also:

• setLabelLinkMargin(double)

setLabelLinkMargin

public void setLabelLinkMargin(double margin)

Sets the link margin and sends a PlotChangeEvent to all registered listeners.

Parameters:

margin - the margin.

See Also:

• getLabelLinkMargin()

getLabelLinkPaint

public Paint getLabelLinkPaint()

Returns the paint used for the lines that connect pie sections to their corresponding labels.

Returns:

The paint (never null).

See Also:

• setLabelLinkPaint(Paint)

setLabelLinkPaint

public void setLabelLinkPaint(Paint paint)

Sets the paint used for the lines that connect pie sections to their corresponding labels, and sends a PlotChangeEvent to all registered listeners.

Parameters:

paint - the paint (null not permitted).

See Also:

• getLabelLinkPaint()

getLabelLinkStroke

public Stroke getLabelLinkStroke()

Returns the stroke used for the label linking lines.

Returns:

The stroke.

See Also:

• setLabelLinkStroke(Stroke)

setLabelLinkStroke

public void setLabelLinkStroke(Stroke stroke)

Sets the link stroke and sends a PlotChangeEvent to all registered listeners.

Parameters:

stroke - the stroke.

See Also:

• getLabelLinkStroke()

getLabelLinkDepth

protected double getLabelLinkDepth()

Returns the distance that the end of the label link is embedded into the plot, expressed as a percentage of the plot's radius.

This method is overridden in the RingPlot class to resolve bug 2121818.

Returns:

0.10.

getLabelFont

public Font getLabelFont()

Returns the section label font.

Returns:

The font (never null).

See Also:

• setLabelFont(Font)

setLabelFont

public void setLabelFont(Font font)

Sets the section label font and sends a PlotChangeEvent to all registered listeners.

Parameters:

font - the font (null not permitted).

See Also:

• getLabelFont()

getLabelPaint

public Paint getLabelPaint()

Returns the section label paint.

Returns:

The paint (never null).

See Also:

• setLabelPaint(Paint)

setLabelPaint

public void setLabelPaint(Paint paint)

Sets the section label paint and sends a PlotChangeEvent to all registered listeners.

Parameters:

paint - the paint (null not permitted).

See Also:

• getLabelPaint()

getLabelBackgroundPaint

public Paint getLabelBackgroundPaint()

Returns the section label background paint.

Returns:

The paint (possibly null).

See Also:

• setLabelBackgroundPaint(Paint)

setLabelBackgroundPaint

public void setLabelBackgroundPaint(Paint paint)

Sets the section label background paint and sends a PlotChangeEvent to all registered listeners.

Parameters:

paint - the paint (null permitted).

See Also:

• getLabelBackgroundPaint()

getLabelOutlinePaint

public Paint getLabelOutlinePaint()

Returns the section label outline paint.

Returns:

The paint (possibly null).

See Also:

• setLabelOutlinePaint(Paint)

setLabelOutlinePaint

public void setLabelOutlinePaint(Paint paint)

Sets the section label outline paint and sends a PlotChangeEvent to all registered listeners.

Parameters:

paint - the paint (null permitted).

See Also:

• getLabelOutlinePaint()

getLabelOutlineStroke

public Stroke getLabelOutlineStroke()

Returns the section label outline stroke.

Returns:

The stroke (possibly null).

See Also:

• setLabelOutlineStroke(Stroke)

setLabelOutlineStroke

public void setLabelOutlineStroke(Stroke stroke)

Sets the section label outline stroke and sends a PlotChangeEvent to all registered listeners.

Parameters:

stroke - the stroke (null permitted).

See Also:

• getLabelOutlineStroke()

getLabelShadowPaint

public Paint getLabelShadowPaint()

Returns the section label shadow paint.

Returns:

The paint (possibly null).

See Also:

• setLabelShadowPaint(Paint)

setLabelShadowPaint

public void setLabelShadowPaint(Paint paint)

Sets the section label shadow paint and sends a PlotChangeEvent to all registered listeners.

Parameters:

paint - the paint (null permitted).

See Also:

• getLabelShadowPaint()

getLabelPadding

public RectangleInsets getLabelPadding()

Returns the label padding.

Returns:

The label padding (never null).

See Also:

• setLabelPadding(RectangleInsets)

setLabelPadding

public void setLabelPadding(RectangleInsets padding)

Sets the padding between each label and its outline and sends a PlotChangeEvent to all registered listeners.

Parameters:

padding - the padding (null not permitted).

See Also:

• getLabelPadding()

getSimpleLabels

public boolean getSimpleLabels()

Returns the flag that controls whether simple or extended labels are displayed on the plot.

Returns:

A boolean.

setSimpleLabels

public void setSimpleLabels(boolean simple)

Sets the flag that controls whether simple or extended labels are displayed on the plot, and sends a PlotChangeEvent to all registered listeners.

Parameters:

simple - the new flag value.

getSimpleLabelOffset

public RectangleInsets getSimpleLabelOffset()

Returns the offset used for the simple labels, if they are displayed.

Returns:

The offset (never null).

See Also:

• setSimpleLabelOffset(RectangleInsets)

setSimpleLabelOffset

public void setSimpleLabelOffset(RectangleInsets offset)

Sets the offset for the simple labels and sends a PlotChangeEvent to all registered listeners.

Parameters:

offset - the offset (null not permitted).

See Also:

• getSimpleLabelOffset()

getLabelDistributor

public AbstractPieLabelDistributor getLabelDistributor()

Returns the object responsible for the vertical layout of the pie section labels.

Returns:

The label distributor (never null).

setLabelDistributor

public void setLabelDistributor(AbstractPieLabelDistributor distributor)

Sets the label distributor and sends a PlotChangeEvent to all registered listeners.

Parameters:

distributor - the distributor (null not permitted).

getToolTipGenerator

public PieToolTipGenerator getToolTipGenerator()

Returns the tool tip generator, an object that is responsible for generating the text items used for tool tips by the plot. If the generator is null, no tool tips will be created.

Returns:

The generator (possibly null).

See Also:

• setToolTipGenerator(PieToolTipGenerator)

setToolTipGenerator

public void setToolTipGenerator(PieToolTipGenerator generator)

Sets the tool tip generator and sends a PlotChangeEvent to all registered listeners. Set the generator to null if you don't want any tool tips.

Parameters:

generator - the generator (null permitted).

See Also:

• getToolTipGenerator()

getURLGenerator

public PieURLGenerator getURLGenerator()

Returns the URL generator.

Returns:

The generator (possibly null).

See Also:

• setURLGenerator(PieURLGenerator)

setURLGenerator

public void setURLGenerator(PieURLGenerator generator)

Sets the URL generator and sends a PlotChangeEvent to all registered listeners.

Parameters:

generator - the generator (null permitted).

See Also:

• getURLGenerator()

getMinimumArcAngleToDraw

public double getMinimumArcAngleToDraw()

Returns the minimum arc angle that will be drawn. Pie sections for an angle smaller than this are not drawn, to avoid a JDK bug.

Returns:

The minimum angle.

See Also:

• setMinimumArcAngleToDraw(double)

setMinimumArcAngleToDraw

public void setMinimumArcAngleToDraw(double angle)

Sets the minimum arc angle that will be drawn. Pie sections for an angle smaller than this are not drawn, to avoid a JDK bug. See this link for details:

http://www.jfree.org/phpBB2/viewtopic.php?t=2707

...and this bug report in the Java Bug Parade:

http://developer.java.sun.com/developer/bugParade/bugs/4836495.html

Parameters:

angle - the minimum angle.

See Also:

• getMinimumArcAngleToDraw()

getLegendItemShape

public Shape getLegendItemShape()

Returns the shape used for legend items.

Returns:

The shape (never null).

See Also:

• setLegendItemShape(Shape)

setLegendItemShape

public void setLegendItemShape(Shape shape)

Sets the shape used for legend items and sends a PlotChangeEvent to all registered listeners.

Parameters:

shape - the shape (null not permitted).

See Also:

• getLegendItemShape()

getLegendLabelGenerator

public PieSectionLabelGenerator getLegendLabelGenerator()

Returns the legend label generator.

Returns:

The legend label generator (never null).

See Also:

• setLegendLabelGenerator(PieSectionLabelGenerator)

setLegendLabelGenerator

public void setLegendLabelGenerator(PieSectionLabelGenerator generator)

Sets the legend label generator and sends a PlotChangeEvent to all registered listeners.

Parameters:

generator - the generator (null not permitted).

See Also:

• getLegendLabelGenerator()

getLegendLabelToolTipGenerator

public PieSectionLabelGenerator getLegendLabelToolTipGenerator()

Returns the legend label tool tip generator.

Returns:

The legend label tool tip generator (possibly null).

See Also:

• setLegendLabelToolTipGenerator(PieSectionLabelGenerator)

setLegendLabelToolTipGenerator

public void setLegendLabelToolTipGenerator(PieSectionLabelGenerator generator)

Sets the legend label tool tip generator and sends a PlotChangeEvent to all registered listeners.

Parameters:

generator - the generator (null permitted).

See Also:

• getLegendLabelToolTipGenerator()

getLegendLabelURLGenerator

public PieURLGenerator getLegendLabelURLGenerator()

Returns the legend label URL generator.

Returns:

The legend label URL generator (possibly null).

See Also:

• setLegendLabelURLGenerator(PieURLGenerator)

setLegendLabelURLGenerator

public void setLegendLabelURLGenerator(PieURLGenerator generator)

Sets the legend label URL generator and sends a PlotChangeEvent to all registered listeners.

Parameters:

generator - the generator (null permitted).

See Also:

• getLegendLabelURLGenerator()

getShadowGenerator

public ShadowGenerator getShadowGenerator()

Returns the shadow generator for the plot, if any.

Returns:

The shadow generator (possibly null).

setShadowGenerator

public void setShadowGenerator(ShadowGenerator generator)

Sets the shadow generator for the plot and sends a PlotChangeEvent to all registered listeners. Note that this is a bitmap drop-shadow generation facility and is separate from the vector based show option that is controlled via the setShadowPaint(java.awt.Paint) method.

Parameters:

generator - the generator (null permitted).

handleMouseWheelRotation

public void handleMouseWheelRotation(int rotateClicks)

Handles a mouse wheel rotation (this method is intended for use by the MouseWheelHandler class).

Parameters:

rotateClicks - the number of rotate clicks on the the mouse wheel.

initialise

public PiePlotState initialise(Graphics2D g2,
 Rectangle2D plotArea,
 PiePlot<?> plot,
 Integer index,
 PlotRenderingInfo info)

Initialises the drawing procedure. This method will be called before the first item is rendered, giving the plot an opportunity to initialise any state information it wants to maintain.

Parameters:

g2 - the graphics device.

plotArea - the plot area (null not permitted).

plot - the plot.

index - the secondary index (null for primary renderer).

info - collects chart rendering information for return to caller.

Returns:

A state object (maintains state information relevant to one chart drawing).

draw

public void draw(Graphics2D g2,
 Rectangle2D area,
 Point2D anchor,
 PlotState parentState,
 PlotRenderingInfo info)

Draws the plot on a Java 2D graphics device (such as the screen or a printer).

Specified by:

draw in class Plot

Parameters:

g2 - the graphics device.

area - the area within which the plot should be drawn.

anchor - the anchor point (null permitted).

parentState - the state from the parent plot, if there is one.

info - collects info about the drawing (null permitted).

drawPie

protected void drawPie(Graphics2D g2,
 Rectangle2D plotArea,
 PlotRenderingInfo info)

Draws the pie.

Parameters:

g2 - the graphics device.

plotArea - the plot area.

info - chart rendering info.

drawItem

protected void drawItem(Graphics2D g2,
 int section,
 Rectangle2D dataArea,
 PiePlotState state,
 int currentPass)

Draws a single data item.

Parameters:

g2 - the graphics device (null not permitted).

section - the section index.

dataArea - the data plot area.

state - state information for one chart.

currentPass - the current pass index.

drawSimpleLabels

protected void drawSimpleLabels(Graphics2D g2,
 List<K> keys,
 double totalValue,
 Rectangle2D plotArea,
 Rectangle2D pieArea,
 PiePlotState state)

Draws the pie section labels in the simple form.

Parameters:

g2 - the graphics device.

keys - the section keys.

totalValue - the total value for all sections in the pie.

plotArea - the plot area.

pieArea - the area containing the pie.

state - the plot state.

drawLabels

protected void drawLabels(Graphics2D g2,
 List<K> keys,
 double totalValue,
 Rectangle2D plotArea,
 Rectangle2D linkArea,
 PiePlotState state)

Draws the labels for the pie sections.

Parameters:

g2 - the graphics device.

keys - the keys.

totalValue - the total value.

plotArea - the plot area.

linkArea - the link area.

state - the state.

drawLeftLabels

protected void drawLeftLabels(KeyedValues<K> leftKeys,
 Graphics2D g2,
 Rectangle2D plotArea,
 Rectangle2D linkArea,
 float maxLabelWidth,
 PiePlotState state)

Draws the left labels.

Parameters:

leftKeys - a collection of keys and angles (to the middle of the section, in degrees) for the sections on the left side of the plot.

g2 - the graphics device.

plotArea - the plot area.

linkArea - the link area.

maxLabelWidth - the maximum label width.

state - the state.

drawRightLabels

protected void drawRightLabels(KeyedValues<K> keys,
 Graphics2D g2,
 Rectangle2D plotArea,
 Rectangle2D linkArea,
 float maxLabelWidth,
 PiePlotState state)

Draws the right labels.

Parameters:

keys - the keys.

g2 - the graphics device.

plotArea - the plot area.

linkArea - the link area.

maxLabelWidth - the maximum label width.

state - the state.

getLegendItems

public LegendItemCollection getLegendItems()

Returns a collection of legend items for the pie chart.

Specified by:

getLegendItems in interface LegendItemSource

Overrides:

getLegendItems in class Plot

Returns:

The legend items (never null).

getPlotType

public String getPlotType()

Returns a short string describing the type of plot.

Specified by:

getPlotType in class Plot

Returns:

The plot type.

getArcBounds

protected Rectangle2D getArcBounds(Rectangle2D unexploded,
 Rectangle2D exploded,
 double angle,
 double extent,
 double explodePercent)

Returns a rectangle that can be used to create a pie section (taking into account the amount by which the pie section is 'exploded').

Parameters:

unexploded - the area inside which the unexploded pie sections are drawn.

exploded - the area inside which the exploded pie sections are drawn.

angle - the start angle.

extent - the extent of the arc.

explodePercent - the amount by which the pie section is exploded.

Returns:

A rectangle that can be used to create a pie section.

drawLeftLabel

protected void drawLeftLabel(Graphics2D g2,
 PiePlotState state,
 PieLabelRecord record)

Draws a section label on the left side of the pie chart.

Parameters:

g2 - the graphics device.

state - the state.

record - the label record.

drawRightLabel

protected void drawRightLabel(Graphics2D g2,
 PiePlotState state,
 PieLabelRecord record)

Draws a section label on the right side of the pie chart.

Parameters:

g2 - the graphics device.

state - the state.

record - the label record.

getArcCenter

protected Point2D getArcCenter(PiePlotState state,
 K key)

Returns the center for the specified section. Checks to see if the section is exploded and recalculates the new center if so.

Parameters:

state - PiePlotState

key - section key.

Returns:

The center for the specified section.

lookupSectionPaint

protected Paint lookupSectionPaint(K key,
 PiePlotState state)

Returns the paint for the specified section. This is equivalent to lookupSectionPaint(section). Checks to see if the user set the Paint to be of type RadialGradientPaint and if so it adjusts the center and radius to match the Pie.

Parameters:

key - the section key.

state - PiePlotState.

Returns:

The paint for the specified section.

equals

public boolean equals(Object obj)

Tests this plot for equality with an arbitrary object. Note that the plot's dataset is NOT included in the test for equality.

Overrides:

equals in class Plot

Parameters:

obj - the object to test against (null permitted).

Returns:

true or false.

hashCode

public int hashCode()

Generates a hashcode. Note that, as with the equals method, the dataset is NOT included in the hashcode.

Overrides:

hashCode in class Plot

Returns:

the hashcode

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone of the plot.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class Plot

Returns:

A clone.

Throws:

CloneNotSupportedException - if some component of the plot does not support cloning.