org.apache.jetspeed.portlets.layout
Class LayoutPortlet

java.lang.Object
  extended byjavax.portlet.GenericPortlet
      extended byorg.apache.portals.bridges.common.GenericServletPortlet
          extended byorg.apache.jetspeed.portlets.layout.LayoutPortlet
All Implemented Interfaces:
javax.portlet.Portlet, javax.portlet.PortletConfig
Direct Known Subclasses:
MultiColumnPortlet

public class LayoutPortlet
extends org.apache.portals.bridges.common.GenericServletPortlet


Field Summary
protected  org.apache.jetspeed.locator.TemplateLocator decorationLocator
           
static String DECORATOR_TYPE
           
protected  org.apache.jetspeed.components.portletentity.PortletEntityAccessComponent entityAccess
           
static String FRAGMENT_ATTR
           
static String FRAGMENT_PROCESSING_ERROR_PREFIX
           
protected  org.apache.jetspeed.idgenerator.IdGenerator generator
           
static String GENERIC_TEMPLATE_TYPE
           
static String HIDDEN
           
protected  org.apache.jetspeed.velocity.JetspeedPowerToolFactory jptFactory
           
static String LAYOUT_ATTR
           
static String LAYOUT_TEMPLATE_TYPE
           
protected static org.apache.commons.logging.Log log
          Commons logging
protected  org.apache.jetspeed.page.PageManager pageManager
           
protected  org.apache.jetspeed.components.portletregistry.PortletRegistry registry
           
protected  org.apache.jetspeed.locator.TemplateLocator templateLocator
           
 
Fields inherited from class org.apache.portals.bridges.common.GenericServletPortlet
PARAM_ACTION_PAGE, PARAM_ALLOW_PREFERENCES, PARAM_CUSTOM_PAGE, PARAM_EDIT_PAGE, PARAM_HELP_PAGE, PARAM_MAX_PAGE, PARAM_VIEW_PAGE
 
Fields inherited from class javax.portlet.GenericPortlet
 
