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