Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
HCToolTipGenerator |
|
| 1.0;1 |
1 | /* ======================================================================= | |
2 | * A visualisation library extension for JFreeChart. Please see JFreeChart | |
3 | * for further information. | |
4 | * ======================================================================= | |
5 | * Copyright (C) 2006 University of Helsinki, Department of Computer Science | |
6 | * | |
7 | * This library is free software; you can redistribute it and/or | |
8 | * modify it under the terms of the GNU Lesser General Public | |
9 | * License as published by the Free Software Foundation; either | |
10 | * version 2.1 of the License, or (at your option) any later version. | |
11 | * | |
12 | * This library is distributed in the hope that it will be useful, | |
13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
15 | * Lesser General Public License for more details. | |
16 | * | |
17 | * You should have received a copy of the GNU Lesser General Public | |
18 | * License along with this library; if not, write to the Free Software | |
19 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
20 | * ----------------------------- | |
21 | * Contact: ohtu@cs.helsinki.fi | |
22 | * ----------------------------- | |
23 | * | |
24 | */ | |
25 | ||
26 | package org.jfree.chart.labels; | |
27 | ||
28 | import org.jfree.chart.plot.HCTreeNodeInfo; | |
29 | import org.jfree.data.hc.HeatMap; | |
30 | import org.jfree.data.hc.DataRange; | |
31 | ||
32 | /** | |
33 | * Interface for a tooltip generator for plots that use data from an | |
34 | * {@link HCPlot}. | |
35 | */ | |
36 | public interface HCToolTipGenerator { | |
37 | ||
38 | /** | |
39 | * Generates a tooltip text string for a particular clustering tree node. | |
40 | * | |
41 | * @param node HCTreeNodeInfo for the node used. | |
42 | * | |
43 | * @return The tooltip text. | |
44 | */ | |
45 | public String generateToolTip(HCTreeNodeInfo node); | |
46 | ||
47 | /** | |
48 | * Generates a tooltip text string for a particular heatmap block. | |
49 | * | |
50 | * @param heatmap the HeatMap. | |
51 | * @param columnRange the columns displayed in the block. | |
52 | * @param rowRange the rows displayed in the block. | |
53 | * | |
54 | * @return The tooltip text. | |
55 | */ | |
56 | public String generateToolTip( | |
57 | HeatMap heatmap, | |
58 | DataRange columnRange, | |
59 | DataRange rowRange | |
60 | ); | |
61 | ||
62 | } | |
63 | ||
64 |