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
|
/*
* Copyright 2000-2016 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.vaadin.ui;
import java.util.Collections;
import java.util.Iterator;
import java.util.Objects;
import com.vaadin.server.ErrorMessage;
import com.vaadin.server.Resource;
import com.vaadin.server.SerializableFunction;
import com.vaadin.shared.ui.ContentMode;
import com.vaadin.shared.ui.composite.CompositeState;
/**
* Composite allows creating new UI components by composition of existing
* server-side components.
* <p>
* A composite is created by extending the Composite class and setting the
* composition root component using {@link #setCompositionRoot(Component)}.
* </p>
* <p>
* The composition root itself can contain more components. The advantage of
* wrapping it in a composite is that the details of the composition root, such
* as its public API, are hidden from the users of the composite.
* </p>
* <p>
* A composite itself does not contribute to the DOM in any way (contrary to
* {@link CustomComponent} which adds a {@code <div>} to the DOM.
* </p>
*
* @author Vaadin Ltd.
* @since 8.1
*/
public class Composite extends AbstractComponent implements HasComponents {
/**
* The contained component.
*/
private Component root = null;
/**
* Constructs a new empty composite.
* <p>
* Use {@link #setCompositionRoot(Component)} to define the contents of the
* composite.
*/
public Composite() {
}
/**
* Constructs a new composite containing the given component.
*
* @param compositionRoot
* the root of the composition component tree. It must not be
* null.
*/
public Composite(AbstractComponent compositionRoot) {
this();
Objects.requireNonNull(compositionRoot);
setCompositionRoot(compositionRoot);
}
/**
* Returns the composition root.
*
* @return the Component Composition root.
*/
protected Component getCompositionRoot() {
return root;
}
/**
* Sets the component contained in the composite.
* <p>
* You must set the composition root to a non-null value before the
* component can be used. It cannot be changed.
* </p>
*
* @param compositionRoot
* the root of the composition component tree.
*/
protected void setCompositionRoot(Component compositionRoot) {
if (root != null) {
throw new IllegalStateException(
"Composition root cannot be changed");
}
if (compositionRoot == null) {
throw new IllegalArgumentException(
"Composition root cannot be null");
}
// set new component
if (compositionRoot.getParent() != null) {
// If the component already has a parent, try to remove it
AbstractSingleComponentContainer.removeFromParent(compositionRoot);
}
compositionRoot.setParent(this);
root = compositionRoot;
markAsDirty();
}
/* Basic component features ------------------------------------------ */
@Override
public Iterator<Component> iterator() {
if (getCompositionRoot() != null) {
return Collections.singletonList(getCompositionRoot()).iterator();
} else {
return Collections.<Component> emptyList().iterator();
}
}
@Override
protected CompositeState getState() {
return (CompositeState) super.getState();
}
@Override
protected CompositeState getState(boolean markAsDirty) {
return (CompositeState) super.getState(markAsDirty);
}
@Override
public void beforeClientResponse(boolean initial) {
super.beforeClientResponse(initial);
if (getCompositionRoot() == null) {
throw new IllegalStateException(
"A composite must always have a composition root");
}
}
@Override
public String getStyleName() {
Component root = getCompositionRoot();
return root == null ? "" : root.getStyleName();
}
@Override
public void setStyleName(String style) {
getRootOrThrow().setStyleName(style);
}
@Override
public void setStyleName(String style, boolean add) {
getRootAbstractComponentOrThrow().setStyleName(style, add);
}
@Override
public void addStyleName(String style) {
getRootOrThrow().addStyleName(style);
}
@Override
public void removeStyleName(String style) {
getRootOrThrow().removeStyleName(style);
}
@Override
public String getPrimaryStyleName() {
return getRootAbstractComponentPropertyOrNull(
AbstractComponent::getPrimaryStyleName);
}
@Override
public void setPrimaryStyleName(String style) {
getRootOrThrow().setPrimaryStyleName(style);
}
private Component getRootOrThrow() {
Component root = getCompositionRoot();
if (root == null) {
throw new IllegalStateException(
"Composition root has not been set");
}
return root;
}
private AbstractComponent getRootAbstractComponentOrThrow() {
Component root = getRootOrThrow();
if (!(root instanceof AbstractComponent)) {
throw new IllegalStateException(
"Composition root is not AbstractComponent");
}
return (AbstractComponent) root;
}
private <T> T getRootPropertyOrNull(
SerializableFunction<Component, T> getter) {
Component root = getCompositionRoot();
return root == null ? null : getter.apply(root);
}
private <T> T getRootAbstractComponentPropertyOrNull(
SerializableFunction<AbstractComponent, T> getter) {
Component root = getCompositionRoot();
if (root instanceof AbstractComponent) {
return getter.apply((AbstractComponent) root);
}
return null;
}
@Override
public float getWidth() {
return getRootOrThrow().getWidth();
}
@Override
public float getHeight() {
return getRootOrThrow().getHeight();
}
@Override
public Unit getWidthUnits() {
return getRootOrThrow().getWidthUnits();
}
@Override
public Unit getHeightUnits() {
return getRootOrThrow().getHeightUnits();
}
@Override
public void setHeight(String height) {
getRootOrThrow().setHeight(height);
}
@Override
public void setWidth(float width, Unit unit) {
getRootOrThrow().setWidth(width, unit);
}
@Override
public void setHeight(float height, Unit unit) {
getRootOrThrow().setHeight(height, unit);
}
@Override
public void setWidth(String width) {
getRootOrThrow().setWidth(width);
}
@Override
public void setSizeFull() {
getRootOrThrow().setSizeFull();
}
@Override
public void setSizeUndefined() {
getRootOrThrow().setSizeUndefined();
}
@Override
public void setWidthUndefined() {
getRootOrThrow().setWidthUndefined();
}
@Override
public void setHeightUndefined() {
getRootOrThrow().setHeightUndefined();
}
@Override
public void setId(String id) {
getRootOrThrow().setId(id);
}
@Override
public String getId() {
return getRootPropertyOrNull(Component::getId);
}
@Override
public void setDebugId(String id) {
getRootAbstractComponentOrThrow().setDebugId(id);
}
@Override
public String getDebugId() {
return getRootAbstractComponentPropertyOrNull(
AbstractComponent::getDebugId);
}
@Override
public String getCaption() {
return getRootPropertyOrNull(Component::getCaption);
}
@Override
public void setCaption(String caption) {
getRootOrThrow().setCaption(caption);
}
@Override
public void setCaptionAsHtml(boolean captionAsHtml) {
getRootAbstractComponentOrThrow().setCaptionAsHtml(captionAsHtml);
}
@Override
public boolean isCaptionAsHtml() {
return getRootAbstractComponentPropertyOrNull(
AbstractComponent::isCaptionAsHtml);
}
@Override
public Resource getIcon() {
return getRootPropertyOrNull(Component::getIcon);
}
@Override
public void setIcon(Resource icon) {
getRootOrThrow().setIcon(icon);
}
@Override
public String getDescription() {
return getRootOrThrow().getDescription();
}
@Override
public void setDescription(String description) {
getRootAbstractComponentOrThrow().setDescription(description);
}
@Override
public void setDescription(String description, ContentMode mode) {
getRootAbstractComponentOrThrow().setDescription(description, mode);
}
@Override
public ErrorMessage getErrorMessage() {
return getRootAbstractComponentPropertyOrNull(
AbstractComponent::getErrorMessage);
}
@Override
public ErrorMessage getComponentError() {
return getRootAbstractComponentPropertyOrNull(
AbstractComponent::getComponentError);
}
@Override
public void setComponentError(ErrorMessage componentError) {
getRootAbstractComponentOrThrow().setComponentError(componentError);
}
}
|