tmf: Use tabs in statistics view for each traces

[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng.ui / src / org / eclipse / linuxtools / internal / lttng / ui / views / latency / AbstractViewer.java

/*******************************************************************************\r
 * Copyright (c) 2010, 2011 Ericsson\r
 * \r
 * All rights reserved. This program and the accompanying materials are\r
 * made available under the terms of the Eclipse Public License v1.0 which\r
 * accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 * \r
 * Contributors:\r
 *   Philippe Sawicki (INF4990.A2010@gmail.com)   - Initial API and implementation\r
 *   Mathieu Denis    (mathieu.denis55@gmail.com) - Refactored code\r
 *   Bernd Hufmann - Adapted to new model-view-controller design\r
 *******************************************************************************/\r
package org.eclipse.linuxtools.internal.lttng.ui.views.latency;\r
\r
import org.eclipse.linuxtools.internal.lttng.ui.views.latency.listeners.AbstractMouseListener;\r
import org.eclipse.linuxtools.internal.lttng.ui.views.latency.listeners.AbstractMouseTrackListener;\r
import org.eclipse.linuxtools.internal.lttng.ui.views.latency.listeners.AbstractPaintListener;\r
import org.eclipse.linuxtools.internal.lttng.ui.views.latency.listeners.ZoomListener;\r
import org.eclipse.linuxtools.tmf.ui.views.distribution.model.IBaseDistributionModel;\r
import org.eclipse.swt.SWT;\r
import org.eclipse.swt.SWTException;\r
import org.eclipse.swt.widgets.Canvas;\r
import org.eclipse.swt.widgets.Composite;\r
import org.eclipse.swt.widgets.Display;\r
\r
/**\r
 * <b><u>AbstractViewer</u></b>\r
 * <p>\r
 * Abstract viewer.\r
 * \r
 * @author Philippe Sawicki\r
 */\r
public abstract class AbstractViewer extends Canvas {\r
\r
    // ------------------------------------------------------------------------\r
    // Attributes\r
    // ------------------------------------------------------------------------\r
\r
    /**\r
     * Parent composite node.\r
     */\r
    protected Composite fParent;\r
\r
    /**\r
     * Paint listener.\r
     */\r
    protected AbstractPaintListener fPaintListener;\r
\r
    /**\r
     * Zoom listener, to zoom in and out of a graph using the scroll wheel.\r
     */\r
    protected ZoomListener fZoomListener;\r
\r
    /**\r
     * Tool tip listener.\r
     */\r
    protected AbstractMouseTrackListener fMouseTraceListener;\r
\r
    /**\r
     * Mouse listener\r
     */\r
    protected AbstractMouseListener fMouseListener;\r
\r
    // ------------------------------------------------------------------------\r
    // Constructor\r
    // ------------------------------------------------------------------------\r
    \r
    /**\r
     * Constructor.\r
     * @param parent\r
     *            The parent composite node.\r
     * @param style\r
     *            The SWT style to use to render the view.\r
     */\r
    public AbstractViewer(Composite parent, int style) {\r
        super(parent, style);\r
\r
        fParent = parent;\r
    }\r
\r
    // ------------------------------------------------------------------------\r
    // Abstract interface\r
    // ------------------------------------------------------------------------\r
    \r
    /**\r
     * Clears the view.\r
     */\r
    abstract public void clear();\r
\r
    /**\r
     * Clears the background of the view but keeps min and max values.\r
     */\r
    abstract public void clearBackground();\r
\r
    /**\r
     * Method to increase bar width\r
     */\r
    abstract public void increaseBarWidth();\r
    \r
    /**\r
     * Method to decrease bar width\r
     */\r
    abstract public void decreaseBarWidth();\r
\r
    /**\r
     * Return data model\r
     */\r
    abstract public IBaseDistributionModel getModel();\r
    \r
    \r
    // ------------------------------------------------------------------------\r
    // Accessors\r
    // ------------------------------------------------------------------------\r
\r
    /**\r
     * Returns the zoom factor for the canvas.\r
     * @return The zoom factor for the canvas.\r
     */\r
    public int getZoomFactor() {\r
        if (fZoomListener != null) {\r
            return fZoomListener.getZoomFactor();\r
        } else {\r
            return 1;\r
        }\r
    }\r
\r
    /**\r
     * Returns the zoom increment for the canvas.\r
     * @return The zoom increment for the canvas.\r
     */\r
    public int getZoomIncrement() {\r
        if (fZoomListener != null) {\r
            return fZoomListener.getZoomIncrement();\r
        } else {\r
            return 1;\r
        }\r
    }\r
\r
    \r
    // ------------------------------------------------------------------------\r
    // Operations\r
    // ------------------------------------------------------------------------\r
    \r
    /**\r
     * Draw horizontal label each "nbTicks" ticks.\r
     * @param nbTicks\r
     *            The draw interval.\r
     */\r
    public void setDrawLabelEachNTicks(int nbTicks) {\r
        fPaintListener.setDrawLabelEachNTicks(nbTicks);\r
    }\r
\r
    /**\r
     * Sets the title of the graph.\r
     * @param graphTitle\r
     *            The title of the graph.\r
     */\r
    public void setGraphTitle(String graphTitle) {\r
        fPaintListener.setGraphTitle(graphTitle);\r
    }\r
\r
    /**\r
     * Sets the horizontal axis label.\r
     * @param xLabel\r
     *            The horizontal axis label.\r
     * @param offset\r
     *            The horizontal axis draw offset (in pixels).\r
     */\r
    public void setXAxisLabel(String xLabel, int offset) {\r
        fPaintListener.setXAxisLabel(xLabel, offset);\r
    }\r
\r
    /**\r
     * Sets the vertical axis label.\r
     * @param yLabel\r
     *            The vertical axis label.\r
     */\r
    public void setYAxisLabel(String yLabel) {\r
        fPaintListener.setYAxisLabel(yLabel);\r
    }\r
\r
    /**\r
     * Asks for the view to be redrawn, synchronously or asynchronously.\r
     * @param asyncRedraw\r
     *            If "true", the view will be redrawn asynchronously, otherwise it will be redraw synchronously.\r
     */\r
    public void askForRedraw(boolean asyncRedraw) {\r
        if (asyncRedraw == true) {\r
            Display.getDefault().asyncExec(new Runnable() {\r
                @Override\r
                public void run() {\r
                    try {\r
                        redraw();\r
                    } catch (SWTException e) {\r
                        // ...\r
                    }\r
                }\r
            });\r
        } else {\r
            Display.getDefault().syncExec(new Runnable() {\r
                @Override\r
                public void run() {\r
                    try {\r
                        redraw();\r
                    } catch (SWTException e) {\r
                        // ...\r
                    }\r
                }\r
            });\r
        }\r
    }\r
\r
    /**\r
     * Asks for the view to be redrawn (asynchronously).\r
     */\r
    public void askForRedraw() {\r
        askForRedraw(true);\r
    }\r
\r
    /**\r
     * Redraws the title after a zoom to display the new zoom factor.\r
     */\r
    public void redrawTitle() {\r
        fPaintListener.paintGraphTitle();\r
    }\r
\r
    /**\r
     * Removes the view's listeners before disposing of it.\r
     */\r
    @Override\r
    public void dispose() {\r
        try {\r
            if (fPaintListener != null) {\r
                removePaintListener(fPaintListener);\r
                fPaintListener = null;\r
            }\r
            if (fZoomListener != null) {\r
                removeListener(SWT.MouseWheel, fZoomListener);\r
                fZoomListener = null;\r
            }\r
            if (fMouseTraceListener != null) {\r
                removeListener(SWT.MouseMove, fMouseTraceListener);\r
                fMouseTraceListener = null;\r
            }\r
        } catch (SWTException e) {\r
            // This exception will be thrown if the user closes the view\r
            // while it is receiving data from the Analyzer.\r
\r
            // ...\r
        }\r
\r
        super.dispose();\r
    }\r
}