Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 59043d8d3ded1805045c912fdc42491f61f348d8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/*******************************************************************************
 * Copyright (c) 2011, 2012 Ericsson
 * 
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *   Mathieu Denis      (mathieu.denis@polymtl.ca)  - Initial API and Implementation
 *******************************************************************************/

package org.eclipse.linuxtools.tmf.ui.views.statistics.model;

import org.eclipse.jface.viewers.ColumnLabelProvider;
import org.eclipse.jface.viewers.ViewerComparator;
import org.eclipse.linuxtools.tmf.ui.views.statistics.model.TmfBaseColumnData.ITmfColumnPercentageProvider;

/**
 * Provide the basic interface to create a statistics column for the statistics table tree.
 * 
 *  @version 1.0
 *  @author Mathieu Denis
 */
public interface ITmfStatisticsColumnData {

    /**
     * Return the column name.
     * @return the name of the column.
     */
    public String getHeader();
    
    /**
     * Return the width of the column at the creation.
     * @return the width of the column.
     */
    public int getWidth();
    
    /**
     * Return the alignment of the column.
     * @see org.eclipse.swt.SWT
     * @return an integer representing the alignment inside the column.
     */
    public int getAlignment();
    
    /**
     * Provide the text to show in the tooltip when the cursor comes over the column header.
     * @return text to show in the tooltip
     */
    public String getTooltip();
    
    /**
     * Return the labelProvider which provides the information to put in column cells.
     * @return a ColumnLabelProvider.
     */
    public ColumnLabelProvider getLabelProvider();
    
    /**
     * Return a ViewerComparator used to sort viewer's contents.
     * @return the comparator.
     */
    public ViewerComparator getComparator();
    
    /**
     * Return the provider of the percentage.
     * Used to draw bar charts in columns.
     * @return the percentageProvider.
     */
    public ITmfColumnPercentageProvider getPercentageProvider();
}

Back to the top