Java Doc for CandlestickRenderer.java in  » Chart » jfreechart » org » jfree » chart » renderer » xy » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Chart » jfreechart » org.jfree.chart.renderer.xy 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.jfree.chart.renderer.xy.AbstractXYItemRenderer
   org.jfree.chart.renderer.xy.CandlestickRenderer

CandlestickRenderer
public class CandlestickRenderer extends AbstractXYItemRenderer implements XYItemRenderer,Cloneable,PublicCloneable,Serializable(Code)
A renderer that draws candlesticks on an XYPlot (requires a OHLCDataset ).

This renderer does not include code to calculate the crosshair point for the plot.



Field Summary
final public static  intWIDTHMETHOD_AVERAGE
     The average width method.
final public static  intWIDTHMETHOD_INTERVALDATA
     The interval data method.
final public static  intWIDTHMETHOD_SMALLEST
     The smallest width method.

Constructor Summary
public  CandlestickRenderer()
     Creates a new renderer for candlestick charts.
public  CandlestickRenderer(double candleWidth)
     Creates a new renderer for candlestick charts.
public  CandlestickRenderer(double candleWidth, boolean drawVolume, XYToolTipGenerator toolTipGenerator)
     Creates a new renderer for candlestick charts.

Use -1 for the candle width if you prefer the width to be calculated automatically.
Parameters:
  candleWidth - the candle width.
Parameters:
  drawVolume - a flag indicating whether or not volume bars should be drawn.
Parameters:
  toolTipGenerator - the tool tip generator.


Method Summary
public  Objectclone()
     Returns a clone of the renderer.
public  voiddrawItem(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.
public  booleandrawVolume()
     Returns a flag indicating whether or not volume bars are drawn on the chart.
public  booleanequals(Object obj)
     Tests this renderer for equality with another object.
Parameters:
  obj - the object (null permitted).
public  doublegetAutoWidthFactor()
     Returns the factor by which the available space automatically calculated for the candles will be multiplied to determine the actual width to use.
public  doublegetAutoWidthGap()
     Returns the amount of space to leave on the left and right of each candle when automatically calculating widths.
public  intgetAutoWidthMethod()
     Returns the method of automatically calculating the candle width.
public  doublegetCandleWidth()
     Returns the width of each candle.
public  PaintgetDownPaint()
     Returns the paint used to fill candles when the price moves down from open to close.
public  booleangetDrawVolume()
     Returns a flag indicating whether or not volume bars are drawn on the chart.
public  doublegetMaxCandleWidthInMilliseconds()
     Returns the maximum width (in milliseconds) of each candle.
public  PaintgetUpPaint()
     Returns the paint used to fill candles when the price moves up from open to close.
public  booleangetUseOutlinePaint()
     Returns the flag that controls whether or not the renderer's outline paint is used to draw the candlestick outline.
public  XYItemRendererStateinitialise(Graphics2D g2, Rectangle2D dataArea, XYPlot plot, XYDataset dataset, PlotRenderingInfo info)
     Initialises the renderer then returns the number of 'passes' through the data that the renderer will require (usually just one).
public  voidsetAutoWidthFactor(double autoWidthFactor)
     Sets the factor by which the available space automatically calculated for the candles will be multiplied to determine the actual width to use.
public  voidsetAutoWidthGap(double autoWidthGap)
     Sets the amount of space to leave on the left and right of each candle when automatically calculating widths.
public  voidsetAutoWidthMethod(int autoWidthMethod)
     Sets the method of automatically calculating the candle width.
public  voidsetCandleWidth(double width)
     Sets the candle width.
public  voidsetDownPaint(Paint paint)
     Sets the paint used to fill candles when the price moves down from open to close and sends a RendererChangeEvent to all registered listeners.
public  voidsetDrawVolume(boolean flag)
     Sets a flag that controls whether or not volume bars are drawn in the background and sends a RendererChangeEvent to all registered listeners.
public  voidsetMaxCandleWidthInMilliseconds(double millis)
     Sets the maximum candle width (in milliseconds).
public  voidsetUpPaint(Paint paint)
     Sets the paint used to fill candles when the price moves up from open to close and sends a RendererChangeEvent to all registered listeners.
public  voidsetUseOutlinePaint(boolean use)
     Sets the flag that controls whether or not the renderer's outline paint is used to draw the candlestick outline, and sends a RendererChangeEvent to all registered listeners.

Field Detail
WIDTHMETHOD_AVERAGE
final public static int WIDTHMETHOD_AVERAGE(Code)
The average width method.



WIDTHMETHOD_INTERVALDATA
final public static int WIDTHMETHOD_INTERVALDATA(Code)
The interval data method.



WIDTHMETHOD_SMALLEST
final public static int WIDTHMETHOD_SMALLEST(Code)
The smallest width method.




Constructor Detail
CandlestickRenderer
public CandlestickRenderer()(Code)
Creates a new renderer for candlestick charts.



CandlestickRenderer
public CandlestickRenderer(double candleWidth)(Code)
Creates a new renderer for candlestick charts.

Use -1 for the candle width if you prefer the width to be calculated automatically.
Parameters:
  candleWidth - The candle width.




CandlestickRenderer
public CandlestickRenderer(double candleWidth, boolean drawVolume, XYToolTipGenerator toolTipGenerator)(Code)
Creates a new renderer for candlestick charts.

Use -1 for the candle width if you prefer the width to be calculated automatically.
Parameters:
  candleWidth - the candle width.
Parameters:
  drawVolume - a flag indicating whether or not volume bars should be drawn.
Parameters:
  toolTipGenerator - the tool tip generator. null is none.





Method Detail
clone
public Object clone() throws CloneNotSupportedException(Code)
Returns a clone of the renderer. A clone.
throws:
  CloneNotSupportedException - if the renderer cannot be cloned.



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)(Code)
Draws the visual representation of a single data item.
Parameters:
  g2 - the graphics device.
