--- title: Interfaces and Abstractions order: 2 layout: page --- [[components.interfaces]] = Interfaces and Abstractions ((("interfaces"))) Vaadin user interface components are built on a skeleton of interfaces and abstract classes that define and implement the features common to all components and the basic logic how the component states are serialized between the server and the client. This section gives details on the basic component interfaces and abstractions. The layout and other component container abstractions are described in <>. The interfaces that define the Vaadin data model are described in <>. [[figure.components.interfaces]] .Component interfaces and abstractions image::img/component-abstractions.png[width=100%, scaledwidth=100%] All components are connectors that connect to the client-side widgets. ((("[classname]#Serializable#"))) In addition to the interfaces defined within the Vaadin framework, all components implement the [classname]#java.io.Serializable# interface to allow serialization. Serialization is needed in many clustering and cloud computing solutions. [[components.interfaces.component]] == [classname]#Component# Interface ((("[interfacename]#Component# interface"))) The [interfacename]#Component# interface is paired with the [classname]#AbstractComponent# class, which implements all the methods defined in the interface. === Component Tree Management Components are laid out in the user interface hierarchically. The layout is managed by layout components, or more generally components that implement the [classname]#ComponentContainer# interface. Such a container is the parent of the contained components. The [methodname]#getParent()# method allows retrieving the parent component of a component. While there is a [methodname]#setParent()#, you rarely need it as you usually add components with the [methodname]#addComponent()# method of the [classname]#ComponentContainer# interface, which automatically sets the parent. A component does not know its parent when the component is still being created, so you can not refer to the parent in the constructor with [methodname]#getParent()#. Attaching a component to an UI triggers a call to its [methodname]#attach()# method. Correspondingly, removing a component from a container triggers calling the [methodname]#detach()# method. If the parent of an added component is already connected to the UI, the [methodname]#attach()# is called immediately from [methodname]#setParent()#. [source, java] ---- public class AttachExample extends CustomComponent { public AttachExample() { } @Override public void attach() { super.attach(); // Must call. // Now we know who ultimately owns us. ClassResource r = new ClassResource("smiley.jpg"); Image image = new Image("Image:", r); setCompositionRoot(image); } } ---- The attachment logic is implemented in [classname]#AbstractComponent#, as described in <>. ((("[classname]#Component# interface"))) [[components.interfaces.abstractcomponent]] == [classname]#AbstractComponent# ((("[classname]#AbstractComponent#", id="term.components.interfaces.abstractcomponent", range="startofrange"))) [classname]#AbstractComponent# is the base class for all user interface components. It is the (only) implementation of the [classname]#Component# interface, implementing all the methods defined in the interface. When creating a new component, you should extend [classname]#AbstractComponent# or one of its subclasses. (((range="endofrange", startref="term.components.interfaces.abstractcomponent"))) value='artonge/backport/stable27/47770'>artonge/backport/stable27/47770 Nextcloud server, a safe home for all your data: https://github.com/nextcloud/serverwww-data
aboutsummaryrefslogtreecommitdiffstats
path: root/lib/private/NavigationManager.php
blob: 5d71c83e77a3c48bd6671bb466810aacc5536827 (plain) 
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