Interface PartialTemplateRenderer

  • All Known Implementing Classes:

    public interface PartialTemplateRenderer
    Service that provides methods that render Blocks (<t:block> in the template), component instances and RenderCommands 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.
    • Method Detail

      • render

        java.lang.String render​(java.lang.Object object)
        Renders an object, probably a Block 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 implement RenderCommand or being able to be coerced to it by TypeCoercer.
        object - an object, probably a Block or component instance or RenderCommand.
        java.lang.IllegalArgumentException - if the object isn't a RenderCommand and cannot be coerced to it by TypeCoercer.