Parameters:
  state - the renderer state.
Parameters:
  dataArea - the area within which the plot is being drawn.
Parameters:
  info - collects info about the drawing.
Parameters:
  plot - the plot (can be used to obtain standard color information etc).
Parameters:
  domainAxis - the domain axis.
Parameters:
  rangeAxis - the range axis.
Parameters:
  dataset - the dataset.
Parameters:
  series - the series index (zero-based).
Parameters:
  item - the item index (zero-based).
Parameters:
  crosshairState - crosshair information for the plot (null permitted).
Parameters:
  pass - the pass index.



drawVolume
public boolean drawVolume()(Code)
Returns a flag indicating whether or not volume bars are drawn on the chart. true if volume bars are drawn on the chart.CandlestickRenderer.getDrawVolume()



equals
public boolean equals(Object obj)(Code)
Tests this renderer for equality with another object.
Parameters:
  obj - the object (null permitted). true or false.



getAutoWidthFactor
public double getAutoWidthFactor()(Code)
Returns the factor by which the available space automatically calculated for the candles will be multiplied to determine the actual width to use. The width factor (generally between 0.0 and 1.0).
See Also:   CandlestickRenderer.setAutoWidthFactor(double)



getAutoWidthGap
public double getAutoWidthGap()(Code)
Returns the amount of space to leave on the left and right of each candle when automatically calculating widths. The gap.
See Also:   CandlestickRenderer.setAutoWidthGap(double)



getAutoWidthMethod
public int getAutoWidthMethod()(Code)
Returns the method of automatically calculating the candle width. The method of automatically calculating the candle width.
See Also:   CandlestickRenderer.setAutoWidthMethod(int)



getCandleWidth
public double getCandleWidth()(Code)
Returns the width of each candle. The candle width.
See Also:   CandlestickRenderer.setCandleWidth(double)



getDownPaint
public Paint getDownPaint()(Code)
Returns the paint used to fill candles when the price moves down from open to close. The paint (possibly null).
See Also:   CandlestickRenderer.setDownPaint(Paint)



getDrawVolume
public boolean getDrawVolume()(Code)
Returns a flag indicating whether or not volume bars are drawn on the chart. A boolean.
since:
   1.0.5
