Module platform
Package org.jfree.chart.renderer.xy

Class HighLowRenderer

java.lang.Object
org.jfree.chart.renderer.AbstractRenderer
org.jfree.chart.renderer.xy.AbstractXYItemRenderer
org.jfree.chart.renderer.xy.HighLowRenderer
All Implemented Interfaces:
Serializable, Cloneable, EventListener, AnnotationChangeListener, LegendItemSource, XYItemRenderer, PublicCloneable
public class HighLowRenderer extends AbstractXYItemRenderer implements XYItemRenderer, Cloneable, PublicCloneable, Serializable
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
See Also:

  • Constructor Details

    • HighLowRenderer

      public HighLowRenderer()
      The default constructor.

  • Method Details

    • getDrawOpenTicks

      public boolean getDrawOpenTicks()
      Returns the flag that controls whether open ticks are drawn.
      Returns:
      A boolean.
      See Also:

    • setDrawOpenTicks

      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.
      See Also:

    • getDrawCloseTicks

      public boolean getDrawCloseTicks()
      Returns the flag that controls whether close ticks are drawn.
      Returns:
      A boolean.
      See Also:

    • setDrawCloseTicks

      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.
      See Also:

    • getOpenTickPaint

      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).
      See Also:

    • setOpenTickPaint

      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).
      See Also:

    • getCloseTickPaint

      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).
      See Also:

    • setCloseTickPaint

      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).
      See Also:

    • getTickLength

      public double getTickLength()
      Returns the tick length (in Java2D units).
      Returns:
      The tick length.
      See Also:

    • setTickLength

      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:

    • findRangeBounds

      public Range findRangeBounds(XYDataset dataset)
      Returns the range of values the renderer requires to display all the items from the specified dataset.
      Specified by:
      findRangeBounds in interface XYItemRenderer
      Overrides:
      findRangeBounds in class AbstractXYItemRenderer
      Parameters:
      dataset - the dataset (null permitted).
      Returns:
      The range (null if the dataset is null or empty).
      See Also:

    • drawItem

      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.
      Specified by:
      drawItem in interface XYItemRenderer
      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.

    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a clone of the renderer.
      Specified by:
      clone in interface PublicCloneable
      Overrides:
      clone in class AbstractXYItemRenderer
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if the renderer cannot be cloned.

    • equals

      public boolean equals(Object obj)
      Tests this renderer for equality with an arbitrary object.
      Overrides:
      equals in class AbstractXYItemRenderer
      Parameters:
      obj - the object (null permitted).
      Returns:
      A boolean.