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