org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/views/uml2sd/core/LifelineCategories.java

   1 /**********************************************************************
   2  * Copyright (c) 2005, 2014 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 package org.eclipse.tracecompass.tmf.ui.views.uml2sd.core;
  13
  14 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.drawings.IImage;
  15
  16 /**
  17  * <p>
  18  * LifelineCategories is used to assign additional description for
  19  * lifelines of the same type. This consists in providing a type name and an icon.
  20  * The icon will be displayed in the rectangle which contains the lifeline name.
  21  * The category name is only display in the lifeline tooltip.
  22  * </p>
  23  *
  24  * @version 1.0
  25  * @author sveyrier
  26  */
  27 public class LifelineCategories {
  28
  29     // ------------------------------------------------------------------------
  30     // Attributes
  31     // ------------------------------------------------------------------------
  32
  33     /**
  34      * The category name
  35      */
  36     private String fName = null;
  37     /**
  38      * The category image
  39      */
  40     private IImage fCategoryImage = null;
  41
  42     // ------------------------------------------------------------------------
  43     // Methods
  44     // ------------------------------------------------------------------------
  45
  46     /**
  47      * Returns the category name.
  48      *
  49      * @return the category name
  50      */
  51     public String getName() {
  52         return fName;
  53     }
  54
  55     /**
  56      * Sets the category name.
  57      *
  58      * @param string the name
  59      */
  60     public void setName(String string) {
  61         fName = string;
  62     }
  63
  64     /**
  65      * Returns the category icon.
  66      *
  67      * @return the category icon
  68      */
  69     public IImage getImage() {
  70         return fCategoryImage;
  71     }
  72
  73     /**
  74      * Sets the category icon.
  75      *
  76      * @param image the icon
  77      */
  78     public void setImage(IImage image) {
  79         fCategoryImage = image;
  80     }
  81 }