org.apache.pluto.portalImpl.aggregation
Class PortletFragment

java.lang.Object
  extended byorg.apache.pluto.portalImpl.aggregation.AbstractFragment
      extended byorg.apache.pluto.portalImpl.aggregation.AbstractFragmentSingle
          extended byorg.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
static java.lang.String PORTLET_ERROR_MSG
           
 
Fields inherited from class org.apache.pluto.portalImpl.aggregation.AbstractFragment
BASE_ROOT
 
Constructor Summary
PortletFragment(java.lang.String id, javax.servlet.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()
           
 org.apache.pluto.om.window.PortletWindow getPortletWindow()
           
 boolean isPartOfURL(PortalURL url)
          Returns true if the fragment is part of the URL
 void service(javax.servlet.http.HttpServletRequest request, javax.servlet.http.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

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,
                       javax.servlet.ServletConfig config,
                       Fragment parent,
                       Fragment fragDesc,
                       Navigation navigation)
                throws java.lang.Exception
Method Detail

service

public void service(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws javax.servlet.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
Throws:
javax.servlet.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

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

getPortletWindow

public org.apache.pluto.om.window.PortletWindow getPortletWindow()

getErrorMsg

protected java.lang.String getErrorMsg()


Copyright © 2003-2007 . All Rights Reserved.