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
|
/* *************************************************************************
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/license.txt. Use of this product might
require purchasing a commercial license from IT Mill Ltd. For guidelines
on usage, see license/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.terminal;
/** This interface defines the methods for
* painting XML to the UIDL stream.
*
* @author IT Mill Ltd.
* @version @VERSION@
* @since 3.0
*/
public interface PaintTarget {
/** Print single XMLsection.
*
* Prints full XML section. The section data is escaped from XML tags and
* surrounded by XML start and end-tags.
*/
public void addSection(String sectionTagName, String sectionData)
throws PaintException;
/** Print 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.
*
* If the Paintable 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.
*
* @param paintable The paintable to start
* @param tagName The name of the start tag
* @return true if paintable found in cache, false otherwise.
* @see #startTag(String)
* @since 3.1
*/
public boolean startTag(Paintable paintable, String tag)
throws PaintException;
/** Print element start tag.
*
* <pre>Todo:
* Checking of input values
* </pre>
*
* @param tagName The name of the start tag
*
*/
public void startTag(String tagName) throws PaintException;
/** Print element end tag.
*
* If the parent tag is closed before
* every child tag is closed an PaintException is raised.
*
* @param tag The name of the end tag
* @exception IOException The writing failed due to input/output error
*/
public void endTag(String tagName) throws PaintException;
/** Adds a boolean attribute to component.
* Atributes must be added before any content is written.
*
* @param name Attribute name
* @param value Attribute value
* @return this object
*/
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 Attribute name
* @param value Attribute value
* @return this object
*/
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 Attribute name
* @param value Attribute value
* @return this object
*/
public void addAttribute(String name, Resource value)
throws PaintException;
/** Adds a long attribute to component.
* Atributes must be added before any content is written.
*
* @param name Attribute name
* @param value Attribute value
* @return this object
*/
public void addAttribute(String name, long value) throws PaintException;
/** Adds a string attribute to component.
* Atributes must be added before any content is written.
*
* @param name Boolean attribute name
* @param value Boolean attribute value
* @return this object
*/
public void addAttribute(String name, String value) throws PaintException;
/** Add a string type variable.
* @param owner Listener for variable changes
* @param name Variable name
* @param value Variable initial value
* @return Reference to this.
*/
public void addVariable(VariableOwner owner, String name, String value)
throws PaintException;
/** Add a int type variable.
* @param owner Listener for variable changes
* @param name Variable name
* @param value Variable initial value
* @return Reference to this.
*/
public void addVariable(VariableOwner owner, String name, int value)
throws PaintException;
/** Add a boolean type variable.
* @param owner Listener for variable changes
* @param name Variable name
* @param value Variable initial value
* @return Reference to this.
*/
public void addVariable(VariableOwner owner, String name, boolean value)
throws PaintException;
/** Add a string array type variable.
* @param owner Listener for variable changes
* @param name Variable name
* @param value Variable initial value
* @return Reference to this.
*/
public void addVariable(VariableOwner owner, String name, String[] value)
throws PaintException;
/** Add a upload stream type variable.
* @param owner Listener for variable changes
* @param name Variable name
* @param value Variable initial value
* @return Reference to this.
*/
public void addUploadStreamVariable(VariableOwner owner, String name)
throws PaintException;
/** Print single XML section.
*
* Prints full XML section. The section data must be XML and it is
* surrounded by XML start and end-tags.
*/
public void addXMLSection(
String sectionTagName,
String sectionData,
String namespace)
throws PaintException;
/** Add UIDL directly.
* The UIDL must be valid in accordance with the UIDL.dtd
*/
public void addUIDL(java.lang.String uidl) throws PaintException;
/** Add text node. All the contents of the text are XML-escaped.
* @param text Text to add
*/
void addText(String text) throws PaintException;
/** Add CDATA node to target UIDL-tree.
* @param text Character data to add
* @since 3.1
*/
void addCharacterData(String text) throws PaintException;
}
|
