| org.millstone.base.terminal.PaintTarget
All known Subclasses: org.millstone.webadapter.WebPaintTarget,
| PaintTarget | | public interface PaintTarget (Code) | | This interface defines the methods for
painting XML to the UIDL stream.
author:
IT Mill Ltd.
version:
3.1.1
since:
3.0 |
| Method Summary | |
| public void | addAttribute(String name, boolean value)
Adds a boolean attribute to component. | | public void | addAttribute(String name, int value)
Adds a integer attribute to component. | | public void | addAttribute(String name, Resource value)
Adds a resource attribute to component. | | public void | addAttribute(String name, long value)
Adds a long attribute to component. | | public void | addAttribute(String name, String value)
Adds a string attribute to component. | | void | addCharacterData(String text)
Add CDATA node to target UIDL-tree. | | public void | addSection(String sectionTagName, String sectionData)
Print single XMLsection.
Prints full XML section. | | void | addText(String text)
Add text node. | | public void | addUIDL(java.lang.String uidl)
Add UIDL directly. | | public void | addUploadStreamVariable(VariableOwner owner, String name)
Add a upload stream type variable. | | public void | addVariable(VariableOwner owner, String name, String value)
Add a string type variable. | | public void | addVariable(VariableOwner owner, String name, int value)
Add a int type variable. | | public void | addVariable(VariableOwner owner, String name, boolean value)
Add a boolean type variable. | | public void | addVariable(VariableOwner owner, String name, String[] value)
Add a string array type variable. | | public void | addXMLSection(String sectionTagName, String sectionData, String namespace)
Print single XML section.
Prints full XML section. | | public void | endTag(String tagName)
Print element end tag. | | public boolean | startTag(Paintable paintable, String tag)
Print element start tag of a paintable section.
Starts a paintable section using the given tag. | | public void | startTag(String tagName)
Print element start tag. |
| addAttribute | | public void addAttribute(String name, boolean value) throws PaintException(Code) | | Adds a boolean attribute to component.
Atributes must be added before any content is written.
Parameters:
name - Attribute name
Parameters:
value - Attribute value this object |
| addAttribute | | public void addAttribute(String name, int value) throws PaintException(Code) | | Adds a integer attribute to component.
Atributes must be added before any content is written.
Parameters:
name - Attribute name
Parameters:
value - Attribute value this object |
| addAttribute | | public void addAttribute(String name, Resource value) throws PaintException(Code) | | Adds a resource attribute to component.
Atributes must be added before any content is written.
Parameters:
name - Attribute name
Parameters:
value - Attribute value this object |
| addAttribute | | public void addAttribute(String name, long value) throws PaintException(Code) | | Adds a long attribute to component.
Atributes must be added before any content is written.
Parameters:
name - Attribute name
Parameters:
value - Attribute value this object |
| addAttribute | | public void addAttribute(String name, String value) throws PaintException(Code) | | Adds a string attribute to component.
Atributes must be added before any content is written.
Parameters:
name - Boolean attribute name
Parameters:
value - Boolean attribute value this object |
| addCharacterData | | void addCharacterData(String text) throws PaintException(Code) | | Add CDATA node to target UIDL-tree.
Parameters:
text - Character data to add
since:
3.1 |
| addSection | | public void addSection(String sectionTagName, String sectionData) throws PaintException(Code) | | Print single XMLsection.
Prints full XML section. The section data is escaped from XML tags and
surrounded by XML start and end-tags.
|
| addText | | void addText(String text) throws PaintException(Code) | | Add text node. All the contents of the text are XML-escaped.
Parameters:
text - Text to add |
| addUploadStreamVariable | | public void addUploadStreamVariable(VariableOwner owner, String name) throws PaintException(Code) | | Add a upload stream type variable.
Parameters:
owner - Listener for variable changes
Parameters:
name - Variable name
Parameters:
value - Variable initial value Reference to this. |
| addVariable | | public void addVariable(VariableOwner owner, String name, String value) throws PaintException(Code) | | Add a string type variable.
Parameters:
owner - Listener for variable changes
Parameters:
name - Variable name
Parameters:
value - Variable initial value Reference to this. |
| addVariable | | public void addVariable(VariableOwner owner, String name, int value) throws PaintException(Code) | | Add a int type variable.
Parameters:
owner - Listener for variable changes
Parameters:
name - Variable name
Parameters:
value - Variable initial value Reference to this. |
| addVariable | | public void addVariable(VariableOwner owner, String name, boolean value) throws PaintException(Code) | | Add a boolean type variable.
Parameters:
owner - Listener for variable changes
Parameters:
name - Variable name
Parameters:
value - Variable initial value Reference to this. |
| addVariable | | public void addVariable(VariableOwner owner, String name, String[] value) throws PaintException(Code) | | Add a string array type variable.
Parameters:
owner - Listener for variable changes
Parameters:
name - Variable name
Parameters:
value - Variable initial value Reference to this. |
| addXMLSection | | public void addXMLSection(String sectionTagName, String sectionData, String namespace) throws PaintException(Code) | | Print single XML section.
Prints full XML section. The section data must be XML and it is
surrounded by XML start and end-tags.
|
| endTag | | public void endTag(String tagName) throws PaintException(Code) | | Print element end tag.
If the parent tag is closed before
every child tag is closed an MillstoneException is raised.
Parameters:
tag - The name of the end tag
exception:
IOException - The writing failed due to input/output error |
| startTag | | public boolean startTag(Paintable paintable, String tag) throws PaintException(Code) | | 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.
Parameters:
paintable - The paintable to start
Parameters:
tagName - The name of the start tag true if paintable found in cache, false otherwise.
See Also: PaintTarget.startTag(String)
since:
3.1 |
| startTag | | public void startTag(String tagName) throws PaintException(Code) | | Print element start tag.
Todo:
Checking of input values
Parameters:
tagName - The name of the start tag |
|
|