Bug 378401: Implementation of time graph widget.

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / widgets / timegraph / widgets / TimeGraphTooltipHandler.java

/*****************************************************************************\r
 * Copyright (c) 2007 Intel Corporation, 2009, 2012 Ericsson.\r
 * All rights reserved. This program and the accompanying materials\r
 * are made available under the terms of the Eclipse Public License v1.0\r
 * which accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 *\r
 * Contributors:\r
 *   Intel Corporation - Initial API and implementation\r
 *   Vitaly A. Provodin, Intel - Initial API and implementation\r
 *   Alvaro Sanchez-Leon - Updated for TMF\r
 *   Patrick Tasse - Refactoring\r
 *\r
 *****************************************************************************/\r
package org.eclipse.linuxtools.tmf.ui.widgets.timegraph.widgets;\r
\r
import java.util.Iterator;\r
import java.util.Map;\r
\r
import org.eclipse.linuxtools.internal.tmf.ui.Messages;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.ITimeGraphProvider;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.model.ITimeEvent;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.model.ITimeGraphEntry;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.widgets.Utils.Resolution;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.widgets.Utils.TimeFormat;\r
import org.eclipse.swt.SWT;\r
import org.eclipse.swt.events.MouseAdapter;\r
import org.eclipse.swt.events.MouseEvent;\r
import org.eclipse.swt.events.MouseTrackAdapter;\r
import org.eclipse.swt.graphics.Point;\r
import org.eclipse.swt.graphics.Rectangle;\r
import org.eclipse.swt.layout.GridData;\r
import org.eclipse.swt.layout.GridLayout;\r
import org.eclipse.swt.widgets.Control;\r
import org.eclipse.swt.widgets.Display;\r
import org.eclipse.swt.widgets.Shell;\r
import org.eclipse.swt.widgets.Table;\r
import org.eclipse.swt.widgets.TableColumn;\r
import org.eclipse.swt.widgets.TableItem;\r
import org.eclipse.swt.widgets.Widget;\r
\r
\r
public class TimeGraphTooltipHandler {\r
\r
    private Shell _tipShell;\r
    private Table _tipTable;\r
    private TimeGraphItem _tipItem;\r
    private Point _tipPosition;\r
    private ITimeDataProvider _timeDataProvider;\r
    ITimeGraphProvider _utilImp = null;\r
\r
    public TimeGraphTooltipHandler(Shell parent, ITimeGraphProvider rUtilImpl,\r
            ITimeDataProvider timeProv) {\r
        final Display display = parent.getDisplay();\r
\r
        this._utilImp = rUtilImpl;\r
        this._timeDataProvider = timeProv;\r
        _tipShell = new Shell(parent, SWT.ON_TOP | SWT.TOOL);\r
        GridLayout gridLayout = new GridLayout();\r
        gridLayout.numColumns = 2;\r
        gridLayout.marginWidth = 2;\r
        gridLayout.marginHeight = 2;\r
        _tipShell.setLayout(gridLayout);\r
        GridData data = new GridData(GridData.BEGINNING, GridData.BEGINNING,\r
                true, true);\r
        _tipShell.setLayoutData(data);\r
        _tipShell.setBackground(display\r
                .getSystemColor(SWT.COLOR_INFO_BACKGROUND));\r
\r
        _tipTable = new Table(_tipShell, SWT.NONE);\r
        _tipTable.setForeground(display\r
                .getSystemColor(SWT.COLOR_INFO_FOREGROUND));\r
        _tipTable.setBackground(display\r
                .getSystemColor(SWT.COLOR_INFO_BACKGROUND));\r
        _tipTable.setHeaderVisible(false);\r
        _tipTable.setLinesVisible(false);\r
\r
        // tipTable.setLayoutData(new GridData(GridData.FILL_HORIZONTAL\r
        // | GridData.VERTICAL_ALIGN_CENTER));\r
    }\r
\r
    public void activateHoverHelp(final Control control) {\r
        //FIXME: remove old listeners\r
        control.addMouseListener(new MouseAdapter() {\r
            @Override\r
            public void mouseDown(MouseEvent e) {\r
                if (_tipShell.isVisible())\r
                    _tipShell.setVisible(false);\r
            }\r
        });\r
\r
        control.addMouseTrackListener(new MouseTrackAdapter() {\r
            @Override\r
            public void mouseExit(MouseEvent e) {\r
                if (_tipShell.isVisible())\r
                    _tipShell.setVisible(false);\r
                _tipItem = null;\r
\r
            }\r
\r
            private void addItem(String name, String value) {\r
                TableItem line = new TableItem(_tipTable, SWT.NONE);\r
                line.setText(0, name);\r
                line.setText(1, value);\r
            }\r
\r
            private void fillValues(Point pt, TimeGraphControl threadStates, TimeGraphItem item) {\r
                if (item == null) {\r
                    return;\r
                }\r
                if (item._trace.getTimeEventsIterator() == null) {\r
                    addItem(Messages.TmfTimeTipHandler_TRACE_GROUP_NAME, item.toString());\r
                    addItem(Messages.TmfTimeTipHandler_NUMBER_OF_TRACES, "" + item.children.size()); //$NON-NLS-1$\r
                } else {\r
                    ITimeGraphEntry thrd = item._trace;\r
                    ITimeEvent threadEvent = Utils.findEvent(thrd, threadStates.getTimeAtX(pt.x), 2);\r
                    ITimeEvent nextEvent = Utils.findEvent(thrd, threadStates.getTimeAtX(pt.x), 1);\r
                    // thread name\r
                    addItem(Messages.TmfTimeTipHandler_TRACE_NAME, thrd.getName());\r
                    // class name\r
                    String traceClass = _utilImp.getTraceClassName(thrd);\r
                    if (traceClass != null) {\r
                        addItem(Messages.TmfTimeTipHandler_TRACE_CLASS_NAME, traceClass);\r
                    }\r
                    // thread state\r
                    String state = _utilImp.getEventName(threadEvent);\r
                    if (state != null) {\r
                        addItem(Messages.TmfTimeTipHandler_TRACE_STATE, state);\r
                    }\r
\r
                    // This block receives a\r
                    // list of <String, String> values to be added to the tip\r
                    // table\r
                    Map<String, String> eventAddOns = _utilImp.getEventHoverToolTipInfo(threadEvent);\r
                    if (eventAddOns != null) {\r
                        for (Iterator<String> iter = eventAddOns.keySet().iterator(); iter.hasNext();) {\r
                            String message = (String) iter.next();\r
                            addItem(message, eventAddOns.get(message));\r
                        }\r
                    }\r
\r
                    long eventStartTime = -1;\r
                    long eventDuration = -1;\r
                    long eventEndTime = -1;\r
\r
                    if (threadEvent != null) {\r
                        eventStartTime = threadEvent.getTime();\r
                        eventDuration = threadEvent.getDuration();\r
                        if (eventDuration < 0 && nextEvent != null) {\r
                            eventEndTime = nextEvent.getTime();\r
                            eventDuration = eventEndTime - eventStartTime;\r
                        } else {\r
                            eventEndTime = eventStartTime + eventDuration;\r
                        }\r
                    }\r
\r
                    // TODO: Check if we need "format"					\r
                    //					TimeFormat format = TimeFormat.RELATIVE;\r
                    Resolution res = Resolution.NANOSEC;\r
                    if (_timeDataProvider.isCalendarFormat()) {\r
                        //						format = TimeFormat.ABSOLUTE; // Absolute format\r
                        //														// (calendar)\r
                        // Add Date\r
                        addItem(Messages.TmfTimeTipHandler_TRACE_DATE, eventStartTime > -1 ?\r
                                Utils.formatDate(eventStartTime)\r
                                : "?"); //$NON-NLS-1$\r
                        if (eventDuration > 0) {\r
                            addItem(Messages.TmfTimeTipHandler_TRACE_START_TIME, eventStartTime > -1 ?\r
                                    Utils.formatTime(eventStartTime, TimeFormat.ABSOLUTE, res)\r
                                    : "?"); //$NON-NLS-1$\r
\r
                            addItem(Messages.TmfTimeTipHandler_TRACE_STOP_TIME, eventEndTime > -1 ?\r
                                    Utils.formatTime(eventEndTime, TimeFormat.ABSOLUTE, res)\r
                                    : "?"); //$NON-NLS-1$\r
                        } else {\r
                            addItem(Messages.TmfTimeTipHandler_TRACE_EVENT_TIME, eventStartTime > -1 ?\r
                                    Utils.formatTime(eventStartTime, TimeFormat.ABSOLUTE, res)\r
                                    : "?"); //$NON-NLS-1$\r
                        }\r
                    } else {\r
                        if (eventDuration > 0) {\r
                            addItem(Messages.TmfTimeTipHandler_TRACE_START_TIME, eventStartTime > -1 ?\r
                                    Utils.formatTime(eventStartTime, TimeFormat.RELATIVE, res)\r
                                    : "?"); //$NON-NLS-1$\r
\r
                            addItem(Messages.TmfTimeTipHandler_TRACE_STOP_TIME, eventEndTime > -1 ?\r
                                    Utils.formatTime(eventEndTime, TimeFormat.RELATIVE, res)\r
                                    : "?"); //$NON-NLS-1$\r
                        } else {\r
                            addItem(Messages.TmfTimeTipHandler_TRACE_EVENT_TIME, eventStartTime > -1 ?\r
                                    Utils.formatTime(eventStartTime, TimeFormat.RELATIVE, res)\r
                                    : "?"); //$NON-NLS-1$\r
                        }\r
                    }\r
\r
                    if (eventDuration > 0) {\r
                        // Duration in relative format in any case\r
                        addItem(Messages.TmfTimeTipHandler_DURATION, eventDuration > -1 ?\r
                                Utils.formatTime(eventDuration, TimeFormat.RELATIVE, res)\r
                                : "?"); //$NON-NLS-1$\r
                    }\r
                }\r
            }\r
\r
            @Override\r
            public void mouseHover(MouseEvent event) {\r
                Point pt = new Point(event.x, event.y);\r
                Widget widget = event.widget;\r
                TimeGraphItem item = null;\r
                if (widget instanceof TimeGraphControl) {\r
                    TimeGraphControl threadStates = (TimeGraphControl) widget;\r
                    item = (TimeGraphItem) threadStates.getItem(pt);\r
                    _tipTable.remove(0, _tipTable.getItemCount() - 1);\r
                    new TableColumn(_tipTable, SWT.NONE);\r
                    new TableColumn(_tipTable, SWT.NONE);\r
                    fillValues(pt, threadStates, item);\r
                    _tipTable.getColumn(0).setWidth(200);\r
                    _tipTable.getColumn(1).pack();\r
                    _tipTable.setSize(_tipTable.computeSize(SWT.DEFAULT, 200));\r
                    _tipShell.pack();\r
                } else if (widget == null) {\r
                    _tipShell.setVisible(false);\r
                    _tipItem = null;\r
                    return;\r
                }\r
                if (item == _tipItem)\r
                    return;\r
                _tipItem = item;\r
                _tipPosition = control.toDisplay(pt);\r
                _tipShell.pack();\r
                setHoverLocation(_tipShell, _tipPosition);\r
                _tipShell.setVisible(true);\r
            }\r
        });\r
    }\r
\r
    private void setHoverLocation(Shell shell, Point position) {\r
        Rectangle displayBounds = shell.getDisplay().getBounds();\r
        Rectangle shellBounds = shell.getBounds();\r
        shellBounds.x = Math.max(Math.min(position.x, displayBounds.width\r
                - shellBounds.width), 0);\r
        shellBounds.y = Math.max(Math.min(position.y + 16, displayBounds.height\r
                - shellBounds.height), 0);\r
        shell.setBounds(shellBounds);\r
    }\r
\r
}