Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.chart

Class ClipPath

Implemented Interfaces:
Cloneable
public class ClipPath
extends java.lang.Object
implements Cloneable
This class would typically be used with a ContourPlot. 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.

Constructor Summary

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

Method Summary

Object
clone()
Returns a clone of the object (a deeper clone than default to avoid bugs when setting values in cloned object).
GeneralPath
draw(Graphics2D g2, Rectangle2D dataArea, ValueAxis horizontalAxis, ValueAxis verticalAxis)
Draws the clip path.
GeneralPath
generateClipPath(Rectangle2D dataArea, ValueAxis horizontalAxis, ValueAxis verticalAxis)
Generates the clip path.
Composite
getComposite()
Returns the composite.
Paint
getDrawPaint()
Returns the drawPaint.
Stroke
getDrawStroke()
Returns the drawStroke.
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(Composite composite)
Sets the composite.
void
setDrawPaint(Paint drawPaint)
Sets the drawPaint.
void
setDrawPath(boolean drawPath)
Sets the drawPath.
void
setDrawStroke(Stroke drawStroke)
Sets the drawStroke.
void
setFillPaint(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.

Constructor Details

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.
Parameters:
xValue - x coordinates of curved to be created
yValue - y coordinates of curved to be created

ClipPath

public ClipPath(double[] xValue,
                double[] yValue,
                boolean fillPath,
                boolean drawPath,
                Paint fillPaint,
                Paint drawPaint,
                Stroke drawStroke,
                Composite composite)
Constructor for ClipPath.
Parameters:
xValue - x coordinates of curved to be created
yValue - y coordinates of curved to be created
fillPath - whether the path is to filled
drawPath - whether the path is to drawn as an outline
fillPaint - the fill paint
drawPaint - the outline stroke color
drawStroke - the stroke style
composite - the composite rule

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.
Parameters:
xValue - x coordinates of curved to be created
yValue - y coordinates of curved to be created
clip - clip?
fillPath - whether the path is to filled
drawPath - whether the path is to drawn as an outline

Method Details

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of the object (a deeper clone than default to avoid bugs when setting values in cloned object).
Returns:
The clone.

draw

public GeneralPath draw(Graphics2D g2,
                        Rectangle2D dataArea,
                        ValueAxis horizontalAxis,
                        ValueAxis verticalAxis)
Draws the clip path.
Parameters:
g2 - current graphics2D.
dataArea - the dataArea that the plot is being draw in.
horizontalAxis - the horizontal axis.
verticalAxis - the vertical axis.
Returns:
The GeneralPath defining the outline

generateClipPath

public GeneralPath generateClipPath(Rectangle2D dataArea,
                                    ValueAxis horizontalAxis,
                                    ValueAxis verticalAxis)
Generates the clip path.
Parameters:
dataArea - the dataArea that the plot is being draw in.
horizontalAxis - the horizontal axis.
verticalAxis - the vertical axis.
Returns:
The GeneralPath defining the outline

getComposite

public Composite getComposite()
Returns the composite.
Returns:
Composite

getDrawPaint

public Paint getDrawPaint()
Returns the drawPaint.
Returns:
Paint

getDrawStroke

public Stroke getDrawStroke()
Returns the drawStroke.
Returns:
Stroke

getFillPaint

public Paint getFillPaint()
Returns the fillPaint.
Returns:
Paint

getXValue

public double[] getXValue()
Returns the xValue.
Returns:
double[]

getYValue

public double[] getYValue()
Returns the yValue.
Returns:
double[]

isClip

public boolean isClip()
Returns the clip.
Returns:
boolean

isDrawPath

public boolean isDrawPath()
Returns the drawPath.
Returns:
boolean

isFillPath

public boolean isFillPath()
Returns the fillPath.
Returns:
boolean

setClip

public void setClip(boolean clip)
Sets the clip.
Parameters:
clip - The clip to set

setComposite

public void setComposite(Composite composite)
Sets the composite.
Parameters:
composite - The composite to set

setDrawPaint

public void setDrawPaint(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(Stroke drawStroke)
Sets the drawStroke.
Parameters:
drawStroke - The drawStroke to set

setFillPaint

public void setFillPaint(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

Overview Package Class Use Source Tree Index Deprecated About