See Also:   CandlestickRenderer.setDrawVolume(boolean)



getMaxCandleWidthInMilliseconds
public double getMaxCandleWidthInMilliseconds()(Code)
Returns the maximum width (in milliseconds) of each candle. The maximum candle width in milliseconds.
See Also:   CandlestickRenderer.setMaxCandleWidthInMilliseconds(double)



getUpPaint
public Paint getUpPaint()(Code)
Returns the paint used to fill candles when the price moves up from open to close. The paint (possibly null).
See Also:   CandlestickRenderer.setUpPaint(Paint)



getUseOutlinePaint
public boolean getUseOutlinePaint()(Code)
Returns the flag that controls whether or not the renderer's outline paint is used to draw the candlestick outline. The default value is false. A boolean.
since:
   1.0.5
See Also:   CandlestickRenderer.setUseOutlinePaint(boolean)



initialise
public XYItemRendererState initialise(Graphics2D g2, Rectangle2D dataArea, XYPlot plot, XYDataset dataset, PlotRenderingInfo info)(Code)
Initialises the renderer then returns the number of 'passes' through the data that the renderer will require (usually just one). This method will be called before the first item is rendered, giving the renderer an opportunity to initialise any state information it wants to maintain. The renderer can do nothing if it chooses.
Parameters:
  g2 - the graphics device.
Parameters:
  dataArea - the area inside the axes.
Parameters:
  plot - the plot.
Parameters:
  dataset - the data.
Parameters:
  info - an optional info collection object to return data back to the caller. The number of passes the renderer requires.



setAutoWidthFactor
public void setAutoWidthFactor(double autoWidthFactor)(Code)
Sets the factor by which the available space automatically calculated for the candles will be multiplied to determine the actual width to use.
Parameters:
  autoWidthFactor - The width factor (generally between 0.0 and 1.0).
See Also:   CandlestickRenderer.getAutoWidthFactor()
See Also:   CandlestickRenderer.setCandleWidth(double)
See Also:   CandlestickRenderer.setAutoWidthMethod(int)
See Also:   CandlestickRenderer.setAutoWidthGap(double)
See Also:   CandlestickRenderer.setMaxCandleWidthInMilliseconds(double)



setAutoWidthGap
public void setAutoWidthGap(double autoWidthGap)(Code)
Sets the amount of space to leave on the left and right of each candle when automatically calculating widths.
Parameters:
  autoWidthGap - The gap.
See Also:   CandlestickRenderer.getAutoWidthGap()
See Also:   CandlestickRenderer.setCandleWidth(double)
See Also:   CandlestickRenderer.setAutoWidthMethod(int)
See Also:   CandlestickRenderer.setAutoWidthFactor(double)
See Also:   CandlestickRenderer.setMaxCandleWidthInMilliseconds(double)



setAutoWidthMethod
public void setAutoWidthMethod(int autoWidthMethod)(Code)
Sets the method of automatically calculating the candle width.

WIDTHMETHOD_AVERAGE: Divides the entire display (ignoring scale factor) by the number of items, and uses this as the available width.
WIDTHMETHOD_SMALLEST: Checks the interval between each item, and uses the smallest as the available width.
WIDTHMETHOD_INTERVALDATA: Assumes that the dataset supports the IntervalXYDataset interface, and uses the startXValue - endXValue as the available width.

Parameters:
  autoWidthMethod - The method of automatically calculating the candle width.
See Also:   CandlestickRenderer.WIDTHMETHOD_AVERAGE
See Also:   CandlestickRenderer.WIDTHMETHOD_SMALLEST
See Also:   CandlestickRenderer.WIDTHMETHOD_INTERVALDATA
See Also:   CandlestickRenderer.getAutoWidthMethod()
See Also:   CandlestickRenderer.setCandleWidth(double)
See Also:   CandlestickRenderer.setAutoWidthGap(double)
See Also:   CandlestickRenderer.setAutoWidthFactor(double)
See Also:   CandlestickRenderer.setMaxCandleWidthInMilliseconds(double)




