1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
/*******************************************************************************
* Copyright (c) 2001, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* Jens Lukowski/Innoopract - initial renaming/restructuring
*
*******************************************************************************/
package org.eclipse.wst.sse.ui.internal.taginfo;
import java.util.HashMap;
import com.ibm.icu.util.StringTokenizer;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.text.ITextHover;
import org.eclipse.wst.sse.ui.internal.Logger;
import org.eclipse.wst.sse.ui.internal.SSEUIMessages;
import org.eclipse.wst.sse.ui.internal.SSEUIPlugin;
import org.eclipse.wst.sse.ui.internal.preferences.EditorPreferenceNames;
/**
* Manages text hovers for Structured Text editors
*
* @author amywu
*/
public class TextHoverManager {
/**
* Contains description of a text hover
*/
public class TextHoverDescriptor {
private String fDescription;
private boolean fEnabled;
private String fId;
private String fLabel;
private String fModifierString;
/**
* @param id
* @param label
* @param desc
*/
public TextHoverDescriptor(String id, String label, String desc) {
fId = id;
fLabel = label;
fDescription = desc;
}
/**
* @param id
* @param label
* @param desc
* @param enabled
* @param modifierString
*/
public TextHoverDescriptor(String id, String label, String desc, boolean enabled, String modifierString) {
fId = id;
fLabel = label;
fDescription = desc;
fEnabled = enabled;
fModifierString = modifierString;
}
/**
* @return Returns the fDescription.
*/
public String getDescription() {
return fDescription;
}
/**
* @return Returns the fId.
*/
public String getId() {
return fId;
}
/**
* @return Returns the fLabel
*/
public String getLabel() {
return fLabel;
}
/**
* @return Returns the fModifierString.
*/
public String getModifierString() {
return fModifierString;
}
/**
* @return Returns the fEnabled.
*/
public boolean isEnabled() {
return fEnabled;
}
/**
* @param enabled
* The fEnabled to set.
*/
public void setEnabled(boolean enabled) {
fEnabled = enabled;
}
/**
* @param modifierString
* The fModifierString to set.
*/
public void setModifierString(String modifierString) {
fModifierString = modifierString;
}
}
public static final String ANNOTATION_HOVER = "annotationHover"; //$NON-NLS-1$
// list of different types of Source editor hovers
public static final String COMBINATION_HOVER = "combinationHover"; //$NON-NLS-1$
// hover descriptions are in .properties file with the key in the form of
// "[id]_desc"
private static final String DESCRIPTION_KEY = "_desc"; //$NON-NLS-1$
public static final String DOCUMENTATION_HOVER = "documentationHover"; //$NON-NLS-1$
public static final String HOVER_ATTRIBUTE_SEPARATOR = "|"; //$NON-NLS-1$
public static final String HOVER_SEPARATOR = ";"; //$NON-NLS-1$
// hover labels are in .properties file with the key in the form of
// "[id]_label"
private static final String LABEL_KEY = "_label"; //$NON-NLS-1$
public static final String NO_MODIFIER = "0"; //$NON-NLS-1$
public static final String PROBLEM_HOVER = "problemHover"; //$NON-NLS-1$
public static final String[] TEXT_HOVER_IDS = new String[]{COMBINATION_HOVER, PROBLEM_HOVER, DOCUMENTATION_HOVER, ANNOTATION_HOVER};
/**
* Current list of Structured Text editor text hovers
*/
private TextHoverDescriptor[] fTextHovers;
public TextHoverManager() {
super();
}
/**
* Create a best match hover with the give text hover as the documentation
* hover
*
* @param infoHover
* @return ITextHover
*/
public ITextHover createBestMatchHover(ITextHover infoHover) {
return new BestMatchHover(infoHover);
}
/**
* Generate a list of text hover descriptors from the given delimited
* string
*
* @param textHoverStrings
* @return
*/
public TextHoverDescriptor[] generateTextHoverDescriptors(String textHoverStrings) {
StringTokenizer st = new StringTokenizer(textHoverStrings, HOVER_SEPARATOR);
// read from preference and load id-descriptor mapping to a hash table
HashMap idToModifier = new HashMap(st.countTokens());
while (st.hasMoreTokens()) {
String textHoverString = st.nextToken();
StringTokenizer st2 = new StringTokenizer(textHoverString, HOVER_ATTRIBUTE_SEPARATOR);
if (st2.countTokens() == 3) {
String id = st2.nextToken();
boolean enabled = Boolean.valueOf(st2.nextToken()).booleanValue();
String modifierString = st2.nextToken();
if (modifierString.equals(NO_MODIFIER))
modifierString = ""; //$NON-NLS-1$
String label = null;
String description = null;
try {
label = SSEUIMessages.getResourceBundle().getString(id + LABEL_KEY);
description = SSEUIMessages.getResourceBundle().getString(id + DESCRIPTION_KEY);
}
catch (Exception e) {
Logger.log(Logger.WARNING_DEBUG, e.getMessage(), e);
}
TextHoverDescriptor descriptor = new TextHoverDescriptor(id, label, description, enabled, modifierString);
// should check to see if ids appear more than once
idToModifier.put(id, descriptor);
}
}
// go through all defined text hovers and match with their preference
TextHoverDescriptor[] descriptors = new TextHoverDescriptor[TEXT_HOVER_IDS.length];
for (int i = 0; i < TEXT_HOVER_IDS.length; i++) {
TextHoverDescriptor desc = (TextHoverDescriptor) idToModifier.get(TEXT_HOVER_IDS[i]);
if (desc != null) {
descriptors[i] = desc;
}
else {
String label = null;
String description = null;
try {
label = SSEUIMessages.getResourceBundle().getString(TEXT_HOVER_IDS[i] + LABEL_KEY);
description = SSEUIMessages.getResourceBundle().getString(TEXT_HOVER_IDS[i] + DESCRIPTION_KEY);
}
catch (Exception e) {
Logger.log(Logger.WARNING_DEBUG, e.getMessage(), e);
}
descriptors[i] = new TextHoverDescriptor(TEXT_HOVER_IDS[i], label, description);
}
}
return descriptors;
}
private IPreferenceStore getPreferenceStore() {
return SSEUIPlugin.getDefault().getPreferenceStore();
}
/**
* Returns the text hovers for Structured Text editor. If fTextHover has
* not been initialied, it will be initialized.
*
* @return Returns the fTextHovers.
*/
public TextHoverDescriptor[] getTextHovers() {
if (fTextHovers == null) {
String textHoverStrings = getPreferenceStore().getString(EditorPreferenceNames.EDITOR_TEXT_HOVER_MODIFIERS);
fTextHovers = generateTextHoverDescriptors(textHoverStrings);
}
return fTextHovers;
}
/**
* Sets fTextHovers to null so that next time getTextHovers is called,
* fTextHovers will be populated with the latest preferences.
*/
public void resetTextHovers() {
fTextHovers = null;
}
}
|
