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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_72) on Sat Jan 03 15:00:00 CET 2015 -->
<title>MnemonicUtils (JGoodies Common 1.8 API)</title>
<meta name="date" content="2015-01-03">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="MnemonicUtils (JGoodies Common 1.8 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MnemonicUtils.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/jgoodies/common/swing/MnemonicUtils.html" target="_top">Frames</a></li>
<li><a href="MnemonicUtils.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.jgoodies.common.swing</div>
<h2 title="Class MnemonicUtils" class="title">Class MnemonicUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.jgoodies.common.swing.MnemonicUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <span class="strong">MnemonicUtils</span>
extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Configures the text, mnemonic and mnemonic index in Actions, JLabels,
and AbstractButtons. The term <em>marked text</em> is used for Strings
that contain a marker character that marks both the mnemonic and
its index in the resulting <em>plain text</em>.<p>
To set a mnemonic, add an ampersand ('&') before the character
that should be the mnemonic, for example "&Save".
If your text has multiple ampersands, only the first one is used to mark
the mnemonic; the other ampersands appear as normal text.
For example "&Look&Feel" has the first 'L' has mnemonic.
If you want to use the ampersand itself in the text, use two consecutive
ampersands for any ampersand that precede the one that is used to mark
the mnemonic. For example the marked text "R&&D D&epartment"
has "R&D Department" as text and the mnemonic is 'E'.<p>
Examples:
<table border="1">
<tr>
<td><b>Marked Text</b></td>
<td><b>Plain Text</b></td>
<td><b>Mnemonic</b></td>
<td><b>Mnemonic Index</b></td>
<td><b>Comment</b></td>
</tr>
<tr>
<td>Save</td>
<td>Save</td>
<td>0</td>
<td>-1</td>
<td>No mnemonic</td>
</tr>
<tr>
<td>&Save</td>
<td>Save</td>
<td>'S'</td>
<td>0</td>
<td> </td>
</tr>
<tr>
<td>Save &as</td>
<td>Save as</td>
<td>'A'</td>
<td>5</td>
<td>Second 'a' marked</td>
</tr>
<tr>
<td>Look&Feel</td>
<td>LookFeel</td>
<td>'F'</td>
<td>4</td>
<td>& should be quoted</td>
</tr>
<tr>
<td>Look&&Feel</td>
<td>Look&Feel</td>
<td>0</td>
<td>-1</td>
<td>& is quoted</td>
</tr>
<tr>
<td>&Look&Feel</td>
<td>Look&Feel</td>
<td>L</td>
<td>0</td>
<td>Second & needs no quote</td>
</tr>
<tr>
<td>Look & Feel</td>
<td>Look & Feel</td>
<td>0</td>
<td>-1</td>
<td>Whitespace cannot be marked</td>
</tr>
<tr>
<td>R&&D D&epartment</td>
<td>R&D Department</td>
<td>'E'</td>
<td>5</td>
<td>First & is quoted</td>
</tr>
<tr>
<td><html>a&b</html></td>
<td><html>a<u>b</u></html></td>
<td>'B'</td>
<td>-1</td>
<td>'b' is underlined</td>
</tr>
<tr>
<td><html>R&amp;D D&ep.</html></td>
<td><html>R&amp;D D<u>e</u>p.</html></td>
<td>'B'</td>
<td>-1</td>
<td>HTML &amp; doesn't mark</td>
</tr>
</table></div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Karsten Lentzsch</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/jgoodies/common/swing/MnemonicUtils.html#configure(javax.swing.AbstractButton,%20java.lang.String)">configure</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/javax/swing/AbstractButton.html?is-external=true" title="class or interface in javax.swing">AbstractButton</a> target,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> markedText)</code>
<div class="block">Configures the text, mnemonic and mnemonic index for <code>target</code>
using the given text that can be marked with the mnemonic marker '&'.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/jgoodies/common/swing/MnemonicUtils.html#configure(javax.swing.Action,%20java.lang.String)">configure</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/javax/swing/Action.html?is-external=true" title="class or interface in javax.swing">Action</a> target,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> markedText)</code>
<div class="block">Configures the text, mnemonic and mnemonic index for <code>target</code>
using the given text that can be marked with the mnemonic marker '&'.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../com/jgoodies/common/swing/MnemonicUtils.html#configure(javax.swing.JLabel,%20java.lang.String)">configure</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/javax/swing/JLabel.html?is-external=true" title="class or interface in javax.swing">JLabel</a> target,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> markedText)</code>
<div class="block">Configures the text, mnemonic and mnemonic index for <code>target</code>
using the given text that can be marked with the mnemonic marker '&'.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../com/jgoodies/common/swing/MnemonicUtils.html#plainText(java.lang.String)">plainText</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> markedText)</code>
<div class="block">Returns the plain text for the given marked text by removing
the mnemonic marker and marker quotes - if any.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="configure(javax.swing.AbstractButton, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre>public static void configure(<a href="http://docs.oracle.com/javase/6/docs/api/javax/swing/AbstractButton.html?is-external=true" title="class or interface in javax.swing">AbstractButton</a> target,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> markedText)</pre>
<div class="block">Configures the text, mnemonic and mnemonic index for <code>target</code>
using the given text that can be marked with the mnemonic marker '&'.
For example if <code>markedText</code> is "Save &as", the text
will be set to "Save as", the mnemonic is 'a', and the
mnemonic index is 5.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - the button to be configured</dd><dd><code>markedText</code> - the text with optional mnemonic marker</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>target</code> is <code>null</code></dd></dl>
</li>
</ul>
<a name="configure(javax.swing.Action, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre>public static void configure(<a href="http://docs.oracle.com/javase/6/docs/api/javax/swing/Action.html?is-external=true" title="class or interface in javax.swing">Action</a> target,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> markedText)</pre>
<div class="block">Configures the text, mnemonic and mnemonic index for <code>target</code>
using the given text that can be marked with the mnemonic marker '&'.
For example if <code>markedText</code> is "Save &as", the text
will be set to "Save as", the mnemonic is 'a', and the
mnemonic index is 5.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - the Action to be configured</dd><dd><code>markedText</code> - the text with optional mnemonic marker</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>target</code> is <code>null</code></dd></dl>
</li>
</ul>
<a name="configure(javax.swing.JLabel, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>configure</h4>
<pre>public static void configure(<a href="http://docs.oracle.com/javase/6/docs/api/javax/swing/JLabel.html?is-external=true" title="class or interface in javax.swing">JLabel</a> target,
<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> markedText)</pre>
<div class="block">Configures the text, mnemonic and mnemonic index for <code>target</code>
using the given text that can be marked with the mnemonic marker '&'.
For example if <code>markedText</code> is "Save &as", the text
will be set to "Save as", the mnemonic is 'a', and the
mnemonic index is 5.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>target</code> - the label to be configured</dd><dd><code>markedText</code> - the text with optional mnemonic marker</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>target</code> is <code>null</code></dd></dl>
</li>
</ul>
<a name="plainText(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>plainText</h4>
<pre>public static <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> plainText(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> markedText)</pre>
<div class="block">Returns the plain text for the given marked text by removing
the mnemonic marker and marker quotes - if any. If the marked text
is HTML, the plain text has the mnemonic character underlined.
See the <a href="../../../../com/jgoodies/common/swing/MnemonicUtils.html" title="class in com.jgoodies.common.swing"><code>MnemonicUtils</code></a> class comment for information
about how to mark a mnemonic and how to quote a marker.
<pre>
MnemonicUtils.plainText("Save") == "Save"
MnemonicUtils.plainText("&Save") == "Save"
MnemonicUtils.plainText("&Look&Feel") == "Look&Feel"
MnemonicUtils.plainText("Look & Feel") == "Look & Feel"
MnemonicUtils.plainText("R&&D D&epartment") == "R&D Department"
MnemonicUtils.plainText("<html>a&b</html>") == "<html>a<u>b</u></html>"
</pre></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>markedText</code> - the text that may contain a mnemonic marker</dd>
<dt><span class="strong">Returns:</span></dt><dd>the text without mnemonic marker and marker quotes</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/MnemonicUtils.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/jgoodies/common/swing/MnemonicUtils.html" target="_top">Frames</a></li>
<li><a href="MnemonicUtils.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2009-2014 JGoodies Software GmbH. All Rights Reserved.</small></p>
</body>
</html>
|
