org.apache.jetspeed.portlets.layout
Class LayoutPortlet
java.lang.Object
javax.portlet.GenericPortlet
org.apache.portals.bridges.common.GenericServletPortlet
org.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
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 |
Method Summary |
protected void |
addPortletToPage(Page page,
Fragment root,
java.lang.String portletId)
|
protected void |
addPortletToPage(java.lang.String pageId,
java.lang.String portletId)
|
java.lang.String |
decorateAndInclude(javax.portlet.RenderRequest request,
Fragment fragment,
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.commons.configuration.Configuration |
getConfiguration(javax.portlet.RenderRequest request,
java.lang.String name)
Gets the configuration (layout.properties) object for the decoration. |
protected TemplateDescriptor |
getDecoration(javax.portlet.RenderRequest request,
java.lang.String path,
java.lang.String templateType)
|
protected LocatorDescriptor |
getDecoratorLocatorDescriptor(javax.portlet.RenderRequest request)
|
protected Fragment |
getFragment(javax.portlet.RenderRequest request,
boolean maximized)
|
protected JetspeedPowerTool |
getJetspeedPowerTool(javax.portlet.RenderRequest request)
initJetspeedPowerTool |
protected Fragment |
getMaximizedLayout(javax.portlet.RenderRequest request)
|
protected RequestContext |
getRequestContext(javax.portlet.RenderRequest request)
|
protected TemplateDescriptor |
getTemplate(java.lang.String path,
java.lang.String templateType,
TemplateLocator locator,
LocatorDescriptor descriptor)
|
protected 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(Page page,
Fragment root,
java.lang.String fragmentId)
|
protected void |
removeFragment(java.lang.String pageId,
java.lang.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 |
GENERIC_TEMPLATE_TYPE
public static final java.lang.String GENERIC_TEMPLATE_TYPE
- See Also:
- Constant Field Values
FRAGMENT_PROCESSING_ERROR_PREFIX
public static final java.lang.String FRAGMENT_PROCESSING_ERROR_PREFIX
- See Also:
- Constant Field Values
FRAGMENT_ATTR
public static final java.lang.String FRAGMENT_ATTR
- See Also:
- Constant Field Values
LAYOUT_ATTR
public static final java.lang.String LAYOUT_ATTR
- See Also:
- Constant Field Values
HIDDEN
public static final java.lang.String HIDDEN
- See Also:
- Constant Field Values
LAYOUT_TEMPLATE_TYPE
public static final java.lang.String LAYOUT_TEMPLATE_TYPE
- See Also:
- Constant Field Values
DECORATOR_TYPE
public static final java.lang.String DECORATOR_TYPE
- See Also:
- Constant Field Values
PARAM_SOLO_PAGE
public static final java.lang.String PARAM_SOLO_PAGE
- See Also:
- Constant Field Values
log
protected static final org.apache.commons.logging.Log log
- Commons logging
registry
protected PortletRegistry registry
pageManager
protected PageManager pageManager
jptFactory
protected JetspeedPowerToolFactory jptFactory
templateLocator
protected TemplateLocator templateLocator
entityAccess
protected PortletEntityAccessComponent entityAccess
windowAccess
protected PortletWindowAccessor windowAccess
decorationLocator
protected TemplateLocator decorationLocator
DEFAULT_TEMPLATE_EXT
public static final java.lang.String DEFAULT_TEMPLATE_EXT
- See Also:
- Constant Field Values
TEMPLATE_EXTENSION_KEY
public static final java.lang.String TEMPLATE_EXTENSION_KEY
- See Also:
- Constant Field Values
DEFAULT_TEMPLATE_TYPE
public static final java.lang.String DEFAULT_TEMPLATE_TYPE
- See Also:
- Constant Field Values
TEMPLATE_TYPE_KEY
public static final java.lang.String TEMPLATE_TYPE_KEY
- See Also:
- Constant Field Values
LayoutPortlet
public LayoutPortlet()
init
public void init(javax.portlet.PortletConfig config)
throws javax.portlet.PortletException
- Specified by:
init
in interface javax.portlet.Portlet
- Overrides:
init
in class org.apache.portals.bridges.common.GenericServletPortlet
- Throws:
javax.portlet.PortletException
doHelp
public void doHelp(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
throws javax.portlet.PortletException,
java.io.IOException
- Overrides:
doHelp
in class org.apache.portals.bridges.common.GenericServletPortlet
- Throws:
javax.portlet.PortletException
java.io.IOException
doView
public void doView(javax.portlet.RenderRequest request,
javax.portlet.RenderResponse response)
throws javax.portlet.PortletException,
java.io.IOException
- Overrides:
doView
in class org.apache.portals.bridges.common.GenericServletPortlet
- Throws:
javax.portlet.PortletException
java.io.IOException
processAction
public void processAction(javax.portlet.ActionRequest request,
javax.portlet.ActionResponse response)
throws javax.portlet.PortletException,
java.io.IOException
- Specified by:
processAction
in interface javax.portlet.Portlet
- Overrides:
processAction
in class org.apache.portals.bridges.common.GenericServletPortlet
- Throws:
javax.portlet.PortletException
java.io.IOException
removeFragment
protected void removeFragment(java.lang.String pageId,
java.lang.String fragmentId)
removeFragment
protected void removeFragment(Page page,
Fragment root,
java.lang.String fragmentId)
addPortletToPage
protected void addPortletToPage(java.lang.String pageId,
java.lang.String portletId)
addPortletToPage
protected void addPortletToPage(Page page,
Fragment root,
java.lang.String portletId)
getJetspeedPowerTool
protected JetspeedPowerTool getJetspeedPowerTool(javax.portlet.RenderRequest request)
throws javax.portlet.PortletException
initJetspeedPowerTool
- Parameters:
request
- response
-
- Returns:
-
- Throws:
javax.portlet.PortletException
getFragment
protected Fragment getFragment(javax.portlet.RenderRequest request,
boolean maximized)
- Parameters:
request
- maximized
-
- Returns:
getMaximizedLayout
protected Fragment getMaximizedLayout(javax.portlet.RenderRequest request)
- Parameters:
request
-
- Returns:
getRequestContext
protected 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,
java.io.IOException
doEdit
- Overrides:
doEdit
in class org.apache.portals.bridges.common.GenericServletPortlet
- Parameters:
request
- response
-
- Throws:
javax.portlet.PortletException
java.io.IOException
- See Also:
GenericPortlet.doEdit(javax.portlet.RenderRequest,
javax.portlet.RenderResponse)
getTemplateLocatorDescriptor
protected LocatorDescriptor getTemplateLocatorDescriptor(javax.portlet.RenderRequest request)
throws TemplateLocatorException
- Parameters:
request
-
- Returns:
-
- Throws:
TemplateLocatorException
getDecoratorLocatorDescriptor
protected LocatorDescriptor getDecoratorLocatorDescriptor(javax.portlet.RenderRequest request)
throws TemplateLocatorException
- Parameters:
request
-
- Returns:
-
- Throws:
TemplateLocatorException
decorateAndInclude
public java.lang.String decorateAndInclude(javax.portlet.RenderRequest request,
Fragment fragment,
Page page)
throws TemplateLocatorException,
org.apache.commons.configuration.ConfigurationException
- Parameters:
request
- fragment
- page
-
- Returns:
-
- Throws:
TemplateLocatorException
org.apache.commons.configuration.ConfigurationException
getDecoration
protected TemplateDescriptor getDecoration(javax.portlet.RenderRequest request,
java.lang.String path,
java.lang.String templateType)
throws TemplateLocatorException
- Parameters:
request
- path
- templateType
-
- Returns:
-
- Throws:
TemplateLocatorException
getTemplate
protected TemplateDescriptor getTemplate(java.lang.String path,
java.lang.String templateType,
TemplateLocator locator,
LocatorDescriptor descriptor)
throws TemplateLocatorException
- Parameters:
path
- templateType
- locator
- descriptor
-
- Returns:
-
- Throws:
TemplateLocatorException
getConfiguration
protected org.apache.commons.configuration.Configuration getConfiguration(javax.portlet.RenderRequest request,
java.lang.String name)
- Gets the configuration (layout.properties) object for the decoration.
- Parameters:
name
- Name of the Decoration.
- Returns:
java.util.Properties
representing the configuration
object.
Copyright © 1999-2009 Apache Software Foundation. All Rights Reserved.