org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/views/uml2sd/core/ExecutionOccurrence.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.tracecompass.tmf.ui.views.uml2sd.core;
  14
  15 import java.util.Arrays;
  16
  17 import org.eclipse.tracecompass.tmf.core.timestamp.ITmfTimestamp;
  18 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.drawings.IColor;
  19 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.drawings.IGC;
  20 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.drawings.IImage;
  21 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.preferences.ISDPreferences;
  22 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.preferences.SDViewPref;
  23
  24 /**
  25  * ExecutionOccurrence is the UML2 execution occurrence graphical representation. It is a BasicExecutionOccurrence on
  26  * which you can customize fill and/or.
  27  *
  28  * @see org.eclipse.tracecompass.tmf.ui.views.uml2sd.core.Lifeline Lifeline for more event occurence details
  29  * @version 1.0
  30  * @author sveyrier
  31  *
  32  */
  33 public class ExecutionOccurrence extends BasicExecutionOccurrence implements ITimeRange {
  34
  35     // ------------------------------------------------------------------------
  36     // Attributes
  37     // ------------------------------------------------------------------------
  38
  39     /**
  40      * Set the red, green and blue value of the optional color to be used for filling the execution occurrence.
  41      */
  42     private int[] fFillRGB;
  43     /**
  44      * Set the red, green and blue value of the optional color to be used for drawing the execution occurrence
  45      */
  46     private int[] fStrokeRGB;
  47     /**
  48      * The occurrence image.
  49      */
  50     private IImage fImage;
  51     /**
  52      * The top ellipses image.
  53      */
  54     private IImage fEllipsesImage;
  55     /**
  56      *  The start time stamp.
  57      */
  58     private ITmfTimestamp fStartTime;
  59     /**
  60      * The end time stamp;
  61      */
  62     private ITmfTimestamp fEndTime;
  63     /**
  64      * Flag to indicate whether time information is available or not.
  65      */
  66     private boolean fHasTimeInfo;
  67
  68     // ------------------------------------------------------------------------
  69     // Methods
  70     // ------------------------------------------------------------------------
  71
  72     @Override
  73     public void setLifeline(Lifeline theLifeline) {
  74         super.setLifeline(theLifeline);
  75         if (getLifeline() != null && fHasTimeInfo) {
  76             getLifeline().setTimeInfo(true);
  77             if (getLifeline().getFrame() != null) {
  78                 getLifeline().getFrame().setHasTimeInfo(true);
  79             }
  80         }
  81     }
  82
  83     /**
  84      * Set the red, green and blue value of the optional color to be used for filling the execution occurrence.
  85      *
  86      * @param red A value for red.
  87      * @param green A green value for green.
  88      * @param blue A value blue.
  89      */
  90     public void setFillColor(int red, int green, int blue) {
  91         fFillRGB = new int[3];
  92         fFillRGB[0] = red;
  93         fFillRGB[1] = green;
  94         fFillRGB[2] = blue;
  95     }
  96
  97     /**
  98      * Set the red, green and blue value of the optional color to be used for drawing the execution occurrence
  99      *
 100      * @param red A value for red.
 101      * @param green A green value for green.
 102      * @param blue A value blue.
 103      */
 104     public void setStrokeColor(int red, int green, int blue) {
 105         fStrokeRGB = new int[3];
 106         fStrokeRGB[0] = red;
 107         fStrokeRGB[1] = green;
 108         fStrokeRGB[2] = blue;
 109     }
 110
 111     /**
 112      * Set the corresponding image.
 113      *
 114      * @param image A image to set.
 115      */
 116     public void setImage(IImage image) {
 117         fImage = image;
 118     }
 119
 120     /**
 121      * Set the top ellipses image.
 122      *
 123      * @param image A image to set.
 124      */
 125     public void setTopEllipsesImage(IImage image) {
 126         fEllipsesImage = image;
 127     }
 128
 129     /**
 130      * Set the time when the execution occurrence starts.
 131      *
 132      * @param time the time when the execution occurrence starts
 133      * @since 2.0
 134      */
 135     public void setStartTime(ITmfTimestamp time) {
 136         fStartTime = time;
 137         fHasTimeInfo = true;
 138         if (getLifeline() != null) {
 139             getLifeline().setTimeInfo(true);
 140         }
 141     }
 142
 143     /**
 144      * Set the time when the execution occurrence ends.
 145      *
 146      * @param time the time when the execution occurrence ends
 147      * @since 2.0
 148      */
 149     public void setEndTime(ITmfTimestamp time) {
 150         fEndTime = time;
 151         fHasTimeInfo = true;
 152         if (getLifeline() != null) {
 153             getLifeline().setTimeInfo(true);
 154         }
 155     }
 156
 157     /**
 158      * @since 2.0
 159      */
 160     @Override
 161     public ITmfTimestamp getStartTime() {
 162         return fStartTime;
 163     }
 164
 165     /**
 166      * @since 2.0
 167      */
 168     @Override
 169     public ITmfTimestamp getEndTime() {
 170         return fEndTime;
 171     }
 172
 173     @Override
 174     public boolean hasTimeInfo() {
 175         return fHasTimeInfo;
 176     }
 177
 178    /**
 179     * @return the RGB of the occurrence filler.
 180     * @since 2.0
 181     */
 182     public int[] getFillRGB() {
 183        if (fFillRGB == null) {
 184            return null;
 185        }
 186        return Arrays.copyOf(fFillRGB, fFillRGB.length);
 187    }
 188
 189     /**
 190      * @return the RGB of the occurrence filler.
 191      * @since 2.0
 192      */
 193      public int[] getStrokeRGB() {
 194         if (fStrokeRGB == null) {
 195             return null;
 196         }
 197         return Arrays.copyOf(fStrokeRGB, fStrokeRGB.length);
 198     }
 199
 200     /**
 201      * @return the image.
 202      * @since 2.0
 203      */
 204     protected IImage getImage() {
 205         return fImage;
 206     }
 207
 208     /**
 209      * @return the image.
 210      * @since 2.0
 211      */
 212     protected IImage getEllipsesImage() {
 213         return fEllipsesImage;
 214     }
 215
 216     @Override
 217     public void draw(IGC context) {
 218         super.draw(context);
 219         int x = getX();
 220         int y = getY();
 221         int width = getWidth();
 222         int height = getHeight();
 223         if (fImage != null) {
 224             context.drawImage(fImage, x + width - 4, y + height - 11, 8, 11);
 225         }
 226         if (fEllipsesImage != null) {
 227             context.drawImage(fEllipsesImage, x + width, y, 40, 10);
 228         }
 229     }
 230
 231     @Override
 232     protected IColor setUnselectedFillColor(IGC context) {
 233         ISDPreferences pref = SDViewPref.getInstance();
 234         if (fFillRGB != null) {
 235             IColor tempFillColor = context.createColor(fFillRGB[0], fFillRGB[1], fFillRGB[2]);
 236             if (pref.useGradienColor()) {
 237                 context.setGradientColor(tempFillColor);
 238                 context.setForeground(pref.getForeGroundColor(ISDPreferences.PREF_EXEC));
 239                 context.setBackground(pref.getBackGroundColor(ISDPreferences.PREF_FRAME));
 240             } else {
 241                 context.setBackground(tempFillColor);
 242             }
 243             return tempFillColor;
 244         }
 245         return super.setUnselectedFillColor(context);
 246     }
 247
 248     @Override
 249     protected IColor setUnselectedStrokeColor(IGC context) {
 250         if (fStrokeRGB != null) {
 251             IColor tempStrokeColor = context.createColor(fStrokeRGB[0], fStrokeRGB[1], fStrokeRGB[2]);
 252             context.setForeground(tempStrokeColor);
 253             return tempStrokeColor;
 254         }
 255         return super.setUnselectedStrokeColor(context);
 256     }
 257
 258     /**
 259      * Sets the flag whether the frame has time info or not
 260      * @since 2.0
 261      * @param hasTimeInfo
 262      *          true if frame has time info else false
 263      */
 264     public void setHasTimeInfo(boolean hasTimeInfo) {
 265         fHasTimeInfo = hasTimeInfo;
 266     }
 267 }