Class AjaxPaintTarget

User Interface Description Language Target.

Synopsis

VERSION@

Since

3.1

Inheritance Path.  java.lang.Object-> com.itmill.toolkit.terminal.web.AjaxPaintTarget

AjaxPaintTarget(AjaxVariableMap, AjaxApplicationManager, OutputStream)

Parameters

out

A character-output stream.

Create a new XMLPrintWriter, without automatic line flushing.

addAttribute(String, boolean)

Parameters

name

Attribute name

value

Attribute value

Adds a boolean attribute to component. Atributes must be added before any content is written.

addAttribute(String, int)

Parameters

name

Attribute name

value

Attribute value

return

this object

Adds a integer attribute to component. Atributes must be added before any content is written.

addAttribute(String, long)

Parameters

name

Attribute name

value

Attribute value

return

this object

Adds a long attribute to component. Atributes must be added before any content is written.

addAttribute(String, Resource)

Parameters

name

Attribute name

value

Attribute value

Adds a resource attribute to component. Atributes must be added before any content is written.

addAttribute(String, String)

Parameters

name

Boolean attribute name

value

Boolean attribute value

return

this object

Adds a string attribute to component. Atributes must be added before any content is written.

addCharacterData(String)

Parameters

text

Character data to add

Description copied from interface: addCharacterData

Add CDATA node to target UIDL-tree.

addSection(String, String)

Print single text section. Prints full text section. The section data is escaped from XML tags and surrounded by XML start and end-tags.

addText(String)

Print XML-escaped text.

addUIDL(String)

Add XML dirctly to UIDL

addUploadStreamVariable(VariableOwner, String)

Parameters

owner

Listener for variable changes

name

Variable name

value

Variable initial value

return

Reference to this.

Add a upload stream type variable.

addVariable(VariableOwner, String, boolean)

Parameters

owner

Listener for variable changes

name

Variable name

value

Variable initial value

return

Reference to this.

Add a boolean type variable.

addVariable(VariableOwner, String, int)

Parameters

owner

Listener for variable changes

name

Variable name

value

Variable initial value

return

Reference to this.

Add a int type variable.

addVariable(VariableOwner, String, String)

Parameters

owner

Listener for variable changes

name

Variable name

value

Variable initial value

return

Reference to this.

Add a string type variable.

addVariable(VariableOwner, String, String[])

Parameters

owner

Listener for variable changes

name

Variable name

value

Variable initial value

return

Reference to this.

Add a string array type variable.

addXMLSection(String, String, String)

Add XML section with namespace

close()

Close the paint target. Paint target must be closed before the getUIDL() cn be called. Subsequent attempts to write to paint target. If the target was already closed, call to this function is ignored. will generate an exception.

endTag(String)

Parameters

tag

The name of the end tag

Print element end tag. If the parent tag is closed before every child tag is closed an PaintException is raised.

escapeXML(String)

Parameters

return

A new string instance where all occurrences of XML sensitive characters are substituted with entities.

Substitute the XML sensitive characters with predefined XML entities.

escapeXML(StringBuffer)

Parameters

xml

the String to be substituted

return

A new StringBuffer instance where all occurrences of XML sensitive characters are substituted with entities.

Substitute the XML sensitive characters with predefined XML entities.

getNumberOfPaints()

Parameters

return

Get number of paints.

getUIDL()

Get the UIDL already printed to stream. Paint target must be closed before the getUIDL() cn be called.

setTrackPaints(boolean)

Parameters

trackPaints

Set tracking to true or false. This also resets the number of paints.

startTag(Paintable, String)

Parameters

paintable

The paintable to start

tagName

The name of the start tag

return

true if paintable found in cache, false otherwise.

Description copied from interface: startTag

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.

startTag(String)

Parameters

tagName

The name of the start tag

Print element start tag.

 Todo:
  Checking of input values