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
|
/* *************************************************************************
IT Mill Toolkit
Development of Browser User Interfaces Made Easy
Copyright (C) 2000-2006 IT Mill Ltd
*************************************************************************
This product is distributed under commercial license that can be found
from the product package on license.pdf. Use of this product might
require purchasing a commercial license from IT Mill Ltd. For guidelines
on usage, see licensing-guidelines.html
*************************************************************************
For more information, contact:
IT Mill Ltd phone: +358 2 4802 7180
Ruukinkatu 2-4 fax: +358 2 4802 7181
20540, Turku email: info@itmill.com
Finland company www: www.itmill.com
Primary source for information and releases: www.itmill.com
********************************************************************** */
package com.itmill.toolkit.ui;
import com.itmill.toolkit.terminal.PaintException;
import com.itmill.toolkit.terminal.PaintTarget;
import java.util.Iterator;
import java.util.HashMap;
/**
* <p>
* A container component with freely designed layout and style. The container
* consists of items with textually represented locations. Each item contains
* one sub-component. The adapter and theme are responsible for rendering the
* layout with given style by placing the items on the screen in defined
* locations.
* </p>
*
* <p>
* The definition of locations is not fixed - the each style can define its
* locations in a way that is suitable for it. One typical example would be to
* create visual design for a web site as a custom layout: the visual design
* could define locations for "menu", "body" and "title" for example. The layout
* would then be implemented as XLS-template with for given style.
* </p>
*
* <p>
* The default theme handles the styles that are not defined by just drawing the
* subcomponents as in OrderedLayout.
* </p>
*
* @author IT Mill Ltd.
* @version
* @VERSION@
* @since 3.0
*/
public class CustomLayout extends AbstractComponentContainer implements Layout {
/**
* Custom layout slots containing the components.
*/
private HashMap slots = new HashMap();
private String templateName;
/**
* Constructor for custom layout with given template name.
*/
public CustomLayout(String template) {
templateName = template;
}
/**
* Gets the component UIDL tag.
*
* @return the Component UIDL tag as string.
*/
public String getTag() {
return "customlayout";
}
/**
* Adds the component into this container to given location.
*
* @param c
* the component to be added.
* @param location
* the location of the component.
*/
public void addComponent(Component c, String location) {
Component old = (Component) slots.get(location);
if (old != null) {
removeComponent(old);
}
slots.put(location, c);
c.setParent(this);
fireComponentAttachEvent(c);
requestRepaint();
}
/**
* Adds the component into this container. The component is added without
* specifying the location (empty string is then used as location). Only one
* component can be added to the default "" location and adding more
* components into that location overwrites the old components.
*
* @param c
* the component to be added.
*/
public void addComponent(Component c) {
this.addComponent(c, "");
}
/**
* Removes the component from this container.
*
* @param c
* the component to be removed.
*/
public void removeComponent(Component c) {
if (c == null)
return;
slots.values().remove(c);
c.setParent(null);
fireComponentDetachEvent(c);
requestRepaint();
}
/**
* Removes the component from this container from given location.
*
* @param location
* the Location identifier of the component.
*/
public void removeComponent(String location) {
this.removeComponent((Component) slots.get(location));
}
/**
* 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 slots.values().iterator();
}
/**
* Gets the child-component by its location.
*
* @param location
* the name of the location where the requested component
* resides.
* @return the Component in the given location or null if not found.
*/
public Component getComponent(String location) {
return (Component) slots.get(location);
}
/**
* Paints the content of this component.
*
* @param target
* @throws PaintException
* if the paint operation failed.
*/
public void paintContent(PaintTarget target) throws PaintException {
target.addAttribute("template", templateName);
// Adds all items in all the locations
for (Iterator i = slots.keySet().iterator(); i.hasNext();) {
// Gets the (location,component)
String location = (String) i.next();
Component c = (Component) slots.get(location);
if (c != null) {
// Writes the item
target.startTag("location");
target.addAttribute("name", location);
c.paint(target);
target.endTag("location");
}
}
}
/* Documented in superclass */
public void replaceComponent(Component oldComponent, Component newComponent) {
// Gets the locations
String oldLocation = null;
String newLocation = null;
for (Iterator i = slots.keySet().iterator(); i.hasNext();) {
String location = (String) i.next();
Component component = (Component) slots.get(location);
if (component == oldComponent)
oldLocation = location;
if (component == newComponent)
newLocation = location;
}
if (oldLocation == null)
addComponent(newComponent);
else if (newLocation == null) {
removeComponent(oldLocation);
addComponent(newComponent, oldLocation);
} else {
slots.put(newLocation, oldComponent);
slots.put(oldLocation, newComponent);
requestRepaint();
}
}
/**
* CustomLayout's template selecting was previously implemented with
* setStyle. Overriding to improve backwards compatibility.
*
* @param name
* template name
*/
public void setStyle(String name) {
setTemplateName(name);
}
/** Get the name of the template */
public String getTemplateName() {
return templateName;
}
/**
* Set the name of the template used to draw custom layout.
*
* With GWT-adapter, the template with name 'templatename' is loaded from
* ITMILL/themes/themename/layouts/templatename.html. If the theme has not
* been set (with Application.setTheme()), themename is 'default'.
*
* @param templateName
*/
public void setTemplateName(String templateName) {
this.templateName = templateName;
requestRepaint();
}
}
|
