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
|
/*
* Copyright 2011 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.terminal;
import java.io.Serializable;
import java.util.Map;
import com.vaadin.terminal.StreamVariable.StreamingStartEvent;
import com.vaadin.terminal.gwt.server.ClientConnector;
import com.vaadin.ui.Component;
/**
* This interface defines the methods for painting XML to the UIDL stream.
*
* @author Vaadin Ltd.
* @since 3.0
*/
public interface PaintTarget extends Serializable {
/**
* Prints single XMLsection.
*
* Prints full XML section. The section data is escaped from XML tags and
* surrounded by XML start and end-tags.
*
* @param sectionTagName
* the name of the tag.
* @param sectionData
* the scetion data.
* @throws PaintException
* if the paint operation failed.
*/
public void addSection(String sectionTagName, String sectionData)
throws PaintException;
/**
* Result of starting to paint a Component (
* {@link PaintTarget#startPaintable(Component, String)}).
*
* @since 7.0
*/
public enum PaintStatus {
/**
* Painting started, addVariable() and addAttribute() etc. methods may
* be called.
*/
PAINTING,
/**
* A previously unpainted or painted {@link Component} has been queued
* be created/update later in a separate change in the same set of
* changes.
*/
CACHED
}
/**
* Prints element start tag of a paintable section. Starts a paintable
* section using the given tag. The PaintTarget may implement a caching
* scheme, that checks the paintable has actually changed or can a cached
* version be used instead. This method should call the startTag method.
* <p>
* If the {@link Component} is found in cache and this function returns true
* it may omit the content and close the tag, in which case cached content
* should be used.
* </p>
* <p>
* This method may also add only a reference to the paintable and queue the
* paintable to be painted separately.
* </p>
* <p>
* Each paintable being painted should be closed by a matching
* {@link #endPaintable(Component)} regardless of the {@link PaintStatus}
* returned.
* </p>
*
* @param paintable
* the paintable to start.
* @param tag
* the name of the start tag.
* @return {@link PaintStatus} - ready to paint or already cached on the
* client (also used for sub paintables that are painted later
* separately)
* @throws PaintException
* if the paint operation failed.
* @see #startTag(String)
* @since 7.0 (previously using startTag(Paintable, String))
*/
public PaintStatus startPaintable(Component paintable, String tag)
throws PaintException;
/**
* Prints paintable element end tag.
*
* Calls to {@link #startPaintable(Component, String)}should be matched by
* {@link #endPaintable(Component)}. If the parent tag is closed before
* every child tag is closed a PaintException is raised.
*
* @param paintable
* the paintable to close.
* @throws PaintException
* if the paint operation failed.
* @since 7.0 (previously using engTag(String))
*/
public void endPaintable(Component paintable) throws PaintException;
/**
* Prints element start tag.
*
* <pre>
* Todo:
* Checking of input values
* </pre>
*
* @param tagName
* the name of the start tag.
* @throws PaintException
* if the paint operation failed.
*/
public void startTag(String tagName) throws PaintException;
/**
* Prints element end tag.
*
* If the parent tag is closed before every child tag is closed an
* PaintException is raised.
*
* @param tagName
* the name of the end tag.
* @throws PaintException
* if the paint operation failed.
*/
public void endTag(String tagName) throws PaintException;
/**
* Adds a boolean attribute to component. Atributes must be added before any
* content is written.
*
* @param name
* the Attribute name.
* @param value
* the Attribute value.
*
* @throws PaintException
* if the paint operation failed.
*/
public void addAttribute(String name, boolean value) throws PaintException;
/**
* Adds a integer attribute to component. Atributes must be added before any
* content is written.
*
* @param name
* the Attribute name.
* @param value
* the Attribute value.
*
* @throws PaintException
* if the paint operation failed.
*/
public void addAttribute(String name, int value) throws PaintException;
/**
* Adds a resource attribute to component. Atributes must be added before
* any content is written.
*
* @param name
* the Attribute name
* @param value
* the Attribute value
*
* @throws PaintException
* if the paint operation failed.
*/
public void addAttribute(String name, Resource value) throws PaintException;
/**
* Adds details about {@link StreamVariable} to the UIDL stream. Eg. in web
* terminals Receivers are typically rendered for the client side as URLs,
* where the client side implementation can do an http post request.
* <p>
* The urls in UIDL message may use Vaadin specific protocol. Before
* actually using the urls on the client side, they should be passed via
* {@link com.vaadin.client.ApplicationConnection#translateVaadinUri(String)}.
* <p>
* Note that in current terminal implementation StreamVariables are cleaned
* from the terminal only when:
* <ul>
* <li>a StreamVariable with same name replaces an old one
* <li>the variable owner is no more attached
* <li>the developer signals this by calling
* {@link StreamingStartEvent#disposeStreamVariable()}
* </ul>
* Most commonly a component developer can just ignore this issue, but with
* strict memory requirements and lots of StreamVariables implementations
* that reserve a lot of memory this may be a critical issue.
*
* @param owner
* the ReceiverOwner that can track the progress of streaming to
* the given StreamVariable
* @param name
* an identifying name for the StreamVariable
* @param value
* the StreamVariable to paint
*
* @throws PaintException
* if the paint operation failed.
*/
public void addVariable(VariableOwner owner, String name,
StreamVariable value) throws PaintException;
/**
* Adds a long attribute to component. Atributes must be added before any
* content is written.
*
* @param name
* the Attribute name.
* @param value
* the Attribute value.
*
* @throws PaintException
* if the paint operation failed.
*/
public void addAttribute(String name, long value) throws PaintException;
/**
* Adds a float attribute to component. Atributes must be added before any
* content is written.
*
* @param name
* the Attribute name.
* @param value
* the Attribute value.
*
* @throws PaintException
* if the paint operation failed.
*/
public void addAttribute(String name, float value) throws PaintException;
/**
* Adds a double attribute to component. Atributes must be added before any
* content is written.
*
* @param name
* the Attribute name.
* @param value
* the Attribute value.
*
* @throws PaintException
* if the paint operation failed.
*/
public void addAttribute(String name, double value) throws PaintException;
/**
* Adds a string attribute to component. Atributes must be added before any
* content is written.
*
* @param name
* the Boolean attribute name.
* @param value
* the Boolean attribute value.
*
* @throws PaintException
* if the paint operation failed.
*/
public void addAttribute(String name, String value) throws PaintException;
/**
* TODO
*
* @param name
* @param value
* @throws PaintException
*/
public void addAttribute(String name, Map<?, ?> value)
throws PaintException;
/**
* Adds a Component type attribute. On client side the value will be a
* terminal specific reference to corresponding component on client side
* implementation.
*
* @param name
* the name of the attribute
* @param value
* the Component to be referenced on client side
* @throws PaintException
*/
public void addAttribute(String name, Component value)
throws PaintException;
/**
* Adds a string type variable.
*
* @param owner
* the Listener for variable changes.
* @param name
* the Variable name.
* @param value
* the Variable initial value.
*
* @throws PaintException
* if the paint operation failed.
*/
public void addVariable(VariableOwner owner, String name, String value)
throws PaintException;
/**
* Adds a int type variable.
*
* @param owner
* the Listener for variable changes.
* @param name
* the Variable name.
* @param value
* the Variable initial value.
*
* @throws PaintException
* if the paint operation failed.
*/
public void addVariable(VariableOwner owner, String name, int value)
throws PaintException;
/**
* Adds a long type variable.
*
* @param owner
* the Listener for variable changes.
* @param name
* the Variable name.
* @param value
* the Variable initial value.
*
* @throws PaintException
* if the paint operation failed.
*/
public void addVariable(VariableOwner owner, String name, long value)
throws PaintException;
/**
* Adds a float type variable.
*
* @param owner
* the Listener for variable changes.
* @param name
* the Variable name.
* @param value
* the Variable initial value.
*
* @throws PaintException
* if the paint operation failed.
*/
public void addVariable(VariableOwner owner, String name, float value)
throws PaintException;
/**
* Adds a double type variable.
*
* @param owner
* the Listener for variable changes.
* @param name
* the Variable name.
* @param value
* the Variable initial value.
*
* @throws PaintException
* if the paint operation failed.
*/
public void addVariable(VariableOwner owner, String name, double value)
throws PaintException;
/**
* Adds a boolean type variable.
*
* @param owner
* the Listener for variable changes.
* @param name
* the Variable name.
* @param value
* the Variable initial value.
*
* @throws PaintException
* if the paint operation failed.
*/
public void addVariable(VariableOwner owner, String name, boolean value)
throws PaintException;
/**
* Adds a string array type variable.
*
* @param owner
* the Listener for variable changes.
* @param name
* the Variable name.
* @param value
* the Variable initial value.
*
* @throws PaintException
* if the paint operation failed.
*/
public void addVariable(VariableOwner owner, String name, String[] value)
throws PaintException;
/**
* Adds a Component type variable. On client side the variable value will be
* a terminal specific reference to corresponding component on client side
* implementation. When updated from client side, terminal will map the
* client side component reference back to a corresponding server side
* reference.
*
* @param owner
* the Listener for variable changes
* @param name
* the name of the variable
* @param value
* the initial value of the variable
*
* @throws PaintException
* if the paint oparation fails
*/
public void addVariable(VariableOwner owner, String name, Component value)
throws PaintException;
/**
* Adds a upload stream type variable.
*
* @param owner
* the Listener for variable changes.
* @param name
* the Variable name.
*
* @throws PaintException
* if the paint operation failed.
*/
public void addUploadStreamVariable(VariableOwner owner, String name)
throws PaintException;
/**
* Prints single XML section.
* <p>
* Prints full XML section. The section data must be XML and it is
* surrounded by XML start and end-tags.
* </p>
*
* @param sectionTagName
* the tag name.
* @param sectionData
* the section data to be printed.
* @param namespace
* the namespace.
* @throws PaintException
* if the paint operation failed.
*/
public void addXMLSection(String sectionTagName, String sectionData,
String namespace) throws PaintException;
/**
* Adds UIDL directly. The UIDL must be valid in accordance with the
* UIDL.dtd
*
* @param uidl
* the UIDL to be added.
* @throws PaintException
* if the paint operation failed.
*/
public void addUIDL(java.lang.String uidl) throws PaintException;
/**
* Adds text node. All the contents of the text are XML-escaped.
*
* @param text
* the Text to add
* @throws PaintException
* if the paint operation failed.
*/
void addText(String text) throws PaintException;
/**
* Adds CDATA node to target UIDL-tree.
*
* @param text
* the Character data to add
* @throws PaintException
* if the paint operation failed.
* @since 3.1
*/
void addCharacterData(String text) throws PaintException;
public void addAttribute(String string, Object[] keys);
/**
* @return the "tag" string used in communication to present given
* {@link ClientConnector} type. Terminal may define how to present
* the connector.
*/
public String getTag(ClientConnector paintable);
/**
* @return true if a full repaint has been requested. E.g. refresh in a
* browser window or such.
*/
public boolean isFullRepaint();
}
|
