FragmentAssembler - JBOSS Portal 2.4 API 英文版文档

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.portal.theme.render
Interface FragmentAssembler

public interface FragmentAssembler

Express the capability to assemble the fragments presented by a markup result into a markup response.

The markup result is an abstraction ontop of page, window, portlet , etc. results, and contains the markup fragments that were produced by the portlet container. The fragment assemblers responsibility is to take these fragments, and assemble them into a markup response that can be sent back to the displaying device.

Method Summary

void assemble(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, MarkupResult markupResult)
Assemble the markup fragments from the individual component invocations into a response, and write it out.

void setPageService(PageService pageService)
provide a page service reference that can be used during the assembly to access the page, layout, and theme service

Method Detail

assemble

public void assemble(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response,
                     MarkupResult markupResult)
              throws java.io.IOException,
                     javax.servlet.ServletException

Assemble the markup fragments from the individual component invocations into a response, and write it out.

Parameters:: request - the client request; response - the client response; markupResult - the result (page, region, window) containing the markup fragment(s) to assemble
Throws:: java.io.IOException; javax.servlet.ServletException

setPageService

public void setPageService(PageService pageService)

provide a page service reference that can be used during the assembly to access the page, layout, and theme service

Parameters:: pageService - the page service to allow access to themes and layouts