public class

ClipPath

extends Object
implements Cloneable
java.lang.Object
   ↳ org.jfree.chart.ClipPath

This class is deprecated.
This class is no longer supported (as of version 1.0.4). If you are creating contour plots, please try to use XYPlot and XYBlockRenderer.

Class Overview

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.

Summary

Public Constructors
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, Paint fillPaint, Paint drawPaint, Stroke drawStroke, Composite composite)
Constructor for ClipPath.
Public Methods
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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ClipPath ()

Constructor for 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

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

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

Public Methods

public Object clone ()

Returns a clone of the object (a deeper clone than default to avoid bugs when setting values in cloned object).

Returns
  • The clone.
Throws
CloneNotSupportedException if cloning is not supported.

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

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

public Composite getComposite ()

Returns the composite.

Returns
  • Composite

public Paint getDrawPaint ()

Returns the drawPaint.

Returns
  • Paint

public Stroke getDrawStroke ()

Returns the drawStroke.

Returns
  • Stroke

public Paint getFillPaint ()

Returns the fillPaint.

Returns
  • Paint

public double[] getXValue ()

Returns the xValue.

Returns
  • double[]

public double[] getYValue ()

Returns the yValue.

Returns
  • double[]

public boolean isClip ()

Returns the clip.

Returns
  • boolean

public boolean isDrawPath ()

Returns the drawPath.

Returns
  • boolean

public boolean isFillPath ()

Returns the fillPath.

Returns
  • boolean

public void setClip (boolean clip)

Sets the clip.

Parameters
clip The clip to set

public void setComposite (Composite composite)

Sets the composite.

Parameters
composite The composite to set

public void setDrawPaint (Paint drawPaint)

Sets the drawPaint.

Parameters
drawPaint The drawPaint to set

public void setDrawPath (boolean drawPath)

Sets the drawPath.

Parameters
drawPath The drawPath to set

public void setDrawStroke (Stroke drawStroke)

Sets the drawStroke.

Parameters
drawStroke The drawStroke to set

public void setFillPaint (Paint fillPaint)

Sets the fillPaint.

Parameters
fillPaint The fillPaint to set

public void setFillPath (boolean fillPath)

Sets the fillPath.

Parameters
fillPath The fillPath to set

public void setXValue (double[] xValue)

Sets the xValue.

Parameters
xValue The xValue to set

public void setYValue (double[] yValue)

Sets the yValue.

Parameters
yValue The yValue to set