org.eclipse.linuxtools.tmf.ui/src/org/eclipse/linuxtools/tmf/ui/views/uml2sd/DrawableToolTip.java

   1 /**********************************************************************
   2  * Copyright (c) 2005, 2013 IBM Corporation, Ericsson
   3  * All rights reserved.   This program and the accompanying materials
   4  * are made available under the terms of the Eclipse Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/epl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM - Initial API and implementation
  10  *     Bernd Hufmann - Updated for TMF
  11  **********************************************************************/
  12
  13 package org.eclipse.linuxtools.tmf.ui.views.uml2sd;
  14
  15 import org.eclipse.linuxtools.tmf.core.timestamp.ITmfTimestamp;
  16 import org.eclipse.linuxtools.tmf.core.timestamp.TmfTimeRange;
  17 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.util.Messages;
  18 import org.eclipse.swt.SWT;
  19 import org.eclipse.swt.events.PaintEvent;
  20 import org.eclipse.swt.events.PaintListener;
  21 import org.eclipse.swt.graphics.Color;
  22 import org.eclipse.swt.graphics.Point;
  23 import org.eclipse.swt.layout.RowLayout;
  24 import org.eclipse.swt.widgets.Composite;
  25 import org.eclipse.swt.widgets.Display;
  26 import org.eclipse.swt.widgets.Shell;
  27
  28 /**
  29  * <p>
  30  * This class is used to reproduce the same tooltip behavior on Windows and Linux when the mouse move hover the time
  31  * compression bar used to display elapsed time using a tooltip. The tooltip is composed of 2 parts, the text value and
  32  * below, a scale to visually locate the value in a time range (usually the minimum an maximum elapsed time in the whole
  33  * diagram)
  34  * </p>
  35  *
  36  * @version 1.0
  37  * @author sveyrier
  38  */
  39 public class DrawableToolTip implements PaintListener {
  40
  41     // ------------------------------------------------------------------------
  42     // Attributes
  43     // ------------------------------------------------------------------------
  44
  45     /**
  46      * The parent control where the tooltip must be drawn
  47      */
  48     private Composite fParent = null;
  49     /**
  50      * The tooltip shell
  51      */
  52     private Shell fToolTipShell = null;
  53     /**
  54      * The Time range data.
  55      */
  56     private TmfTimeRange fMinMaxRange;
  57     /**
  58      * The current time.
  59      */
  60     private ITmfTimestamp fCurrentValue;
  61     /**
  62      * The horizontal margin used for drawing.
  63      */
  64     private static int fHorMargin = 10;
  65     /**
  66      * The vertical margin used for drawing.
  67      */
  68     private static int fVertMargin = 10;
  69     /**
  70      * The minimum text scale margin.
  71      */
  72     private static int fTextScaleMargin = 20;
  73     /**
  74      * The length of the text scale.
  75      */
  76     private static int fScaleLength = 100;
  77     /**
  78      * The text to display
  79      */
  80     private String fMessage;
  81     /**
  82      * The color array used to represent the 10 time range slices
  83      */
  84     private Color[] fColors;
  85
  86     // ------------------------------------------------------------------------
  87     // Constructors
  88     // ------------------------------------------------------------------------
  89
  90     /**
  91      * Creates a drawable tool tip instance.
  92      *
  93      * @param parent The parent composite.
  94      */
  95     public DrawableToolTip(Composite parent) {
  96         fParent = parent;
  97         fToolTipShell = new Shell(fParent.getShell(), SWT.ON_TOP);
  98         fToolTipShell.setLayout(new RowLayout());
  99         fToolTipShell.setBackground(Display.getDefault().getSystemColor(SWT.COLOR_INFO_BACKGROUND));
 100         fToolTipShell.addPaintListener(this);
 101         fToolTipShell.setSize(200, 50);
 102
 103         fColors = new Color[10];
 104         fColors[0] = new Color(Display.getDefault(), 255, 229, 229);
 105         fColors[1] = new Color(Display.getDefault(), 255, 204, 204);
 106         fColors[2] = new Color(Display.getDefault(), 255, 178, 178);
 107         fColors[3] = new Color(Display.getDefault(), 255, 153, 153);
 108         fColors[4] = new Color(Display.getDefault(), 255, 127, 127);
 109         fColors[5] = new Color(Display.getDefault(), 255, 102, 102);
 110         fColors[6] = new Color(Display.getDefault(), 255, 76, 76);
 111         fColors[7] = new Color(Display.getDefault(), 255, 51, 51);
 112         fColors[8] = new Color(Display.getDefault(), 255, 25, 25);
 113         fColors[9] = new Color(Display.getDefault(), 255, 0, 0);
 114     }
 115
 116     // ------------------------------------------------------------------------
 117     // Methods
 118     // ------------------------------------------------------------------------
 119     /**
 120      * Returns the message to display.
 121      *
 122      * @return the message to display.
 123      */
 124     public String getText() {
 125         return fMessage;
 126     }
 127
 128     /**
 129      * Returns teh current time to display.
 130      *
 131      * @return the current time to display
 132      */
 133     public String getAccessibleText() {
 134         return fCurrentValue.toString();
 135     }
 136
 137     /**
 138      * Returns the horizontal margin.
 139      *
 140      * @return the horizontal margin.
 141      */
 142     protected static int getHorizontalMargin() {
 143         return fHorMargin;
 144     }
 145
 146     /**
 147      * Sets the horizontal margin.
 148      *
 149      * @param margin The margin to set.
 150      */
 151     protected static void setHorizontalMargin(int margin) {
 152         fHorMargin = margin;
 153     }
 154
 155     /**
 156      * Returns the vertical margin.
 157      *
 158      * @return the vertical margin.
 159      */
 160     protected static int getVerticalMargin() {
 161         return fVertMargin;
 162     }
 163
 164     /**
 165      * Sets the vertical margin.
 166      *
 167      * @param margin The margin to set.
 168      */
 169     protected static void setVerticalMargin(int margin) {
 170         fVertMargin = margin;
 171     }
 172
 173     /**
 174      * Returns the text scale margin.
 175      *
 176      * @return the text scale margin.
 177      */
 178     protected static int getTextScaleMargin() {
 179         return fTextScaleMargin;
 180     }
 181
 182     /**
 183      * Sets the text scale margin.
 184      * @param textScaleMargin The margin to set.
 185      */
 186     protected static void setTestScaleMargin(int textScaleMargin) {
 187         fTextScaleMargin = textScaleMargin;
 188     }
 189
 190     /**
 191      * Returns the scale length.
 192      *
 193      * @return the scale length.
 194      */
 195     protected static int getScaleLength() {
 196         return fScaleLength;
 197     }
 198
 199     /**
 200      * Sets the scale length.
 201      *
 202      * @param scaleLength The scale length to set.
 203      */
 204     protected static void setScaleLength(int scaleLength) {
 205         fScaleLength = scaleLength;
 206     }
 207
 208     /**
 209      * Display the tooltip using the given time range(min,max) the current value and the time unit The tooltip will stay
 210      * on screen until it is told otherwise
 211      *
 212      * @param value the current in the scale
 213      * @param min the scale min
 214      * @param max the scale max
 215      * @since 2.0
 216      */
 217     public void showToolTip(ITmfTimestamp value, ITmfTimestamp min, ITmfTimestamp max) {
 218         fMinMaxRange = new TmfTimeRange(min, max);
 219         fCurrentValue = value;
 220
 221         int w = fToolTipShell.getBounds().width;
 222         int h = fToolTipShell.getBounds().height;
 223         Point hr = Display.getDefault().getCursorLocation();
 224         fToolTipShell.setBounds(hr.x, hr.y + 26, w, h);
 225         fToolTipShell.setVisible(true);
 226     }
 227
 228     /**
 229      * Hide the tooltip.
 230      */
 231     public void hideToolTip() {
 232         fToolTipShell.setVisible(false);
 233     }
 234
 235     /**
 236      * Disposes the system resource used by this kind of toolTips (a colors array essentially)
 237      */
 238     public void dispose() {
 239         for (int i = 0; i < fColors.length; i++) {
 240             fColors[i].dispose();
 241         }
 242     }
 243
 244     @Override
 245     public void paintControl(PaintEvent event) {
 246         fMessage = Messages.SequenceDiagram_Delta + " " +  fCurrentValue.toString(); //$NON-NLS-1$
 247         Point size = event.gc.textExtent(fMessage);
 248         if (size.x < fScaleLength) {
 249             size.x = fScaleLength;
 250         }
 251         event.gc.drawText(fMessage, fHorMargin, fVertMargin, true);
 252         event.gc.drawLine(fHorMargin, fVertMargin + fTextScaleMargin + size.y, fHorMargin + fScaleLength, fVertMargin + fTextScaleMargin + size.y);
 253
 254         int step = fScaleLength / 10;
 255
 256         // double gr = (max - min) / 10;
 257         ITmfTimestamp minMaxdelta = fMinMaxRange.getEndTime().getDelta(fMinMaxRange.getStartTime());
 258         double gr = (minMaxdelta.getValue()) / (double) 10;
 259
 260         // double delta = currentValue-min;
 261         ITmfTimestamp delta = fCurrentValue.getDelta(fMinMaxRange.getStartTime());
 262         long absDelta = Math.abs(delta.getValue());
 263
 264         int colIndex = 0;
 265         if (gr != 0) {
 266             // colIndex = Math.round((float)(Math.log(1+delta)/gr));
 267             colIndex = Math.round((float) (absDelta / gr));
 268             if (colIndex > fColors.length) {
 269                 colIndex = fColors.length;
 270             } else if (colIndex <= 1) {
 271                 colIndex = 1;
 272             }
 273         } else {
 274             colIndex = 1;
 275         }
 276
 277         for (int i = 0; i <= 10; i++) {
 278             if (i < 10) {
 279                 event.gc.setBackground(fColors[i]);
 280             }
 281             if ((i < colIndex) && (i < 10)) {
 282                 event.gc.fillRectangle(fHorMargin + i * step, fVertMargin + fTextScaleMargin + size.y - 5, step, 11);
 283             }
 284             if (i == 0) {
 285                 event.gc.drawText(Messages.SequenceDiagram_Min, fHorMargin, size.y + 2 * fVertMargin + fTextScaleMargin, true);
 286             }
 287             if (i == 0) {
 288                 int len = event.gc.textExtent(Messages.SequenceDiagram_Max).x;
 289                 event.gc.drawText(Messages.SequenceDiagram_Max, fHorMargin + fScaleLength - len + 1, size.y + 2 * fVertMargin + fTextScaleMargin, true);
 290             }
 291             int lineWidth = 10;
 292             if ((i == 0) || (i == 10)) {
 293                 lineWidth = 14;
 294             }
 295             event.gc.drawLine(fHorMargin + i * step, fVertMargin + fTextScaleMargin + size.y - lineWidth / 2, fHorMargin + i * step, fVertMargin + fTextScaleMargin + size.y + lineWidth / 2);
 296         }
 297         fToolTipShell.setSize(size.x + 2 * fHorMargin + 2, 2 * size.y + 3 * fVertMargin + fTextScaleMargin);
 298     }
 299 }