Class MarkupWriterImpl
java.lang.Object
org.apache.tapestry5.internal.services.MarkupWriterImpl
- All Implemented Interfaces:
MarkupWriter
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new instance of the MarkupWriter with aDefaultMarkupModel
.MarkupWriterImpl
(MarkupModel model) MarkupWriterImpl
(MarkupModel model, String encoding, String mimeType) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addListener
(MarkupWriterListener listener) Adds a markup writer listener that will be notified as elements are started and ended.attributeNS
(String namespace, String attributeName, String attributeValue) Creates an attribute within the namespace for the current element.void
attributes
(Object... namesAndValues) Adds a series of attributes and values.void
Adds parsed character content.void
Adds an XML comment.defineNamespace
(String namespace, String namespacePrefix) Defines a namespace for the currently active element.Begins a new element as a child of the current element.Starts an element within the given namespace.end()
Ends the current element.Returns the Document into which this writer creates elements or other nodes.Returns the currently active element.void
removeListener
(MarkupWriterListener listener) Removes a previously added listener.void
toMarkup
(PrintWriter writer) Converts the collected markup into an markup stream (according to rules provided by theDocument
'sMarkupModel
).toString()
void
Writes the text as a child of the current element.void
Writes a formatted string.void
Writes raw text, text with existing markup that should be passed through the client without change.
-
Constructor Details
-
MarkupWriterImpl
public MarkupWriterImpl()Creates a new instance of the MarkupWriter with aDefaultMarkupModel
. -
MarkupWriterImpl
-
MarkupWriterImpl
-
-
Method Details
-
toMarkup
Description copied from interface:MarkupWriter
Converts the collected markup into an markup stream (according to rules provided by theDocument
'sMarkupModel
). The markup stream is sent to the writer.- Specified by:
toMarkup
in interfaceMarkupWriter
-
toString
-
getDocument
Description copied from interface:MarkupWriter
Returns the Document into which this writer creates elements or other nodes.- Specified by:
getDocument
in interfaceMarkupWriter
-
getElement
Description copied from interface:MarkupWriter
Returns the currently active element.- Specified by:
getElement
in interfaceMarkupWriter
-
cdata
Description copied from interface:MarkupWriter
Adds parsed character content. This will be enclosed in a CDATA block if supported. When not supported, this is the same asMarkupWriter.write(String)
.- Specified by:
cdata
in interfaceMarkupWriter
- Parameters:
content
- pre-parsed content
-
write
Description copied from interface:MarkupWriter
Writes the text as a child of the current element.- Specified by:
write
in interfaceMarkupWriter
-
writef
Description copied from interface:MarkupWriter
Writes a formatted string.- Specified by:
writef
in interfaceMarkupWriter
-
attributes
Description copied from interface:MarkupWriter
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.- Specified by:
attributes
in interfaceMarkupWriter
-
element
Description copied from interface:MarkupWriter
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.- Specified by:
element
in interfaceMarkupWriter
- Parameters:
name
- the name of the element to createnamesAndValues
- an even number of values, alternating names and values- Returns:
- the new DOM Element node
- See Also:
-
writeRaw
Description copied from interface:MarkupWriter
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.- Specified by:
writeRaw
in interfaceMarkupWriter
- See Also:
-
end
Description copied from interface:MarkupWriter
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).- Specified by:
end
in interfaceMarkupWriter
-
comment
Description copied from interface:MarkupWriter
Adds an XML comment. The text should be just the comment content, the comment delimiters will be provided. Note that, as of Tapestry 5.2., no extra whitespace is added (previous releases added a space around the text).- Specified by:
comment
in interfaceMarkupWriter
-
attributeNS
Description copied from interface:MarkupWriter
Creates an attribute within the namespace for the current element.- Specified by:
attributeNS
in interfaceMarkupWriter
- Parameters:
namespace
- URI containing the elementattributeName
- name of the attribute within the namespaceattributeValue
- the value for the attribute- Returns:
- the currently active element
-
defineNamespace
Description copied from interface:MarkupWriter
Defines a namespace for the currently active element. The namespace URI will be mapped to the provided namespace prefix within the Element.- Specified by:
defineNamespace
in interfaceMarkupWriter
- Parameters:
namespace
- the namespace URInamespacePrefix
- the prefix for elements and attributes associated with the namespace (may be the empty string for the default namespace)- Returns:
- the currently active element
-
elementNS
Description copied from interface:MarkupWriter
Starts an element within the given namespace. The correct namespace prefix will be identified and used. Must be balanced by a call toMarkupWriter.end()
.- Specified by:
elementNS
in interfaceMarkupWriter
- Parameters:
namespace
- URI containing the elementelementName
- name of the element within the namespace- Returns:
- the new Element
-
addListener
Description copied from interface:MarkupWriter
Adds a markup writer listener that will be notified as elements are started and ended.- Specified by:
addListener
in interfaceMarkupWriter
-
removeListener
Description copied from interface:MarkupWriter
Removes a previously added listener.- Specified by:
removeListener
in interfaceMarkupWriter
-