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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
|
/*
@ITMillApache2LicenseForJavaFiles@
*/
package com.itmill.toolkit.ui;
import java.lang.reflect.Method;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.Map;
import com.itmill.toolkit.terminal.KeyMapper;
import com.itmill.toolkit.terminal.PaintException;
import com.itmill.toolkit.terminal.PaintTarget;
import com.itmill.toolkit.terminal.Resource;
import com.itmill.toolkit.terminal.Paintable.RepaintRequestListener;
/**
* Tabsheet component.
*
* @author IT Mill Ltd.
* @version
* @VERSION@
* @since 3.0
*/
public class TabSheet extends AbstractComponentContainer implements
RepaintRequestListener {
/**
* Linked list of component tabs.
*/
private final LinkedList tabs = new LinkedList();
/**
* Tab -> caption mapping.
*/
private final Hashtable tabCaptions = new Hashtable();
/**
* Tab -> icon mapping .
*/
private final Hashtable tabIcons = new Hashtable();
/**
* Selected tab.
*/
private Component selected = null;
private final KeyMapper keyMapper = new KeyMapper();
/**
* Holds the value of property tabsHIdden.
*/
private boolean tabsHidden;
/**
* Constructs a new Tabsheet. Tabsheet is immediate by default.
*/
public TabSheet() {
super();
setImmediate(true);
}
/**
* Gets the component container iterator for going trough all the components
* in the container.
*
* @return the Iterator of the components inside the container.
*/
public Iterator getComponentIterator() {
return java.util.Collections.unmodifiableList(tabs).iterator();
}
/**
* Removes the component from this container.
*
* @param c
* the component to be removed.
*/
public void removeComponent(Component c) {
if (c != null && tabs.contains(c)) {
super.removeComponent(c);
keyMapper.remove(c);
tabs.remove(c);
tabCaptions.remove(c);
if (c.equals(selected)) {
if (tabs.isEmpty()) {
selected = null;
} else {
selected = (Component) tabs.getFirst();
fireSelectedTabChange();
}
}
c.removeListener(this);
requestRepaint();
}
}
/**
* Adds a new tab into TabSheet. Components caption and icon are rendered
* into tab.
*
* @param c
* the component to be added.
*/
public void addComponent(Component c) {
addTab(c);
}
/**
* Adds a new tab into TabSheet with overridden caption and icon.
*
* @param c
* the component to be added onto tab.
* @param caption
* the caption of the tab to be used instead of components
* own.
* @param icon
* the icon of the tab to be used instead of components own.
*/
public void addTab(Component c, String caption, Resource icon) {
if (c != null) {
tabCaptions.put(c, caption != null ? caption : "");
if (icon != null) {
tabIcons.put(c, icon);
}
addTab(c);
}
}
/**
* Adds a new tab into TabSheet. Components caption and icon are rendered
* into tab.
*
* @param c
* the component to be added onto tab.
*/
public void addTab(Component c) {
if (c != null) {
tabs.addLast(c);
if (selected == null) {
selected = c;
fireSelectedTabChange();
}
super.addComponent(c);
requestRepaint();
c.addListener(this);
}
}
/**
* Gets the component UIDL tag.
*
* @return the Component UIDL tag as string.
*/
public String getTag() {
return "tabsheet";
}
/**
* Moves all components from another container to this container. The
* components are removed from the other container.
*
* @param source
* the container components are removed from.
*/
public void moveComponentsFrom(ComponentContainer source) {
for (final Iterator i = source.getComponentIterator(); i.hasNext();) {
final Component c = (Component) i.next();
String caption = null;
Resource icon = null;
if (TabSheet.class.isAssignableFrom(source.getClass())) {
caption = ((TabSheet) source).getTabCaption(c);
icon = ((TabSheet) source).getTabIcon(c);
}
source.removeComponent(c);
addTab(c, caption, icon);
}
}
/**
* Paints the content of this component.
*
* @param event
* the Paint Event.
* @throws PaintException
* if the paint operation failed.
*/
public void paintContent(PaintTarget target) throws PaintException {
if (areTabsHidden()) {
target.addAttribute("hidetabs", true);
}
target.startTag("tabs");
for (final Iterator i = getComponentIterator(); i.hasNext();) {
final Component c = (Component) i.next();
if (!c.isVisible()) {
continue;
}
target.startTag("tab");
if (!c.isEnabled()) {
target.addAttribute("disabled", true);
}
final Resource icon = getTabIcon(c);
if (icon != null) {
target.addAttribute("icon", icon);
}
final String caption = getTabCaption(c);
if (caption != null && caption.length() > 0) {
target.addAttribute("caption", caption);
}
if (c instanceof AbstractComponent) {
AbstractComponent ac = (AbstractComponent) c;
if (ac.getDescription() != null) {
target.addAttribute("description", ac.getDescription());
}
if (ac.getComponentError() != null) {
ac.getComponentError().paint(target);
}
}
target.addAttribute("key", keyMapper.key(c));
if (c.equals(selected)) {
target.addAttribute("selected", true);
c.paint(target);
}
target.endTag("tab");
}
target.endTag("tabs");
if (selected != null) {
target.addVariable(this, "selected", keyMapper.key(selected));
}
}
/**
* Are tabs hidden.
*
* @return the Property visibility.
*/
public boolean areTabsHidden() {
return tabsHidden;
}
/**
* Setter for property tabsHidden.
*
* @param tabsHidden
* True if the tabs should be hidden.
*/
public void hideTabs(boolean tabsHidden) {
this.tabsHidden = tabsHidden;
requestRepaint();
}
/**
* Gets the caption for a component.
*
* @param c
* the component.
*/
public String getTabCaption(Component c) {
String caption = (String) tabCaptions.get(c);
if (caption == null) {
caption = c.getCaption();
}
if (caption == null) {
caption = "";
}
return caption;
}
/**
* Sets overridden tab caption for given component.
*
* Normally TabSheet uses caption from component
*
* @param c
* the component.
* @param caption
* the caption to set.
*/
public void setTabCaption(Component c, String caption) {
tabCaptions.put(c, caption);
requestRepaint();
}
/**
* Gets the icon for a component.
*
* @param c
* the component.
*/
public Resource getTabIcon(Component c) {
if (tabIcons.containsKey(c)) {
return (Resource) tabIcons.get(c);
} else {
return c.getIcon();
}
}
/**
* Sets overridden icon for given component.
*
* Normally TabSheet uses icon from component
*
* @param c
* @param icon
*/
public void setTabIcon(Component c, Resource icon) {
if (icon == null) {
tabIcons.remove(c);
} else {
tabIcons.put(c, icon);
}
requestRepaint();
}
/**
* Sets the selected tab.
*
* @param c
*/
public void setSelectedTab(Component c) {
if (c != null && tabs.contains(c) && !selected.equals(c)) {
selected = c;
fireSelectedTabChange();
requestRepaint();
}
}
/**
* Gets the selected tab.
*
* @return the selected tab.
*/
public Component getSelectedTab() {
return selected;
}
/**
* Invoked when the value of a variable has changed.
*
* @see com.itmill.toolkit.ui.AbstractComponent#changeVariables(java.lang.Object,
* java.util.Map)
*/
public void changeVariables(Object source, Map variables) {
if (variables.containsKey("selected")) {
setSelectedTab((Component) keyMapper.get((String) variables
.get("selected")));
}
}
/* Documented in superclass */
public void replaceComponent(Component oldComponent, Component newComponent) {
if (selected == oldComponent) {
// keep selection w/o selectedTabChange event
selected = newComponent;
}
// Gets the captions
final String oldCaption = getTabCaption(oldComponent);
final Resource oldIcon = getTabIcon(oldComponent);
final String newCaption = getTabCaption(newComponent);
final Resource newIcon = getTabIcon(newComponent);
// Gets the locations
int oldLocation = -1;
int newLocation = -1;
int location = 0;
for (final Iterator i = tabs.iterator(); i.hasNext();) {
final Component component = (Component) i.next();
if (component == oldComponent) {
oldLocation = location;
}
if (component == newComponent) {
newLocation = location;
}
location++;
}
if (oldLocation == -1) {
addComponent(newComponent);
} else if (newLocation == -1) {
removeComponent(oldComponent);
keyMapper.remove(oldComponent);
addComponent(newComponent);
tabs.remove(newComponent);
tabs.add(oldLocation, newComponent);
setTabCaption(newComponent, oldCaption);
setTabIcon(newComponent, oldIcon);
} else {
if (oldLocation > newLocation) {
tabs.remove(oldComponent);
tabs.add(newLocation, oldComponent);
tabs.remove(newComponent);
tabs.add(oldLocation, newComponent);
} else {
tabs.remove(newComponent);
tabs.add(oldLocation, newComponent);
tabs.remove(oldComponent);
tabs.add(newLocation, oldComponent);
}
setTabCaption(newComponent, oldCaption);
setTabIcon(newComponent, oldIcon);
setTabCaption(oldComponent, newCaption);
setTabIcon(oldComponent, newIcon);
requestRepaint();
}
}
/* Click event ************************************************ */
private static final Method SELECTED_TAB_CHANGE_METHOD;
static {
try {
SELECTED_TAB_CHANGE_METHOD = SelectedTabChangeListener.class
.getDeclaredMethod("selectedTabChange",
new Class[] { SelectedTabChangeEvent.class });
} catch (final java.lang.NoSuchMethodException e) {
// This should never happen
throw new java.lang.RuntimeException();
}
}
/**
* Selected Tab Change event. This event is thrown, when the selected tab in
* the tab sheet is changed.
*
* @author IT Mill Ltd.
* @version
* @VERSION@
* @since 3.0
*/
public class SelectedTabChangeEvent extends Component.Event {
/**
* Serial generated by eclipse.
*/
private static final long serialVersionUID = 3258129141914940469L;
/**
* New instance of selected tab change event
*
* @param source
* the Source of the event.
*/
public SelectedTabChangeEvent(Component source) {
super(source);
}
/**
* TabSheet where the event occurred.
*
* @return the Source of the event.
*/
public TabSheet getTabSheet() {
return (TabSheet) getSource();
}
}
/**
* Selected Tab Change Event listener
*
* @author IT Mill Ltd.
*
* @version
* @VERSION@
* @since 3.0
*/
public interface SelectedTabChangeListener {
/**
* Visible tab in tab sheet has has been changed.
*
* @param event
* the Selected tab change event.
*/
public void selectedTabChange(SelectedTabChangeEvent event);
}
/**
* Adds the selected tab change listener
*
* @param listener
* the Listener to be added.
*/
public void addListener(SelectedTabChangeListener listener) {
addListener(SelectedTabChangeEvent.class, listener,
SELECTED_TAB_CHANGE_METHOD);
}
/**
* Removes the selected tab change listener
*
* @param listener
* the Listener to be removed.
*/
public void removeListener(SelectedTabChangeListener listener) {
removeListener(SelectedTabChangeEvent.class, listener,
SELECTED_TAB_CHANGE_METHOD);
}
/**
* Emits the options change event.
*/
protected void fireSelectedTabChange() {
fireEvent(new SelectedTabChangeEvent(this));
}
/*
* We need to repaint on child repaint due the way captions and icons are
* handled
*/
public void repaintRequested(RepaintRequestEvent event) {
requestRepaint();
}
}
|