setCandleWidth
public void setCandleWidth(double width)(Code)
Sets the candle width.

If you set the width to a negative value, the renderer will calculate the candle width automatically based on the space available on the chart.
Parameters:
  width - The width.
See Also:   CandlestickRenderer.setAutoWidthMethod(int)
See Also:   CandlestickRenderer.setAutoWidthGap(double)
See Also:   CandlestickRenderer.setAutoWidthFactor(double)
See Also:   CandlestickRenderer.setMaxCandleWidthInMilliseconds(double)




setDownPaint
public void setDownPaint(Paint paint)(Code)
Sets the paint used to fill candles when the price moves down from open to close and sends a RendererChangeEvent to all registered listeners.
Parameters:
  paint - The paint (null permitted).



setDrawVolume
public void setDrawVolume(boolean flag)(Code)
Sets a flag that controls whether or not volume bars are drawn in the background and sends a RendererChangeEvent to all registered listeners.
Parameters:
  flag - the flag.
See Also:   CandlestickRenderer.getDrawVolume()



setMaxCandleWidthInMilliseconds
public void setMaxCandleWidthInMilliseconds(double millis)(Code)
Sets the maximum candle width (in milliseconds).
Parameters:
  millis - The maximum width.
See Also:   CandlestickRenderer.getMaxCandleWidthInMilliseconds()
See Also:   CandlestickRenderer.setCandleWidth(double)
See Also:   CandlestickRenderer.setAutoWidthMethod(int)
See Also:   CandlestickRenderer.setAutoWidthGap(double)
See Also:   CandlestickRenderer.setAutoWidthFactor(double)



setUpPaint
public void setUpPaint(Paint paint)(Code)
Sets the paint used to fill candles when the price moves up from open to close and sends a RendererChangeEvent to all registered listeners.
Parameters:
  paint - the paint (null permitted).
See Also:   CandlestickRenderer.getUpPaint()



setUseOutlinePaint
public void setUseOutlinePaint(boolean use)(Code)
Sets the flag that controls whether or not the renderer's outline paint is used to draw the candlestick outline, and sends a RendererChangeEvent to all registered listeners.
Parameters:
  use - the new flag value.
since:
   1.0.5
See Also:   CandlestickRenderer.getUseOutlinePaint()



