blob: fd085f1a2c3e203eb795e3b67dd03a7a0370cf3f (
plain) (
blame)
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
|
/*******************************************************************************
* Copyright (c) 2005, 2008 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
*******************************************************************************/
package org.eclipse.ui.texteditor.spelling;
import org.osgi.framework.Bundle;
import org.eclipse.core.runtime.Assert;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.Platform;
import org.eclipse.ui.internal.texteditor.spelling.EmptySpellingPreferenceBlock;
/**
* Describes an extension to the <code>spellingEngine</code> extension point.
* <p>
* This class is not intended to be subclassed by clients.
* </p>
*
* @since 3.1
* @noextend This class is not intended to be subclassed by clients.
*/
public class SpellingEngineDescriptor {
/** Name of the <code>label</code> attribute. */
private static final String LABEL_ATTRIBUTE= "label"; //$NON-NLS-1$
/** Name of the <code>class</code> attribute. */
private static final String CLASS_ATTRIBUTE= "class"; //$NON-NLS-1$
/** Name of the <code>id</code> attribute. */
private static final String ID_ATTRIBUTE= "id"; //$NON-NLS-1$
/** Name of the <code>default</code> attribute. */
private static final String DEFAULT_ATTRIBUTE= "default"; //$NON-NLS-1$
/** Name of the <code>preferencesClass</code> attribute. */
private static final String PREFERENCES_CLASS_ATTRIBUTE= "preferencesClass"; //$NON-NLS-1$
/** The configuration element describing this extension. */
private IConfigurationElement fConfiguration;
/** The value of the <code>label</code> attribute, if read. */
private String fLabel;
/** The value of the <code>id</code> attribute, if read. */
private String fId;
/** The value of the <code>default</code> attribute, if read. */
private Boolean fDefault;
/** The bundle where this extension was defined. */
private Bundle fBundle;
/** <code>true</code> iff a preferences class has been specified */
private Boolean fHasPreferences;
/**
* Creates a new descriptor for <code>element</code>.
* <p>
* This method is for internal use only.
* </p>
*
* @param element the extension point element to be described.
*/
public SpellingEngineDescriptor(IConfigurationElement element) {
Assert.isLegal(element != null);
fConfiguration= element;
}
/**
* Reads (if needed) and returns the label of this extension.
*
* @return the label for this extension.
*/
public String getLabel() {
if (fLabel == null) {
fLabel= fConfiguration.getAttribute(LABEL_ATTRIBUTE);
Assert.isNotNull(fLabel);
}
return fLabel;
}
/**
* Reads (if needed) and returns the id of this extension.
*
* @return the id for this extension.
*/
public String getId() {
if (fId == null) {
fId= fConfiguration.getAttribute(ID_ATTRIBUTE);
Assert.isNotNull(fId);
}
return fId;
}
/**
* Creates a spelling engine as described in the extension's xml.
*
* @return the created spelling engine
* @throws CoreException if the creation failed
*/
public ISpellingEngine createEngine() throws CoreException {
return (ISpellingEngine)fConfiguration.createExecutableExtension(CLASS_ATTRIBUTE);
}
/**
* Returns <code>true</code> iff a preferences class has been
* specified for this engine.
*
* @return <code>true</code> iff a preferences class has been
* specified for this engine
*/
private boolean hasPreferences() {
if (fHasPreferences == null)
if (fConfiguration.getAttribute(PREFERENCES_CLASS_ATTRIBUTE) == null)
fHasPreferences= Boolean.FALSE;
else
fHasPreferences= Boolean.TRUE;
return fHasPreferences.booleanValue();
}
/**
* Creates a spelling preferences block as described in the extension's xml.
*
* @return the created spelling preferences block
* @throws CoreException if the creation failed
*/
public ISpellingPreferenceBlock createPreferences() throws CoreException {
if (hasPreferences())
return (ISpellingPreferenceBlock) fConfiguration.createExecutableExtension(PREFERENCES_CLASS_ATTRIBUTE);
return new EmptySpellingPreferenceBlock();
}
/**
* States whether the plug-in declaring this extension has been loaded already.
*
* @return <code>true</code> if the extension point's plug-in has been loaded, <code>false</code> otherwise.
*/
public boolean isPluginLoaded() {
if (fBundle == null)
fBundle= Platform.getBundle(fConfiguration.getContributor().getName());
return (fBundle != null && fBundle.getState() == Bundle.ACTIVE);
}
/**
* Reads (if needed) and returns the default attribute value of this extension.
*
* @return the default attribute value for this extension.
*/
public boolean isDefault() {
if (fDefault == null) {
String def= fConfiguration.getAttribute(DEFAULT_ATTRIBUTE);
if ("true".equalsIgnoreCase(def)) //$NON-NLS-1$
fDefault= Boolean.TRUE;
else
fDefault= Boolean.FALSE;
}
return fDefault.booleanValue();
}
}
|
