Commit | Line | Data |
---|---|---|
79e08fd0 | 1 | /******************************************************************************* |
b544077e | 2 | * Copyright (c) 2011, 2012 Ericsson |
79e08fd0 BH |
3 | * |
4 | * All rights reserved. This program and the accompanying materials are | |
5 | * made available under the terms of the Eclipse Public License v1.0 which | |
6 | * accompanies this distribution, and is available at | |
7 | * http://www.eclipse.org/legal/epl-v10.html | |
8 | * | |
9 | * Contributors: | |
10 | * Mathieu Denis (mathieu.denis@polymtl.ca) - Initial API and Implementation | |
11 | *******************************************************************************/ | |
12 | ||
13 | package org.eclipse.linuxtools.tmf.ui.views.statistics.model; | |
14 | ||
15 | import org.eclipse.jface.viewers.ColumnLabelProvider; | |
16 | import org.eclipse.jface.viewers.ViewerComparator; | |
17 | import org.eclipse.linuxtools.tmf.ui.views.statistics.model.TmfBaseColumnData.ITmfColumnPercentageProvider; | |
18 | ||
19 | /** | |
b544077e BH |
20 | * Provide the basic interface to create a statistics column for the statistics table tree. |
21 | * | |
22 | * @version 1.0 | |
23 | * @author Mathieu Denis | |
79e08fd0 BH |
24 | */ |
25 | public interface ITmfStatisticsColumnData { | |
26 | ||
27 | /** | |
28 | * Return the column name. | |
29 | * @return the name of the column. | |
30 | */ | |
31 | public String getHeader(); | |
32 | ||
33 | /** | |
34 | * Return the width of the column at the creation. | |
35 | * @return the width of the column. | |
36 | */ | |
37 | public int getWidth(); | |
38 | ||
39 | /** | |
40 | * Return the alignment of the column. | |
41 | * @see org.eclipse.swt.SWT | |
42 | * @return an integer representing the alignment inside the column. | |
43 | */ | |
44 | public int getAlignment(); | |
45 | ||
46 | /** | |
47 | * Provide the text to show in the tooltip when the cursor comes over the column header. | |
48 | * @return text to show in the tooltip | |
49 | */ | |
50 | public String getTooltip(); | |
51 | ||
52 | /** | |
53 | * Return the labelProvider which provides the information to put in column cells. | |
54 | * @return a ColumnLabelProvider. | |
55 | */ | |
56 | public ColumnLabelProvider getLabelProvider(); | |
57 | ||
58 | /** | |
59 | * Return a ViewerComparator used to sort viewer's contents. | |
60 | * @return the comparator. | |
61 | */ | |
62 | public ViewerComparator getComparator(); | |
63 | ||
64 | /** | |
65 | * Return the provider of the percentage. | |
66 | * Used to draw bar charts in columns. | |
67 | * @return the percentageProvider. | |
68 | */ | |
69 | public ITmfColumnPercentageProvider getPercentageProvider(); | |
70 | } |