Internalize lttng.core APIs

[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng.ui / src / org / eclipse / linuxtools / lttng / ui / views / latency / listeners / TooltipListener.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
 *   Bernd Hufmann - Changed display interface implementation\r
 *******************************************************************************/\r
package org.eclipse.linuxtools.lttng.ui.views.latency.listeners;\r
\r
import org.eclipse.linuxtools.lttng.ui.views.latency.AbstractViewer;\r
import org.eclipse.linuxtools.lttng.ui.views.latency.Messages;\r
\r
/**\r
 * <b><u>TooltipListener</u></b>\r
 * <p>\r
 * Tooltip listener, displays the event count for each latency selected by the mouse click area on histogram.\r
 * \r
 * @author Ali Jawhar\r
 */\r
public class TooltipListener extends AbstractMouseTrackListener {\r
\r
    // ------------------------------------------------------------------------\r
    // Attributes\r
    // ------------------------------------------------------------------------\r
\r
    /**\r
     * A reference to the observed view.\r
     */\r
    protected AbstractViewer fView;\r
\r
    /**\r
     * A reference to the HistogramPaintListener.\r
     */\r
    protected HistogramPaintListener fHistogram;\r
\r
    /**\r
     * Is the mouse over the warning icon, indicating that a bar is higher than the draw area due to zooming ?\r
     */\r
    protected boolean fDisplayWarning = false;\r
\r
    // ------------------------------------------------------------------------\r
    // Constructors\r
    // ------------------------------------------------------------------------\r
    \r
    /**\r
     * Constructor.\r
     * @param view\r
     *            A reference to the observed view.\r
     * @param histogramPaintListener\r
     *            A reference to the histogram's paintListener.\r
     */\r
    public TooltipListener(AbstractViewer view, HistogramPaintListener histogramPaintListener) {\r
        fView = view;\r
        fHistogram = histogramPaintListener;\r
    }\r
\r
    // ------------------------------------------------------------------------\r
    // Operations\r
    // ------------------------------------------------------------------------\r
\r
    /*\r
     * (non-Javadoc)\r
     * @see org.eclipse.linuxtools.lttng.ui.views.latency.listeners.AbstractMouseTrackListener#display()\r
     */\r
    @Override\r
    protected void display() {\r
        displayWarningTooltip();\r
        displayTooltip();\r
    }\r
\r
    // ------------------------------------------------------------------------\r
    // Helper Functions\r
    // ------------------------------------------------------------------------\r
    \r
    /**\r
     * Displays a tooltip if the mouse is over the warning icon indication that a bar cannot be draw entirely due to the\r
     * zoom factor.\r
     */\r
    protected void displayWarningTooltip() {\r
        if (fHistogram.barIsClipped() && fMouseX > 5 && fMouseX < 21 && fMouseY > 3 && fMouseY < 18) {\r
            fView.setToolTipText(Messages.LatencyView_ClippingWarning);\r
            fDisplayWarning = true;\r
        } else {\r
            fDisplayWarning = false;\r
        }\r
    }\r
\r
    /**\r
     * Displays the tooltip showing the details of the histogram bar pointed by the mouse.\r
     */\r
    protected void displayTooltip() {\r
        if (!fDisplayWarning)\r
            fView.setToolTipText(fHistogram.formatToolTipLabel(fMouseX, fMouseY));\r
    }\r
}