org.jfree.chart
Class ClipPath

java.lang.Object
  |
  +--org.jfree.chart.ClipPath

public class ClipPath

extends java.lang.Object

This class would typically be used with the ContourPlot type. It allows the user to define a GeneralPath curve in plot coordinates. This curve can then be used mask off or define regions within the contour plot. The data must be sorted.

Author:

dmo

Constructor Summary

ClipPath()
Constructor for ClipPath.

ClipPath(double[] xValue, double[] yValue)
Constructor for ClipPath.

ClipPath(double[] xValue, double[] yValue, boolean clip, boolean fillPath, boolean drawPath)
Constructor for ClipPath.

ClipPath(double[] xValue, double[] yValue, boolean fillPath, boolean drawPath, java.awt.Paint fillPaint, java.awt.Paint drawPaint, java.awt.Stroke drawStroke, java.awt.Composite composite)
Constructor for ClipPath.

Method Summary

java.awt.geom.GeneralPath	draw(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D dataArea, ValueAxis horizontalAxis, ValueAxis verticalAxis) Draws the clip path.
java.awt.geom.GeneralPath	generateClipPath(java.awt.geom.Rectangle2D dataArea, ValueAxis horizontalAxis, ValueAxis verticalAxis) Generates the clip path.
java.awt.Composite	getComposite() Returns the composite.
java.awt.Paint	getDrawPaint() Returns the drawPaint.
java.awt.Stroke	getDrawStroke() Returns the drawStroke.
java.awt.Paint	getFillPaint() Returns the fillPaint.
double[]	getXValue() Returns the xValue.
double[]	getYValue() Returns the yValue.
boolean	isClip() Returns the clip.
boolean	isDrawPath() Returns the drawPath.
boolean	isFillPath() Returns the fillPath.
void	setClip(boolean clip) Sets the clip.
void	setComposite(java.awt.Composite composite) Sets the composite.
void	setDrawPaint(java.awt.Paint drawPaint) Sets the drawPaint.
void	setDrawPath(boolean drawPath) Sets the drawPath.
void	setDrawStroke(java.awt.Stroke drawStroke) Sets the drawStroke.
void	setFillPaint(java.awt.Paint fillPaint) Sets the fillPaint.
void	setFillPath(boolean fillPath) Sets the fillPath.
void	setXValue(double[] xValue) Sets the xValue.
void	setYValue(double[] yValue) Sets the yValue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClipPath

public ClipPath()

Constructor for ClipPath.

ClipPath

public ClipPath(double[] xValue,
                double[] yValue)

Constructor for ClipPath. Default values are assumed for the fillPath and drawPath options as false and true respectively. The fillPaint is set to Color.GRAY, the drawColor is Color.BLUE, the stroke is BasicStroke(1) and the composite is AlphaComposite.Src.

ClipPath

public ClipPath(double[] xValue,
                double[] yValue,
                boolean clip,
                boolean fillPath,
                boolean drawPath)

Constructor for ClipPath. The fillPaint is set to Color.GRAY, the drawColor is Color.BLUE, the stroke is BasicStroke(1) and the composite is AlphaComposite.Src.

ClipPath

public ClipPath(double[] xValue,
                double[] yValue,
                boolean fillPath,
                boolean drawPath,
                java.awt.Paint fillPaint,
                java.awt.Paint drawPaint,
                java.awt.Stroke drawStroke,
                java.awt.Composite composite)

Constructor for ClipPath.

Method Detail

draw

public java.awt.geom.GeneralPath draw(java.awt.Graphics2D g2,
                                      java.awt.geom.Rectangle2D dataArea,
                                      ValueAxis horizontalAxis,
                                      ValueAxis verticalAxis)

Draws the clip path.

Returns:

the GeneralPath defining the outline

generateClipPath

public java.awt.geom.GeneralPath generateClipPath(java.awt.geom.Rectangle2D dataArea,
                                                  ValueAxis horizontalAxis,
                                                  ValueAxis verticalAxis)

Generates the clip path.

Returns:

the GeneralPath defining the outline

getComposite

public java.awt.Composite getComposite()

Returns the composite.

Returns:

Composite

getDrawPaint

public java.awt.Paint getDrawPaint()

Returns the drawPaint.

Returns:

Paint

isDrawPath

public boolean isDrawPath()

Returns the drawPath.

Returns:

boolean

getDrawStroke

public java.awt.Stroke getDrawStroke()

Returns the drawStroke.

Returns:

Stroke

getFillPaint

public java.awt.Paint getFillPaint()

Returns the fillPaint.

Returns:

Paint

isFillPath

public boolean isFillPath()

Returns the fillPath.

Returns:

boolean

getXValue

public double[] getXValue()

Returns the xValue.

Returns:

double[]

getYValue

public double[] getYValue()

Returns the yValue.

Returns:

double[]

setComposite

public void setComposite(java.awt.Composite composite)

Sets the composite.

Parameters:

composite - The composite to set

setDrawPaint

public void setDrawPaint(java.awt.Paint drawPaint)

Sets the drawPaint.

Parameters:

drawPaint - The drawPaint to set

setDrawPath

public void setDrawPath(boolean drawPath)

Sets the drawPath.

Parameters:

drawPath - The drawPath to set

setDrawStroke

public void setDrawStroke(java.awt.Stroke drawStroke)

Sets the drawStroke.

Parameters:

drawStroke - The drawStroke to set

setFillPaint

public void setFillPaint(java.awt.Paint fillPaint)

Sets the fillPaint.

Parameters:

fillPaint - The fillPaint to set

setFillPath

public void setFillPath(boolean fillPath)

Sets the fillPath.

Parameters:

fillPath - The fillPath to set

setXValue

public void setXValue(double[] xValue)

Sets the xValue.

Parameters:

xValue - The xValue to set

setYValue

public void setYValue(double[] yValue)

Sets the yValue.

Parameters:

yValue - The yValue to set

isClip

public boolean isClip()

Returns the clip.

Returns:

boolean

setClip

public void setClip(boolean clip)

Sets the clip.

Parameters:

clip - The clip to set