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

   1 /**********************************************************************
   2  * Copyright (c) 2005, 2006 IBM Corporation and others.
   3  * Copyright (c) 2011, 2012 Ericsson.
   4  *
   5  * All rights reserved.   This program and the accompanying materials
   6  * are made available under the terms of the Eclipse Public License v1.0
   7  * which accompanies this distribution, and is available at
   8  * http://www.eclipse.org/legal/epl-v10.html
   9  *
  10  * Contributors:
  11  * IBM - Initial API and implementation
  12  * Bernd Hufmann - Updated for TMF
  13  **********************************************************************/
  14 package org.eclipse.linuxtools.tmf.ui.views.uml2sd.core;
  15
  16 import org.eclipse.linuxtools.tmf.ui.views.uml2sd.drawings.IImage;
  17
  18 /**
  19  * <p>
  20  * LifelineCategories is used to assign additional description for
  21  * lifelines of the same type. This consists in providing a type name and an icon.
  22  * The icon will be displayed in the rectangle which contains the lifeline name.
  23  * The category name is only display in the lifeline tooltip.
  24  * </p>
  25  *
  26  * @version 1.0
  27  * @author sveyrier
  28  */
  29 public class LifelineCategories {
  30
  31     // ------------------------------------------------------------------------
  32     // Attributes
  33     // ------------------------------------------------------------------------
  34
  35     /**
  36          * The category name
  37          */
  38         protected String fName = null;
  39         /**
  40          * The category image
  41          */
  42         protected IImage fCategoryImage = null;
  43
  44     // ------------------------------------------------------------------------
  45     // Methods
  46     // ------------------------------------------------------------------------
  47
  48         /**
  49          * Returns the category name.
  50          *
  51          * @return the category name
  52          */
  53         public String getName() {
  54                 return fName;
  55         }
  56
  57         /**
  58          * Sets the category name.
  59          *
  60          * @param string the name
  61          */
  62         public void setName(String string) {
  63                 fName = string;
  64         }
  65
  66         /**
  67          * Returns the category icon.
  68          *
  69          * @return the category icon
  70          */
  71         public IImage getImage() {
  72                 return fCategoryImage;
  73         }
  74
  75         /**
  76          * Sets the category icon.
  77          *
  78          * @param image the icon
  79          */
  80         public void setImage(IImage image) {
  81                 fCategoryImage = image;
  82         }
  83 }