public class

HighLowRenderer

extends AbstractXYItemRenderer
implements Serializable Cloneable XYItemRenderer
java.lang.Object
   ↳ org.jfree.chart.renderer.AbstractRenderer
     ↳ org.jfree.chart.renderer.xy.AbstractXYItemRenderer
       ↳ org.jfree.chart.renderer.xy.HighLowRenderer

Class Overview

A renderer that draws high/low/open/close markers on an XYPlot (requires a OHLCDataset). This renderer does not include code to calculate the crosshair point for the plot. The example shown here is generated by the HighLowChartDemo1.java program included in the JFreeChart Demo Collection:

HighLowRendererSample.png

Summary

[Expand]
Inherited Fields
From class org.jfree.chart.renderer.AbstractRenderer
Public Constructors
HighLowRenderer()
The default constructor.
Public Methods
Object clone()
Returns a clone of the renderer.
void drawItem(Graphics2D g2, XYItemRendererState state, Rectangle2D dataArea, PlotRenderingInfo info, XYPlot plot, ValueAxis domainAxis, ValueAxis rangeAxis, XYDataset dataset, int series, int item, CrosshairState crosshairState, int pass)
Draws the visual representation of a single data item.
boolean equals(Object obj)
Tests this renderer for equality with an arbitrary object.
Range findRangeBounds(XYDataset dataset)
Returns the range of values the renderer requires to display all the items from the specified dataset.
Paint getCloseTickPaint()
Returns the paint used to draw the ticks for the close values.
boolean getDrawCloseTicks()
Returns the flag that controls whether close ticks are drawn.
boolean getDrawOpenTicks()
Returns the flag that controls whether open ticks are drawn.
Paint getOpenTickPaint()
Returns the paint used to draw the ticks for the open values.
double getTickLength()
Returns the tick length (in Java2D units).
void setCloseTickPaint(Paint paint)
Sets the paint used to draw the ticks for the close values and sends a RendererChangeEvent to all registered listeners.
void setDrawCloseTicks(boolean draw)
Sets the flag that controls whether close ticks are drawn, and sends a RendererChangeEvent to all registered listeners.
void setDrawOpenTicks(boolean draw)
Sets the flag that controls whether open ticks are drawn, and sends a RendererChangeEvent to all registered listeners.
void setOpenTickPaint(Paint paint)
Sets the paint used to draw the ticks for the open values and sends a RendererChangeEvent to all registered listeners.
void setTickLength(double length)
Sets the tick length (in Java2D units) and sends a RendererChangeEvent to all registered listeners.
[Expand]
Inherited Methods
From class org.jfree.chart.renderer.xy.AbstractXYItemRenderer
From class org.jfree.chart.renderer.AbstractRenderer
From class java.lang.Object
From interface org.jfree.chart.LegendItemSource
From interface org.jfree.chart.renderer.xy.XYItemRenderer

Public Constructors

public HighLowRenderer ()

The default constructor.

Public Methods

public Object clone ()

Returns a clone of the renderer.

Returns
  • A clone.
Throws
CloneNotSupportedException if the renderer cannot be cloned.

public void drawItem (Graphics2D g2, XYItemRendererState state, Rectangle2D dataArea, PlotRenderingInfo info, XYPlot plot, ValueAxis domainAxis, ValueAxis rangeAxis, XYDataset dataset, int series, int item, CrosshairState crosshairState, int pass)

Draws the visual representation of a single data item.

Parameters
g2 the graphics device.
state the renderer state.
dataArea the area within which the plot is being drawn.
info collects information about the drawing.
plot the plot (can be used to obtain standard color information etc).
domainAxis the domain axis.
rangeAxis the range axis.
dataset the dataset.
series the series index (zero-based).
item the item index (zero-based).
crosshairState crosshair information for the plot (null permitted).
pass the pass index.

public boolean equals (Object obj)

Tests this renderer for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public Range findRangeBounds (XYDataset dataset)

Returns the range of values the renderer requires to display all the items from the specified dataset.

Parameters
dataset the dataset (null permitted).
Returns
  • The range (null if the dataset is null or empty).

public Paint getCloseTickPaint ()

Returns the paint used to draw the ticks for the close values.

Returns
  • The paint used to draw the ticks for the close values (possibly null).

public boolean getDrawCloseTicks ()

Returns the flag that controls whether close ticks are drawn.

Returns
  • A boolean.

public boolean getDrawOpenTicks ()

Returns the flag that controls whether open ticks are drawn.

Returns
  • A boolean.

public Paint getOpenTickPaint ()

Returns the paint used to draw the ticks for the open values.

Returns
  • The paint used to draw the ticks for the open values (possibly null).

public double getTickLength ()

Returns the tick length (in Java2D units).

Returns
  • The tick length.

public void setCloseTickPaint (Paint paint)

Sets the paint used to draw the ticks for the close values and sends a RendererChangeEvent to all registered listeners. If you set this to null (the default), the series paint is used instead.

Parameters
paint the paint (null permitted).

public void setDrawCloseTicks (boolean draw)

Sets the flag that controls whether close ticks are drawn, and sends a RendererChangeEvent to all registered listeners.

Parameters
draw the flag.

public void setDrawOpenTicks (boolean draw)

Sets the flag that controls whether open ticks are drawn, and sends a RendererChangeEvent to all registered listeners.

Parameters
draw the flag.

public void setOpenTickPaint (Paint paint)

Sets the paint used to draw the ticks for the open values and sends a RendererChangeEvent to all registered listeners. If you set this to null (the default), the series paint is used instead.

Parameters
paint the paint (null permitted).

public void setTickLength (double length)

Sets the tick length (in Java2D units) and sends a RendererChangeEvent to all registered listeners.

Parameters
length the length.
See Also