Constructor Summary
LayoutPortlet()
           
 
Method Summary
protected  void addPortletToPage(String pageId, String portletId)
           
 String decorateAndInclude(javax.portlet.RenderRequest request, org.apache.jetspeed.om.page.Fragment fragment, org.apache.jetspeed.om.page.Page page)
           
 void doEdit(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
           doEdit
 void doHelp(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
           
 void doView(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
           
protected  org.apache.jetspeed.locator.TemplateDescriptor getDecoration(javax.portlet.RenderRequest request, String path, String templateType)
           
protected  org.apache.jetspeed.locator.LocatorDescriptor getDecoratorLocatorDescriptor(javax.portlet.RenderRequest request)
           
protected  org.apache.jetspeed.om.page.Fragment getFragment(javax.portlet.RenderRequest request, boolean maximized)
           
protected  org.apache.jetspeed.velocity.JetspeedPowerTool getJetspeedPowerTool(javax.portlet.RenderRequest request)
           initJetspeedPowerTool
protected  org.apache.jetspeed.om.page.Fragment getMaximizedLayout(javax.portlet.RenderRequest request)
           
protected  org.apache.jetspeed.request.RequestContext getRequestContext(javax.portlet.RenderRequest request)
           
protected  org.apache.jetspeed.locator.TemplateDescriptor getTemplate(String path, String templateType, org.apache.jetspeed.locator.TemplateLocator locator, org.apache.jetspeed.locator.LocatorDescriptor descriptor)
           
protected  org.apache.jetspeed.locator.LocatorDescriptor getTemplateLocatorDescriptor(javax.portlet.RenderRequest request)
           
 void init(javax.portlet.PortletConfig config)
           
 void processAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response)
           
protected  void removeFragment(String pageId, String fragmentId)
           
 
Methods inherited from class org.apache.portals.bridges.common.GenericServletPortlet
doCustom, getDefaultActionPage, getDefaultCustomPage, getDefaultEditPage, getDefaultHelpPage, getDefaultViewPage, processPreferencesAction, setDefaultActionPage, setDefaultCustomPage, setDefaultEditPage, setDefaultHelpPage, setDefaultViewPage
 
Methods inherited from class javax.portlet.GenericPortlet
destroy, doDispatch, getInitParameter, getInitParameterNames, getPortletConfig, getPortletContext, getPortletName, getResourceBundle, getTitle, init, render
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

GENERIC_TEMPLATE_TYPE

public static final String GENERIC_TEMPLATE_TYPE
See Also:
Constant Field Values

FRAGMENT_PROCESSING_ERROR_PREFIX

public static final String FRAGMENT_PROCESSING_ERROR_PREFIX
See Also:
Constant Field Values

FRAGMENT_ATTR

public static final String FRAGMENT_ATTR
See Also:
Constant Field Values

LAYOUT_ATTR

public static final String LAYOUT_ATTR
See Also:
Constant Field Values

HIDDEN

public static final String HIDDEN
See Also:
Constant Field Values

LAYOUT_TEMPLATE_TYPE

public static final String LAYOUT_TEMPLATE_TYPE
See Also:
Constant Field Values

DECORATOR_TYPE

public static final String DECORATOR_TYPE
See Also:
Constant Field Values

log

protected static final org.apache.commons.logging.Log log
Commons logging


registry

protected org.apache.jetspeed.components.portletregistry.PortletRegistry registry

pageManager

protected org.apache.jetspeed.page.PageManager pageManager

generator

protected org.apache.jetspeed.idgenerator.IdGenerator generator

jptFactory

protected org.apache.jetspeed.velocity.JetspeedPowerToolFactory jptFactory

templateLocator

protected org.apache.jetspeed.locator.TemplateLocator templateLocator

entityAccess

protected org.apache.jetspeed.components.portletentity.PortletEntityAccessComponent entityAccess

decorationLocator

protected org.apache.jetspeed.locator.TemplateLocator decorationLocator
Constructor Detail

LayoutPortlet

public LayoutPortlet()
Method Detail

init

public void init(javax.portlet.PortletConfig config)
          throws javax.portlet.PortletException
Throws:
javax.portlet.PortletException

doHelp

public void doHelp(javax.portlet.RenderRequest request,
                   javax.portlet.RenderResponse response)
            throws javax.portlet.PortletException,
                   IOException
Throws:
javax.portlet.PortletException
IOException

doView

public void doView(javax.portlet.RenderRequest request,
                   javax.portlet.RenderResponse response)
            throws javax.portlet.PortletException,
                   IOException
Throws:
javax.portlet.PortletException
IOException

processAction

public void processAction(javax.portlet.ActionRequest request,
                          javax.portlet.ActionResponse response)
                   throws javax.portlet.PortletException,
                          IOException
Throws:
javax.portlet.PortletException
IOException

removeFragment

protected void removeFragment(String pageId,
                              String fragmentId)

addPortletToPage

protected void addPortletToPage(String pageId,
                                String portletId)

getJetspeedPowerTool

protected org.apache.jetspeed.velocity.JetspeedPowerTool getJetspeedPowerTool(javax.portlet.RenderRequest request)
                                                                       throws javax.portlet.PortletException

initJetspeedPowerTool

Parameters:
request -
Returns:
Throws:
javax.portlet.PortletException

getFragment

protected org.apache.jetspeed.om.page.Fragment getFragment(javax.portlet.RenderRequest request,
                                                           boolean maximized)
Parameters:
request -
maximized -
Returns:

getMaximizedLayout

protected org.apache.jetspeed.om.page.Fragment getMaximizedLayout(javax.portlet.RenderRequest request)
Parameters:
request -
Returns:

getRequestContext

protected org.apache.jetspeed.request.RequestContext getRequestContext(javax.portlet.RenderRequest request)
Parameters:
request -
Returns:

doEdit

public void doEdit(javax.portlet.RenderRequest request,
                   javax.portlet.RenderResponse response)
            throws javax.portlet.PortletException,
                   IOException

doEdit

Parameters:
request -
response -
Throws:
javax.portlet.PortletException
IOException
See Also:
GenericPortlet.doEdit(javax.portlet.RenderRequest, javax.portlet.RenderResponse)

getTemplateLocatorDescriptor

protected org.apache.jetspeed.locator.LocatorDescriptor getTemplateLocatorDescriptor(javax.portlet.RenderRequest request)
                                                                              throws org.apache.jetspeed.locator.TemplateLocatorException
Parameters:
request -
Returns:
Throws:
org.apache.jetspeed.locator.TemplateLocatorException

getDecoratorLocatorDescriptor

protected org.apache.jetspeed.locator.LocatorDescriptor getDecoratorLocatorDescriptor(javax.portlet.RenderRequest request)
                                                                               throws org.apache.jetspeed.locator.TemplateLocatorException
Parameters:
request -
Returns:
Throws:
org.apache.jetspeed.locator.TemplateLocatorException

decorateAndInclude

public String decorateAndInclude(javax.portlet.RenderRequest request,
                                 org.apache.jetspeed.om.page.Fragment fragment,
                                 org.apache.jetspeed.om.page.Page page)
                          throws org.apache.jetspeed.locator.TemplateLocatorException,
                                 org.apache.commons.configuration.ConfigurationException
Parameters:
request -
fragment -
page -
Returns:
Throws:
org.apache.jetspeed.locator.TemplateLocatorException
org.apache.commons.configuration.ConfigurationException

getDecoration

protected org.apache.jetspeed.locator.TemplateDescriptor getDecoration(javax.portlet.RenderRequest request,
                                                                       String path,
                                                                       String templateType)
                                                                throws org.apache.jetspeed.locator.TemplateLocatorException
Parameters:
request -
path -
templateType -
Returns:
Throws:
org.apache.jetspeed.locator.TemplateLocatorException

getTemplate

protected org.apache.jetspeed.locator.TemplateDescriptor getTemplate(String path,
                                                                     String templateType,
                                                                     org.apache.jetspeed.locator.TemplateLocator locator,
                                                                     org.apache.jetspeed.locator.LocatorDescriptor descriptor)
                                                              throws org.apache.jetspeed.locator.TemplateLocatorException
Parameters:
path -
templateType -
locator -
descriptor -
Returns:
Throws:
org.apache.jetspeed.locator.TemplateLocatorException


Copyright © 1999-2005 Apache Software Foundation. All Rights Reserved.