org.apache.pluto.portalImpl.aggregation
Class PortletFragment

java.lang.Object
  org.apache.pluto.portalImpl.aggregation.AbstractFragment
      org.apache.pluto.portalImpl.aggregation.AbstractFragmentSingle
          org.apache.pluto.portalImpl.aggregation.PortletFragment

All Implemented Interfaces:

Fragment

public class PortletFragment
extends AbstractFragmentSingle

Responsible for rendering a single Portlet.

Requires two JSP files to exist, PortletFragmentHeader.jsp and PortletFragmentFooter.jsp. These pages define the header and footer of the portlet.

A PortletFragment.PortletInfo object is added to the request attributes and makes information about the Portlet available to the header and footer JSP pages.

Author:

Stephan Hesmer, Nick Lothian

Nested Class Summary

static class	PortletFragment.PortletInfo
static class	PortletFragment.PortletModeInfo
static class	PortletFragment.PortletWindowStateInfo

Field Summary

private Logger	log
static java.lang.String	PORTLET_ERROR_MSG
private PortletWindow	portletWindow

Fields inherited from class org.apache.pluto.portalImpl.aggregation.AbstractFragment

BASE_ROOT

Constructor Summary

PortletFragment(java.lang.String id, ServletConfig config, Fragment parent, Fragment fragDesc, Navigation navigation)

Method Summary

void	createURL(PortalURL url) Creates an URL pointing to this fragment
protected java.lang.String	getErrorMsg()
PortletWindow	getPortletWindow()
boolean	isPartOfURL(PortalURL url) Returns true if the fragment is part of the URL
void	service(HttpServletRequest request, HttpServletResponse response) Is called to render the fragment.

Methods inherited from class org.apache.pluto.portalImpl.aggregation.AbstractFragmentSingle

addChild, getChildFragments, postService, preService

Methods inherited from class org.apache.pluto.portalImpl.aggregation.AbstractFragment

getFragmentDescription, getId, getInitParameters, getInitParameterValue, getNavigation, getParent, getServletConfig

Methods inherited from class java.lang.Object

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

Field Detail

portletWindow

private PortletWindow portletWindow

log

private Logger log

PORTLET_ERROR_MSG

public static final java.lang.String PORTLET_ERROR_MSG

See Also:

Constant Field Values

Constructor Detail

PortletFragment

public PortletFragment(java.lang.String id,
                       ServletConfig config,
                       Fragment parent,
                       Fragment fragDesc,
                       Navigation navigation)
                throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

service

public void service(HttpServletRequest request,
                    HttpServletResponse response)
             throws ServletException,
                    java.io.IOException

Description copied from interface: Fragment

Is called to render the fragment. This may be a page, column or even a portlet.

Specified by:

service in interface Fragment

Overrides:

service in class AbstractFragment

Parameters:

request - the servlet request

response - the servlet response

Throws:

ServletException

java.io.IOException

createURL

public void createURL(PortalURL url)

Description copied from interface: Fragment

Creates an URL pointing to this fragment

Specified by:

createURL in interface Fragment

Specified by:

createURL in class AbstractFragmentSingle

Parameters:

url - the PortalURL object used

isPartOfURL

public boolean isPartOfURL(PortalURL url)

Description copied from interface: Fragment

Returns true if the fragment is part of the URL

Specified by:

isPartOfURL in interface Fragment

Specified by:

isPartOfURL in class AbstractFragmentSingle

Parameters:

url - the PortalURL object used

Returns:

true if the fragment is part of the URL

getPortletWindow

public PortletWindow getPortletWindow()

getErrorMsg

protected java.lang.String getErrorMsg()