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
|
/*******************************************************************************
* Copyright (c) 2000, 2005 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ui.texteditor;
import java.util.MissingResourceException;
import java.util.ResourceBundle;
import org.eclipse.jface.action.Action;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.ui.PlatformUI;
/**
* An action which configures its label, image, tooltip, and description from
* a resource bundle using known keys.
* <p>
* Clients may subclass this abstract class to define new kinds of actions. As
* with <code>Action</code>, subclasses must implement the
* <code>IAction.run</code> method to carry out the action's semantics.
* </p>
*/
public abstract class ResourceAction extends Action {
/**
* Retrieves and returns the value with the given key from the given resource
* bundle, or returns the given default value if there is no such resource.
* Convenience method for dealing gracefully with missing resources.
*
* @param bundle the resource bundle
* @param key the resource key
* @param defaultValue the default value, or <code>null</code>
* @return the resource value, or the given default value (which may be
* <code>null</code>)
*/
protected static String getString(ResourceBundle bundle, String key, String defaultValue) {
String value= defaultValue;
try {
value= bundle.getString(key);
} catch (MissingResourceException x) {
}
return value;
}
/**
* Creates a new action that configures itself from the given resource
* bundle.
* <p>
* The following keys, prepended by the given option prefix, are used for
* retrieving resources from the given bundle:
* </p>
* <ul>
* <li><code>"label"</code> - <code>setText</code></li>
* <li><code>"tooltip"</code> - <code>setToolTipText</code></li>
* <li><code>"image"</code> - <code>setImageDescriptor</code></li>
* <li><code>"description"</code> - <code>setDescription</code></li>
* </ul>
*
* @param bundle
* the resource bundle
* @param prefix
* a prefix to be prepended to the various resource keys, or
* <code>null</code> if none
* @param style
* one of <code>IAction.AS_PUSH_BUTTON</code>,
* <code>IAction.AS_CHECK_BOX</code>, and
* <code>IAction.AS_RADIO_BUTTON</code>.
*
* @see ResourceAction#ResourceAction(ResourceBundle, String)
* @see org.eclipse.jface.action.IAction#AS_CHECK_BOX
* @see org.eclipse.jface.action.IAction#AS_DROP_DOWN_MENU
* @see org.eclipse.jface.action.IAction#AS_PUSH_BUTTON
* @see org.eclipse.jface.action.IAction#AS_RADIO_BUTTON
* @since 2.1
*/
public ResourceAction(ResourceBundle bundle, String prefix, int style) {
super(null, style);
initialize(bundle, prefix);
}
/**
* Creates a new action that configures itself from the given resource
* bundle.
* <p>
* The following keys, prepended by the given option prefix, are used for
* retrieving resources from the given bundle:
* </p>
* <ul>
* <li><code>"label"</code> - <code>setText</code></li>
* <li><code>"tooltip"</code> - <code>setToolTipText</code></li>
* <li><code>"image"</code> - <code>setImageDescriptor</code></li>
* <li><code>"description"</code> - <code>setDescription</code></li>
* </ul>
*
* @param bundle
* the resource bundle
* @param prefix
* a prefix to be prepended to the various resource keys, or
* <code>null</code> if none
*/
public ResourceAction(ResourceBundle bundle, String prefix) {
super();
initialize(bundle, prefix);
}
/**
* Sets the action's help context id.
*
* @param contextId the help context id
*/
public final void setHelpContextId(String contextId) {
PlatformUI.getWorkbench().getHelpSystem().setHelp(this, contextId);
}
/**
* Initializes this action using the given bundle and prefix.
*
* @param bundle the resource bundle
* @param prefix a prefix to be prepended to the various resource keys, or <code>null</code> if none
* @since 2.1
*/
protected void initialize(ResourceBundle bundle, String prefix) {
String labelKey= "label"; //$NON-NLS-1$
String tooltipKey= "tooltip"; //$NON-NLS-1$
String imageKey= "image"; //$NON-NLS-1$
String descriptionKey= "description"; //$NON-NLS-1$
if (prefix != null && prefix.length() > 0) {
labelKey= prefix + labelKey;
tooltipKey= prefix + tooltipKey;
imageKey= prefix + imageKey;
descriptionKey= prefix + descriptionKey;
}
setText(getString(bundle, labelKey, labelKey));
setToolTipText(getString(bundle, tooltipKey, null));
setDescription(getString(bundle, descriptionKey, null));
String file= getString(bundle, imageKey, null);
if (file != null && file.trim().length() > 0)
setImageDescriptor(ImageDescriptor.createFromFile(getClass(), file));
}
}
|
