| org.apache.tapestry.MarkupWriter
All known Subclasses: org.apache.tapestry.internal.services.MarkupWriterImpl,
| MarkupWriter | | public interface MarkupWriter (Code) | | An interface used by objects, such as Tapestry components, that need to render themselves as some
form of XML markup. A markup writer maintains the idea of a current element. Attributes are added
to the current element, and new text and elements are placed inside the current element. In this
way, the markup writer maintains a facade that XML markup is generated as a stream, even though
the implementation builds a kind of DOM tree. The DOM tree can be also be manipulated. This
solves a number of problems from Tapestry 4 (and earlier) where random access to the DOM was
desired and had to be simulated through complex buffering.
|
| attributes | | void attributes(Object... namesAndValues)(Code) | | Adds a series of attributes and values. Null values are quietly skipped. If a name already
has a value, then the new value is ignored.
|
| comment | | void comment(String text)(Code) | | Adds an XML comment. The text should be just the comment content, the comment delimiters will
be provided.
|
| element | | Element element(String name, Object... attributes)(Code) | | Begins a new element as a child of the current element. The new element becomes the current
element. The new Element is returned and can be directly manipulated (possibly at a later
date). Optionally, attributes for the new element can be specified directly.
If the element is intended to be clickable or submittable in the
org.apache.tapestry.test.PageTester , you should call
MarkupWriter.linkElement(String,Link,Object[]) instead.
Parameters:
name - the name of the element to create
Parameters:
attributes - an even number of values, alternating names and values the new DOM Element node
See Also: MarkupWriter.attributes(Object[]) |
| end | | Element end()(Code) | | Ends the current element. The new current element will be the parent element. Returns the new
current element (which may be null when ending the root element for the document).
|
| getDocument | | Document getDocument()(Code) | | Returns the Document into which this writer creates elements or other nodes.
|
| getElement | | Element getElement()(Code) | | Returns the currently active element.
|
| toMarkup | | void toMarkup(PrintWriter writer)(Code) | | Converts the collected markup into an markup stream (according to rules provided by the
Document 's
MarkupModel ). The markup stream is sent to the writer.
|
| write | | void write(String text)(Code) | | Writes the text as a child of the current element.
TODO: Filtering of XML entities.
|
| writeRaw | | void writeRaw(String text)(Code) | | Writes raw text, text with existing markup that should be passed through the
client without change. This can be useful when the markup is read from an external source (a
file or a database) and is simply to be included.
Parameters:
text -
See Also: Raw |
|
|