org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/views/uml2sd/preferences/ISDPreferences.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
  13 package org.eclipse.tracecompass.tmf.ui.views.uml2sd.preferences;
  14
  15 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.drawings.IColor;
  16 import org.eclipse.tracecompass.tmf.ui.views.uml2sd.drawings.IFont;
  17
  18 /**
  19  * Interface for accessing sequence diagram preferences.
  20  *
  21  * @version 1.0
  22  * @author sveyrier
  23  */
  24 public interface ISDPreferences {
  25
  26     /**
  27      * The link font with zoom preference name
  28      */
  29     String PREF_LINK_FONT = "PREF_LINK_FONT"; //$NON-NLS-1$
  30     /**
  31      * The exclude preference time preference name
  32      */
  33     String PREF_EXCLUDE_EXTERNAL_TIME = "PREF_EXCLUDE_EXTERNAL_TIME"; //$NON-NLS-1$
  34     /**
  35      * The use gradient color preferences name
  36      */
  37     String PREF_USE_GRADIENT = "PREF_USE_GRADIENT"; //$NON-NLS-1$
  38     /**
  39      * The lifeline spacing width preference name
  40      */
  41     String PREF_LIFELINE_WIDTH = "PREF_LIFELINE_WIDTH"; //$NON-NLS-1$
  42     /**
  43      * The time compression bar font preference name
  44      */
  45     String PREF_TIME_COMP = "PREF_TIME_COMP"; //$NON-NLS-1$
  46     /**
  47      * The lifeline font preference name
  48      */
  49     String PREF_LIFELINE = "PREF_LIFELINE"; //$NON-NLS-1$
  50     /**
  51      * The frame font preference name
  52      */
  53     String PREF_FRAME = "PREF_FRAME"; //$NON-NLS-1$
  54     /**
  55      * The frame name font preference name
  56      */
  57     String PREF_FRAME_NAME = "PREF_FRAME_NAME"; //$NON-NLS-1$
  58     /**
  59      * The execution occurrence font preference name
  60      */
  61     String PREF_EXEC = "PREF_EXEC"; //$NON-NLS-1$
  62     /**
  63      * The synchronous message font preference name
  64      */
  65     String PREF_SYNC_MESS = "PREF_SYNC_MESS"; //$NON-NLS-1$
  66     /**
  67      * The synchronous message return font preference name
  68      */
  69     String PREF_SYNC_MESS_RET = "PREF_SYNC_MESS_RET"; //$NON-NLS-1$
  70     /**
  71      * The asynchronous message font preference name
  72      */
  73     String PREF_ASYNC_MESS = "PREF_ASYNC_MESS"; //$NON-NLS-1$
  74     /**
  75      * The asynchronous message return font preference name
  76      */
  77     String PREF_ASYNC_MESS_RET = "PREF_ASYNC_MESS_RET"; //$NON-NLS-1$
  78     /**
  79      * The lifeline header font (header = the always visible part of a lifeline)
  80      */
  81     String PREF_LIFELINE_HEADER = "PREF_LIFELINE_HEADER"; //$NON-NLS-1$
  82     /**
  83      * The enable tooltip preference name
  84      */
  85     String PREF_TOOLTIP = "PREF_TOOLTIP"; //$NON-NLS-1$
  86
  87     /**
  88      * Returns the background color for the given preference name (font preference name)
  89      *
  90      * @param prefId The preference name
  91      * @return the color
  92      */
  93     IColor getBackGroundColor(String prefId);
  94
  95     /**
  96      * Returns the foreground color for the given preference name (font preference name)
  97      *
  98      * @param prefId A preference name
  99      * @return the color
 100      */
 101     IColor getForeGroundColor(String prefId);
 102
 103     /**
 104      * Returns the font color for the given preference name (font preference name)
 105      *
 106      * @param prefId A preference name
 107      * @return the color
 108      */
 109     IColor getFontColor(String prefId);
 110
 111     /**
 112      * Returns the font for the given preference name
 113      *
 114      * @param prefId the preference name
 115      * @return the font
 116      */
 117     IFont getFont(String prefId);
 118
 119     /**
 120      * Returns the time compression bar selection color
 121      *
 122      * @return the time compression bar selection color
 123      */
 124     IColor getTimeCompressionSelectionColor();
 125
 126     /**
 127      * Returns the background color used to draw selection
 128      *
 129      * @return the background color
 130      */
 131     IColor getBackGroundColorSelection();
 132
 133     /**
 134      * Returns the foreground color used to draw selection
 135      *
 136      * @return the foreground color
 137      */
 138     IColor getForeGroundColorSelection();
 139
 140     /**
 141      * Returns whether to use gradient color or not
 142      *
 143      * @return whether to use gradient color or not
 144      */
 145     boolean useGradienColor();
 146
 147 }