Java > Open Source Codes > org > jfree > chart > renderer > CategoryItemRenderer


1 /* ======================================
2  * JFreeChart : a free Java chart library
3  * ======================================
4  *
5  * Project Info: http://www.jfree.org/jfreechart/index.html
6  * Project Lead: David Gilbert (david.gilbert@object-refinery.com);
7  *
8  * (C) Copyright 2000-2003, by Object Refinery Limited and Contributors.
9  *
10  * This library is free software; you can redistribute it and/or modify it under the terms
11  * of the GNU Lesser General Public License as published by the Free Software Foundation;
12  * either version 2.1 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
15  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  * See the GNU Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License along with this
19  * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20  * Boston, MA 02111-1307, USA.
21  *
22  * -------------------------
23  * CategoryItemRenderer.java
24  * -------------------------
25  *
26  * (C) Copyright 2001-2003, by Object Refinery Limited and Contributors.
27  *
28  * Original Author: David Gilbert (for Object Refinery Limited);
29  * Contributor(s): Mark Watson (www.markwatson.com);
30  *
31  * $Id: CategoryItemRenderer.java,v 1.25 2003/11/12 17:19:42 mungady Exp $
32  *
33  * Changes
34  * -------
35  * 23-Oct-2001 : Version 1 (DG);
36  * 16-Jan-2002 : Renamed HorizontalCategoryItemRenderer.java --> CategoryItemRenderer.java (DG);
37  * 05-Feb-2002 : Changed return type of the drawCategoryItem method from void to Shape, as part
38  * of the tooltips implementation (DG)
39  *
40  * NOTE (30-May-2002) : this has subsequently been changed back to void, tooltips
41  * are now collected along with entities in ChartRenderingInfo (DG);
42  *
43  * 14-Mar-2002 : Added the initialise method, and changed all bar plots to use this renderer (DG);
44  * 23-May-2002 : Added ChartRenderingInfo to the initialise method (DG);
45  * 29-May-2002 : Added the getAxisArea(Rectangle2D) method (DG);
46  * 06-Jun-2002 : Updated Javadoc comments (DG);
47  * 26-Jun-2002 : Added range axis to the initialise method (DG);
48  * 24-Sep-2002 : Added getLegendItem(...) method (DG);
49  * 23-Oct-2002 : Added methods to get/setToolTipGenerator (DG);
50  * 05-Nov-2002 : Replaced references to CategoryDataset with TableDataset (DG);
51  * 06-Nov-2002 : Added the domain axis to the drawCategoryItem method. Renamed
52  * drawCategoryItem(...) --> drawItem(...) (DG);
53  * 20-Nov-2002 : Changed signature of drawItem(...) method to reflect use of TableDataset (DG);
54  * 26-Nov-2002 : Replaced the isStacked() method with the getRangeType() method (DG);
55  * 08-Jan-2003 : Changed getSeriesCount() --> getRowCount() and
56  * getCategoryCount() --> getColumnCount() (DG);
57  * 09-Jan-2003 : Changed name of grid-line methods (DG);
58  * 21-Jan-2003 : Merged TableDataset with CategoryDataset (DG);
59  * 10-Apr-2003 : Changed CategoryDataset to KeyedValues2DDataset in drawItem(...) method (DG);
60  * 29-Apr-2003 : Eliminated Renderer interface (DG);
61  * 02-Sep-2003 : Fix for bug 790407 (DG);
62  * 16-Sep-2003 : Changed ChartRenderingInfo --> PlotRenderingInfo (DG);
63  * 20-Oct-2003 : Added setOutlinePaint(...) method (DG);
64  *
65  */
66
67 package org.jfree.chart.renderer;
68
69 import java.awt.Font ;
70 import java.awt.Graphics2D ;
71 import java.awt.Paint ;
72 import java.awt.Shape ;
73 import java.awt.Stroke ;
74 import java.awt.geom.Rectangle2D ;
75
76 import org.jfree.chart.LegendItem;
77 import org.jfree.chart.Marker;
78 import org.jfree.chart.axis.CategoryAxis;
79 import org.jfree.chart.axis.ValueAxis;
80 import org.jfree.chart.event.RendererChangeListener;
81 import org.jfree.chart.labels.CategoryItemLabelGenerator;
82 import org.jfree.chart.plot.CategoryPlot;
83 import org.jfree.chart.plot.PlotRenderingInfo;
84 import org.jfree.chart.urls.CategoryURLGenerator;
85 import org.jfree.data.CategoryDataset;
86 import org.jfree.ui.TextAnchor;
87
88 /**
89  * A plug-in object that is used by the {@link CategoryPlot} class to display individual data items
90  * from a {@link CategoryDataset}.
91  * <p>
92  * This interface defines the methods that must be provided by all renderers. If you are
93  * implementing a custom renderer, you should consider extending the
94  * {@link AbstractCategoryItemRenderer} class.
95  *
96  * @author David Gilbert
97  */
98 public interface CategoryItemRenderer {
99
100     /**
101      * Returns the plot that the renderer has been assigned to.
102      *
103      * @return the plot.
104      */
105     public CategoryPlot getPlot();
106
107     /**
108      * Sets the plot that the renderer has been assigned to.
109      * <P>
110      * You shouldn't need to call this method yourself, the plot will do it for you when you
111      * assign the renderer to the plot.
112      *
113      * @param plot the plot.
114      */
115     public void setPlot(CategoryPlot plot);
116
117     /**
118      * Adds a change listener.
119      *
120      * @param listener the listener.
121      */
122     public void addChangeListener(RendererChangeListener listener);
123     
124     /**
125      * Removes a change listener.
126      *
127      * @param listener the listener.
128      */
129     public void removeChangeListener(RendererChangeListener listener);
130     
131     /**
132      * Returns the range type for the renderer. The plot needs to know this information in order
133      * to determine an appropriate axis range (when the axis auto-range calculation is on).
134      * <P>
135      * Two types are recognised:
136      * <ul>
137      * <li><code>STANDARD</code> - data items are plotted individually, so the axis range should
138      * extend from the smallest value to the largest value;</li>
139      * <li><code>STACKED</code> - data items are stacked on top of one another, so to determine
140      * the axis range, all the items in a series need to be summed together.</li>
141      * </ul>
142      *
143      * If the data values are stacked, this affects the axis range required to
144      * display all the data items.
145      *
146      * @return a flag indicating whether or not the data values are stacked.
147      */
148     public RangeType getRangeType();
149
150     /**
151      * Initialises the renderer. This method will be called before the first item is rendered,
152      * giving the renderer an opportunity to initialise any state information it wants to maintain.
153      * The renderer can do nothing if it chooses.
154      *
155      * @param g2 the graphics device.
156      * @param dataArea the area inside the axes.
157      * @param plot the plot.
158      * @param index the secondary index (<code>null</code> for primary renderer).
159      * @param info collects chart rendering information for return to caller.
160      *
161      * @return A state object (maintains state information relevant to one chart drawing).
162      */
163     public CategoryItemRendererState initialise(Graphics2D g2,
164                                                 Rectangle2D dataArea,
165                                                 CategoryPlot plot,
166                                                 Integer index,
167                                                 PlotRenderingInfo info);
168                            
169     /**
170      * Returns the base paint.
171      *
172      * @return The base paint.
173      */
174     public Paint getBasePaint();
175
176     /**
177      * Sets the base paint.
178      * <p>
179      * In most cases, the renderer's paint table will be active and so this default value will
180      * not be used.
181      *
182      * @param paint the paint.
183      */
184     public void setBasePaint(Paint paint);
185
186     /**
187      * Returns the paint used to fill an item.
188      *
189      * @param series the series index (zero-based).
190      * @param category the category index (zero-based).
191      *
192      * @return The paint.
193      */
194     public Paint getItemPaint(int series, int category);
195
196     /**
197      * Returns the paint used to fill shapes for this renderer.
198      *
199      * @param series the series (zero-based index).
200      *
201      * @return the paint.
202      */
203     public Paint getSeriesPaint(int series);
204
205     /**
206      * Sets the paint for a series in the primary dataset.
207      *
208      * @param series the series index (zero-based).
209      * @param paint the paint.
210      */
211     public void setSeriesPaint(int series, Paint paint);
212
213     /**
214      * Returns the base outline paint.
215      *
216      * @return The base outline paint.
217      */
218     public Paint getBaseOutlinePaint();
219
220     /**
221      * Sets the base outline paint.
222      *
223      * @param paint the paint.
224      */
225     public void setBaseOutlinePaint(Paint paint);
226
227     /**
228      * Returns the outline paint for an item.
229      *
230      * @param series the series index (zero-based).
231      * @param item the item index (zero-based).
232      *
233      * @return The paint.
234      */
235     public Paint getItemOutlinePaint(int series, int item);
236
237     /**
238      * Sets the outline paint for ALL series (optional).
239      *
240      * @param paint the paint (<code>null</code> permitted).
241      */
242     public void setOutlinePaint(Paint paint);
243     
244     /**
245      * Returns the outline paint for a series.
246      *
247      * @param series the series index (zero-based).
248      *
249      * @return The paint.
250      */
251     public Paint getSeriesOutlinePaint(int series);
252
253     /**
254      * Sets the outline paint for a series in the primary dataset.
255      *
256      * @param series the series index (zero-based).
257      * @param paint the paint.
258      */
259     public void setSeriesOutlinePaint(int series, Paint paint);
260
261     // STROKE
262
263     /**
264      * Returns the stroke for an item.
265      *
266      * @param series the series index (zero-based).
267      * @param item the item index (zero-based).
268      *
269      * @return The stroke.
270      */
271     public Stroke getItemStroke(int series, int item);
272
273     /**
274      * Returns the stroke for a series.
275      *
276      * @param series the series index (zero-based).
277      *
278      * @return The stroke.
279      */
280     public Stroke getSeriesStroke(int series);
281
282     /**
283      * Sets the stroke for ALL series (optional).
284      *
285      * @param stroke the stroke.
286      */
287     public void setStroke(Stroke stroke);
288     
289     /**
290      * Sets the stroke for a series in the primary dataset.
291      *
292      * @param series the series index (zero-based).
293      * @param stroke the stroke.
294      */
295     public void setSeriesStroke(int series, Stroke stroke);
296
297     /**
298      * Returns the base stroke.
299      *
300      * @return The stroke.
301      */
302     public Stroke getBaseStroke();
303
304     /**
305      * Sets the base stroke.
306      *
307      * @param stroke the stroke.
308      */
309     public void setBaseStroke(Stroke stroke);
310
311     // OUTLINE STROKE
312
313     /**
314      * Returns the outline stroke for an item.
315      *
316      * @param series the series index (zero-based).
317      * @param item the item index (zero-based).
318      *
319      * @return The stroke.
320      */
321     public Stroke getItemOutlineStroke(int series, int item);
322
323     /**
324      * Returns the outline stroke for a series.
325      *
326      * @param series the series index (zero-based).
327      *
328      * @return The stroke.
329      */
330     public Stroke getSeriesOutlineStroke(int series);
331
332     /**
333      * Sets the outline stroke for ALL series.
334      *
335      * @param stroke the stroke.
336      */
337     public void setOutlineStroke(Stroke stroke);
338     
339     /**
340      * Sets the outline stroke for a series in the primary dataset.
341      *
342      * @param series the series index (zero-based).
343      * @param stroke the stroke.
344      */
345     public void setSeriesOutlineStroke(int series, Stroke stroke);
346
347     /**
348      * Returns the base outline stroke.
349      *
350      * @return The outline stroke.
351      */
352     public Stroke getBaseOutlineStroke();
353
354     /**
355      * Sets the base outline stroke.
356      *
357      * @param stroke the outline stroke.
358      */
359     public void setBaseOutlineStroke(Stroke stroke);
360
361     // SHAPE
362
363     /**
364      * Returns the shape for an item.
365      *
366      * @param series the series index (zero-based).
367      * @param item the item index (zero-based).
368      *
369      * @return The shape.
370      */
371     public Shape getItemShape(int series, int item);
372
373     /**
374      * Returns the shape for a series.
375      *
376      * @param series the series index (zero-based).
377      *
378      * @return The shape.
379      */
380     public Shape getSeriesShape(int series);
381
382     /**
383      * Sets the shape for a series in the primary dataset.
384      *
385      * @param series the series index (zero-based).
386      * @param shape the shape.
387      */
388     public void setSeriesShape(int series, Shape shape);
389
390     /**
391      * Returns the base shape.
392      *
393      * @return The shape.
394      */
395     public Shape getBaseShape();
396
397     /**
398      * Sets the base shape.
399      *
400      * @param shape the shape.
401      */
402     public void setBaseShape(Shape shape);
403
404     // ITEM LABEL VISIBLE
405
406     /**
407      * Sets a flag that controls whether or not the item labels for ALL series are visible.
408      *
409      * @param visible the flag (<code>null</code> permitted).
410      */
411     public void setItemLabelsVisible(Boolean visible);
412
413     /**
414      * Sets a flag that controls whether or not the item labels for ALL series are visible.
415      *
416      * @param visible the flag (<code>null</code> permitted).
417      */
418     public void setItemLabelsVisible(boolean visible);
419
420     // ITEM LABEL GENERATOR
421
422     /**
423      * Returns the item label generator for an item.
424      *
425      * @param series the series index (zero-based).
426      * @param item the item index (zero-based).
427      *
428      * @return The item label generator.
429      */
430     public CategoryItemLabelGenerator getItemLabelGenerator(int series, int item);
431
432     /**
433      * Returns the item label generator for a series.
434      *
435      * @param series the series index (zero-based).
436      *
437      * @return The label generator.
438      */
439     public CategoryItemLabelGenerator getSeriesItemLabelGenerator(int series);
440
441     /**
442      * Sets the item label generator for ALL series.
443      *
444      * @param generator the generator.
445      */
446     public void setItemLabelGenerator(CategoryItemLabelGenerator generator);
447     
448     /**
449      * Sets the item label generator for a series.
450      *
451      * @param series the series index (zero-based).
452      * @param generator the generator.
453      */
454     public void setSeriesItemLabelGenerator(int series, CategoryItemLabelGenerator generator);
455
456     /**
457      * Returns the base item label generator.
458      *
459      * @return The base item label generator.
460      */
461     public CategoryItemLabelGenerator getBaseItemLabelGenerator();
462
463     /**
464      * Sets the base item label generator.
465      *
466      * @param generator the base item label generator.
467      */
468     public void setBaseItemLabelGenerator(CategoryItemLabelGenerator generator);
469
470     // ITEM LABEL ANCHOR
471
472     /**
473      * Returns the item label anchor for an item.
474      *
475      * @param series the series index (zero-based).
476      * @param item the item index (zero-based).
477      *
478      * @return The item label anchor.
479      *
480      * @deprecated Use getItemLabelPosition.
481      */
482     public ItemLabelAnchor getItemLabelAnchor(int series, int item);
483
484     /**
485      * Returns the item label anchor for a series.
486      *
487      * @param series the series index (zero-based).
488      *
489      * @return The anchor.
490      *
491      * @deprecated Use getSeriesItemLabelPosition.
492      */
493     public ItemLabelAnchor getSeriesItemLabelAnchor(int series);
494
495     /**
496      * Sets the item label anchor for ALL series.
497      *
498      * @param anchor the anchor.
499      *
500      * @deprecated Use setItemLabelPosition.
501      */
502     public void setItemLabelAnchor(ItemLabelAnchor anchor);
503     
504     /**
505      * Sets the item label anchor for a series.
506      *
507      * @param series the series index (zero-based).
508      * @param anchor the anchor.
509      *
510      * @deprecated Use setSeriesItemLabelPosition.
511      */
512     public void setSeriesItemLabelAnchor(int series, ItemLabelAnchor anchor);
513
514     /**
515      * Returns the base item label anchor.
516      *
517      * @return The item label anchor.
518      *
519      * @deprecated Use getBaseItemLabelPosition.
520      */
521     public ItemLabelAnchor getBaseItemLabelAnchor();
522
523     /**
524      * Sets the base item label anchor.
525      *
526      * @param anchor the base item label anchor.
527      *
528      * @deprecated Use setBaseItemLabelPosition.
529      */
530     public void setBaseItemLabelAnchor(ItemLabelAnchor anchor);
531
532     // ITEM LABEL TEXT ANCHOR
533
534     /**
535      * Returns the item label text anchor for an item.
536      *
537      * @param series the series index (zero-based).
538      * @param item the item index (zero-based).
539      *
540      * @return The item label text anchor.
541      *
542      * @deprecated Use getItemLabelPosition.
543      */
544     public TextAnchor getItemLabelTextAnchor(int series, int item);
545
546     /**
547      * Returns the item label text anchor for a series.
548      *
549      * @param series the series index (zero-based).
550      *
551      * @return The anchor.
552      *
553      * @deprecated User getSeriesItemLabelPosition.
554      */
555     public TextAnchor getSeriesItemLabelTextAnchor(int series);
556
557     /**
558      * Sets the item label text anchor for ALL series.
559      *
560      * @param anchor the anchor.
561      *
562      * @deprecated Use setItemLabelPosition.
563      */
564     public void setItemLabelTextAnchor(TextAnchor anchor);
565     
566     /**
567      * Sets the item label text anchor for a series.
568      *
569      * @param series the series index (zero-based).
570      * @param anchor the anchor.
571      *
572      * @deprecated Use setSeriesItemLabelPosition.
573      */
574     public void setSeriesItemLabelTextAnchor(int series, TextAnchor anchor);
575
576     /**
577      * Returns the base item label text anchor.
578      *
579      * @return The item label text anchor.
580      *
581      * @deprecated Use setBaseItemLabelPosition.
582      */
583     public TextAnchor getBaseItemLabelTextAnchor();
584
585     /**
586      * Sets the base item label text anchor.
587      *
588      * @param anchor the item label text anchor.
589      *
590      * @deprecated Use setBaseItemLabelPosition.
591      */
592     public void setBaseItemLabelTextAnchor(TextAnchor anchor);
593
594     // ITEM LABEL FONT
595
596     /**
597      * Returns the item label font for an item.
598      *
599      * @param series the series index (zero-based).
600      * @param item the item index (zero-based).
601      *
602      * @return The item label font.
603      */
604     public Font getItemLabelFont(int series, int item);
605
606     /**
607      * Returns the item label font for a series.
608      *
609      * @param series the series index (zero-based).
610      *
611      * @return The font.
612      *
613      * @deprecated Use getSeriesItemLabelPosition.
614      */
615     public Font getSeriesItemLabelFont(int series);
616
617     /**
618      * Sets the item label font for ALL series.
619      *
620      * @param font the font.
621      */
622     public void setItemLabelFont(Font font);
623     
624     /**
625      * Sets the item label font for a series.
626      *
627      * @param series the series index (zero-based).
628      * @param font the font.
629      */
630     public void setSeriesItemLabelFont(int series, Font font);
631
632     /**
633      * Returns the base item label font.
634      *
635      * @return The item label font.
636      */
637     public Font getBaseItemLabelFont();
638
639     /**
640      * Sets the base item label font.
641      *
642      * @param font the item label font.
643      */
644     public void setBaseItemLabelFont(Font font);
645     
646     /**
647      * Returns the positive item label position.
648      *
649      * @param row the row.
650      * @param column the column.
651      *
652      * @return The position.
653      */
654     public ItemLabelPosition getPositiveItemLabelPosition(int row, int column);
655     
656     /**
657      * Sets the positive item label position for ALL series.
658      *
659      * @param position the position (<code>null</code> permitted).
660      */
661     public void setPositiveItemLabelPosition(ItemLabelPosition position);
662     
663     /**
664      * Returns the negative item label position.
665      *
666      * @param row the row index.
667      * @param column the column index.
668      *
669      * @return The position.
670      */
671     public ItemLabelPosition getNegativeItemLabelPosition(int row, int column);
672     
673     /**
674      * Sets the negative item label position for ALL series.
675      *
676      * @param position the position.
677      */
678     public void setNegativeItemLabelPosition(ItemLabelPosition position);
679     
680     // ITEM URL GENERATOR
681
682     /**
683      * Returns the URL generator for an item.
684      *
685      * @param series the series index (zero-based).
686      * @param item the item index (zero-based).
687      *
688      * @return The item URL generator.
689      */
690     public CategoryURLGenerator getItemURLGenerator(int series, int item);
691
692     /**
693      * Returns the item URL generator for a series.
694      *
695      * @param series the series index (zero-based).
696      *
697      * @return The URL generator.
698      */
699     public CategoryURLGenerator getSeriesItemURLGenerator(int series);
700
701     /**
702      * Sets the item URL generator for ALL series.
703      *
704      * @param generator the generator.
705      */
706     public void setItemURLGenerator(CategoryURLGenerator generator);
707     
708     /**
709      * Sets the item URL generator for a series.
710      *
711      * @param series the series index (zero-based).
712      * @param generator the generator.
713      */
714     public void setSeriesItemURLGenerator(int series, CategoryURLGenerator generator);
715
716     /**
717      * Returns the base item URL generator.
718      *
719      * @return The item URL generator.
720      */
721     public CategoryURLGenerator getBaseItemURLGenerator();
722
723     /**
724      * Sets the base item URL generator.
725      *
726      * @param generator the item URL generator.
727      */
728     public void setBaseItemURLGenerator(CategoryURLGenerator generator);
729
730     /**
731      * Returns a legend item for a series.
732      *
733      * @param datasetIndex the dataset index (zero-based).
734      * @param series the series (zero-based index).
735      *
736      * @return the legend item.
737      */
738     public LegendItem getLegendItem(int datasetIndex, int series);
739
740     /**
741      * Draws a background for the data area.
742      *
743      * @param g2 the graphics device.
744      * @param plot the plot.
745      * @param dataArea the data area.
746      */
747     public void drawBackground(Graphics2D g2,
748                                CategoryPlot plot,
749                                Rectangle2D dataArea);
750
751     /**
752      * Draws an outline for the data area.
753      *
754      * @param g2 the graphics device.
755      * @param plot the plot.
756      * @param dataArea the data area.
757      */
758     public void drawOutline(Graphics2D g2,
759                             CategoryPlot plot,
760                             Rectangle2D dataArea);
761
762     /**
763      * Draws a single data item.
764      *
765      * @param g2 the graphics device.
766      * @param state state information for one chart.
767      * @param dataArea the data plot area.
768      * @param plot the plot.
769      * @param domainAxis the domain axis.
770      * @param rangeAxis the range axis.
771      * @param data the data.
772      * @param row the row index (zero-based).
773      * @param column the column index (zero-based).
774      */
775     public void drawItem(Graphics2D g2,
776                          CategoryItemRendererState state,
777                          Rectangle2D dataArea,
778                          CategoryPlot plot,
779                          CategoryAxis domainAxis,
780                          ValueAxis rangeAxis,
781                          CategoryDataset data,
782                          int row,
783                          int column);
784
785     /**
786      * Draws a grid line against the domain axis.
787      *
788      * @param g2 the graphics device.
789      * @param plot the plot.
790      * @param dataArea the area for plotting data (not yet adjusted for any 3D effect).
791      * @param value the value.
792      */
793     public void drawDomainGridline(Graphics2D g2,
794                                    CategoryPlot plot,
795                                    Rectangle2D dataArea,
796                                    double value);
797
798     /**
799      * Draws a grid line against the range axis.
800      *
801      * @param g2 the graphics device.
802      * @param plot the plot.
803      * @param axis the value axis.
804      * @param dataArea the area for plotting data (not yet adjusted for any 3D effect).
805      * @param value the value.
806      */
807     public void drawRangeGridline(Graphics2D g2,
808                                   CategoryPlot plot,
809                                   ValueAxis axis,
810                                   Rectangle2D dataArea,
811                                   double value);
812
813     /**
814      * Draws a line (or some other marker) to indicate a particular value on the range axis.
815      *
816      * @param g2 the graphics device.
817      * @param plot the plot.
818      * @param axis the value axis.
819      * @param marker the marker.
820      * @param dataArea the area for plotting data (not including 3D effect).
821      */
822     public void drawRangeMarker(Graphics2D g2,
823                                 CategoryPlot plot,
824                                 ValueAxis axis,
825                                 Marker marker,
826                                 Rectangle2D dataArea);
827
828 }
829

A to Z: JavaDoc & Examples

---

Daily Java News & Articles

---

Open Source Projects

---

Open Source Codes

---

Free Computer Books

---

Remove Frame

---

Popular Tags