PortalLayout - 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
Class PortalLayout

java.lang.Object
  org.jboss.portal.theme.PortalLayout

Direct Known Subclasses:: JSPLayout

public abstract class PortalLayout
extends java.lang.Object

Implementation of a PortalLayout.

An instance of this class represents the meta data of a portal layout.

Constructor Summary

PortalLayout()
          Layouts need an empty constructor (they are loaded via reflection)

Method Summary

abstract void assembleResponse(ServerRequest request, ServerResponse response, MarkupResult markupResult)
          Assemble the fragments created by the portlet render process into a response and send it back to the client (write it to the response)

void destroy()
          destroy this layout (cleanup time)

LayoutInfo getLayoutInfo()


RenderContext getRenderContext(HTTPStreamInfo streamInfo, ServerRequest request, MarkupResult markupResult)
          Create a new render context for this request and layout

LayoutServiceInfo getServiceInfo()


void init(LayoutServiceInfo serviceInfo, LayoutInfo info)
          Initialize the layout with a handle to the layout service and the layout's meta data

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortalLayout

public PortalLayout()

Layouts need an empty constructor (they are loaded via reflection)

Method Detail

assembleResponse

public abstract void assembleResponse(ServerRequest request,
                                      ServerResponse response,
                                      MarkupResult markupResult)
                               throws javax.servlet.ServletException,
                                      java.io.IOException

Assemble the fragments created by the portlet render process into a response and send it back to the client (write it to the response)

Parameters:: request - the current server request; response - the current server response; markupResult - the result containing the information about what was rendered and what the resulting markup fragments are
Throws:: javax.servlet.ServletException; java.io.IOException

init

public void init(LayoutServiceInfo serviceInfo,
                 LayoutInfo info)

Initialize the layout with a handle to the layout service and the layout's meta data

Parameters:: serviceInfo - a reference to the layout service; info - the layout's meta data (the parsed content of the layout descriptor)

destroy

public void destroy()

destroy this layout (cleanup time)

getLayoutInfo

public LayoutInfo getLayoutInfo()

Returns:: the parsed meta data of this layout

getServiceInfo

public LayoutServiceInfo getServiceInfo()

Returns:: a reference to the layout service

getRenderContext

public RenderContext getRenderContext(HTTPStreamInfo streamInfo,
                                      ServerRequest request,
                                      MarkupResult markupResult)

Create a new render context for this request and layout

Parameters:: streamInfo - the information about the content type and encoding this layout should produce; request - the current server request; markupResult - the result of the portlet render process
Returns:: a new render context