Package org.apache.tapestry5.services
Interface PartialTemplateRenderer
- All Known Implementing Classes:
PartialTemplateRendererImpl
public interface PartialTemplateRenderer
Service that provides methods that render
Block
s (<t:block>
in the template),
component instances and RenderCommand
s to a String
or
org.apache.tapestry5.dom.Document
in a programatic way.
This service was created for situations in which a page or component needs to generate some markup
that wouldn't be rendered normally, but for external use, such as e-mails, returning
HTML for AJAX requests or passing HTML instead of plain string for an Alert
.
The name of this interface comes from TAP5-938:
Expose ability to render a portion of a page (a Block, Component, etc.) without using internal services.- Since:
- 5.4
-
Method Summary
Modifier and TypeMethodDescriptionRenders an object, probably aBlock
or component instance, to a string.renderAsDocument
(Object object) Renders an object to aDocument
following the same rules asrender(Object)
This method supposes any kind of initialization needed was already done.
-
Method Details
-
render
Renders an object, probably aBlock
or component instance, to a string. This method supposes any kind of initialization needed was already done. CSS and JavaScript inclusions or importings are ignored. The object must implementRenderCommand
or being able to be coerced to it byTypeCoercer
.- Parameters:
object
- an object, probably aBlock
or component instance orRenderCommand
.- Throws:
IllegalArgumentException
- if the object isn't aRenderCommand
and cannot be coerced to it byTypeCoercer
.
-
renderAsDocument
Renders an object to aDocument
following the same rules asrender(Object)
This method supposes any kind of initialization needed was already done. CSS and JavaScript inclusions or importings are ignored.- Parameters:
object
- to render, aRenderCommand
, or coercible to one- Returns:
- a
Document
.
-