Methods inherited from org.jfree.chart.renderer.xy.AbstractXYItemRenderer
public void addAnnotation(XYAnnotation annotation)(Code)(Java Doc)
public void addAnnotation(XYAnnotation annotation, Layer layer)(Code)(Java Doc)
protected void addEntity(EntityCollection entities, Shape area, XYDataset dataset, int series, int item, double entityX, double entityY)(Code)(Java Doc)
protected Point2D calculateDomainMarkerTextAnchorPoint(Graphics2D g2, PlotOrientation orientation, Rectangle2D dataArea, Rectangle2D markerArea, RectangleInsets markerOffset, LengthAdjustmentType labelOffsetType, RectangleAnchor anchor)(Code)(Java Doc)
protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public void drawAnnotations(Graphics2D g2, Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, Layer layer, PlotRenderingInfo info)(Code)(Java Doc)
public void drawDomainGridLine(Graphics2D g2, XYPlot plot, ValueAxis axis, Rectangle2D dataArea, double value)(Code)(Java Doc)
public void drawDomainLine(Graphics2D g2, XYPlot plot, ValueAxis axis, Rectangle2D dataArea, double value, Paint paint, Stroke stroke)(Code)(Java Doc)
public void drawDomainMarker(Graphics2D g2, XYPlot plot, ValueAxis domainAxis, Marker marker, Rectangle2D dataArea)(Code)(Java Doc)
protected void drawItemLabel(Graphics2D g2, PlotOrientation orientation, XYDataset dataset, int series, int item, double x, double y, boolean negative)(Code)(Java Doc)
public void drawRangeLine(Graphics2D g2, XYPlot plot, ValueAxis axis, Rectangle2D dataArea, double value, Paint paint, Stroke stroke)(Code)(Java Doc)
public void drawRangeMarker(Graphics2D g2, XYPlot plot, ValueAxis rangeAxis, Marker marker, Rectangle2D dataArea)(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
public void fillDomainGridBand(Graphics2D g2, XYPlot plot, ValueAxis axis, Rectangle2D dataArea, double start, double end)(Code)(Java Doc)
public void fillRangeGridBand(Graphics2D g2, XYPlot plot, ValueAxis axis, Rectangle2D dataArea, double start, double end)(Code)(Java Doc)
public Range findDomainBounds(XYDataset dataset)(Code)(Java Doc)
public Range findRangeBounds(XYDataset dataset)(Code)(Java Doc)
public XYItemLabelGenerator getBaseItemLabelGenerator()(Code)(Java Doc)
public XYToolTipGenerator getBaseToolTipGenerator()(Code)(Java Doc)
public int getDefaultEntityRadius()(Code)(Java Doc)
public DrawingSupplier getDrawingSupplier()(Code)(Java Doc)
public XYItemLabelGenerator getItemLabelGenerator(int series, int item)(Code)(Java Doc)
public XYItemLabelGenerator getItemLabelGenerator()(Code)(Java Doc)
public LegendItem getLegendItem(int datasetIndex, int series)(Code)(Java Doc)
public XYSeriesLabelGenerator getLegendItemLabelGenerator()(Code)(Java Doc)
public XYSeriesLabelGenerator getLegendItemToolTipGenerator()(Code)(Java Doc)
public XYSeriesLabelGenerator getLegendItemURLGenerator()(Code)(Java Doc)
public LegendItemCollection getLegendItems()(Code)(Java Doc)
public int getPassCount()(Code)(Java Doc)
public XYPlot getPlot()(Code)(Java Doc)
public XYItemLabelGenerator getSeriesItemLabelGenerator(int series)(Code)(Java Doc)
public XYToolTipGenerator getSeriesToolTipGenerator(int series)(Code)(Java Doc)
public XYToolTipGenerator getToolTipGenerator(int series, int item)(Code)(Java Doc)
public XYToolTipGenerator getToolTipGenerator()(Code)(Java Doc)
public XYURLGenerator getURLGenerator()(Code)(Java Doc)
public XYItemRendererState initialise(Graphics2D g2, Rectangle2D dataArea, XYPlot plot, XYDataset data, PlotRenderingInfo info)(Code)(Java Doc)
public boolean removeAnnotation(XYAnnotation annotation)(Code)(Java Doc)
public void removeAnnotations()(Code)(Java Doc)
public void setBaseItemLabelGenerator(XYItemLabelGenerator generator)(Code)(Java Doc)
public void setBaseToolTipGenerator(XYToolTipGenerator generator)(Code)(Java Doc)
public void setDefaultEntityRadius(int radius)(Code)(Java Doc)
public void setItemLabelGenerator(XYItemLabelGenerator generator)(Code)(Java Doc)
public void setLegendItemLabelGenerator(XYSeriesLabelGenerator generator)(Code)(Java Doc)
public void setLegendItemToolTipGenerator(XYSeriesLabelGenerator generator)(Code)(Java Doc)
public void setLegendItemURLGenerator(XYSeriesLabelGenerator generator)(Code)(Java Doc)
public void setPlot(XYPlot plot)(Code)(Java Doc)
public void setSeriesItemLabelGenerator(int series, XYItemLabelGenerator generator)(Code)(Java Doc)
public void setSeriesToolTipGenerator(int series, XYToolTipGenerator generator)(Code)(Java Doc)
public void setToolTipGenerator(XYToolTipGenerator generator)(Code)(Java Doc)
public void setURLGenerator(XYURLGenerator urlGenerator)(Code)(Java Doc)
protected void updateCrosshairValues(CrosshairState crosshairState, double x, double y, double transX, double transY, PlotOrientation orientation)(Code)(Java Doc)
protected void updateCrosshairValues(CrosshairState crosshairState, double x, double y, int domainAxisIndex, int rangeAxisIndex, double transX, double transY, PlotOrientation orientation)(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.