com.gentics.cr.portlet

Class BaseSidebarPortlet

java.lang.Object

javax.portlet.GenericPortlet

com.gentics.cr.portlet.AGenticsPortlet

com.gentics.cr.portlet.AContentDisplayPortlet

com.gentics.cr.portlet.BaseSidebarPortlet

All Implemented Interfaces:

javax.portlet.EventPortlet, javax.portlet.Portlet, javax.portlet.PortletConfig, javax.portlet.ResourceServingPortlet

public class BaseSidebarPortlet
extends AContentDisplayPortlet

The Class BaseSidebarPortlet.

Field Summary

Fields

Modifier and Type	Field and Description
private String	propertyname the property name for this sidebar portlet instance.
private static String	PROPERTYNAME_KEY the portety name key for the properties file.

Fields inherited from class com.gentics.cr.portlet.AContentDisplayPortlet

attributes, ATTRIBUTES_KEY, downloadMimetypes, ISVELOCITYRENDERED_KEY, vEngine

Fields inherited from class com.gentics.cr.portlet.AGenticsPortlet

CONTENTID_OVERRIDE_ATTRIBUTE, CONTENTID_RENDER_PARAMETER, INITPARAM_EDITTEMPLATE_NAME, INITPARAM_STARTFOLDER_NAME, INITPARAM_STARTPAGE_NAME, INITPARAM_VIEWTEMPLATE_NAME, log, PAGE_RULE, TEMPLATE_CACHEZONE_KEY, TEMPLATECACHE_CONFIG_KEY

Constructor Summary

Constructors

Constructor and Description
BaseSidebarPortlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInternalView(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) Do internal view.
protected String	getContentid(javax.portlet.RenderRequest request) Returns the current contentid for the portlet.
protected void	handleError(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response, javax.portlet.PortletException exception) Handle error.
protected void	initialize() the portlet instance initialize method.

Methods inherited from class com.gentics.cr.portlet.AContentDisplayPortlet

dispatch, doView, executeVelocityRender, getRp, prepareDisplayResponse, processAction, serveResource

Methods inherited from class com.gentics.cr.portlet.AGenticsPortlet

getCrConf, getLog, getStartfolder, getStartpage, getTemplate, init, setCrConf, setLog

Methods inherited from class javax.portlet.GenericPortlet

destroy, doDispatch, doEdit, doHeaders, doHelp, getContainerRuntimeOptions, getDefaultNamespace, getInitParameter, getInitParameterNames, getNextPossiblePortletModes, getPortletConfig, getPortletContext, getPortletName, getProcessingEventQNames, getPublicRenderParameterNames, getPublishingEventQNames, getResourceBundle, getSupportedLocales, getTitle, init, processEvent, render

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTYNAME_KEY

private static final String PROPERTYNAME_KEY

the portety name key for the properties file.

See Also:

Constant Field Values

propertyname

private String propertyname

the property name for this sidebar portlet instance.

Constructor Detail

BaseSidebarPortlet

public BaseSidebarPortlet()

Method Detail

initialize

protected void initialize()

Description copied from class: AGenticsPortlet

the portlet instance initialize method.

in this method every kind of Gentics portlet can initialize its own connectors and helpers

This method is called exact once on portlet init.

Please use this method if you have to initialize components within your portlet instance (E.g. connectors, helper classes etc.)

Overrides:

initialize in class AContentDisplayPortlet

handleError

protected void handleError(javax.portlet.RenderRequest request,
               javax.portlet.RenderResponse response,
               javax.portlet.PortletException exception)

Description copied from class: AContentDisplayPortlet

Handle error.

Specified by:

handleError in class AContentDisplayPortlet

Parameters:

request - the request

response - the response

exception - the exception

getContentid

protected String getContentid(javax.portlet.RenderRequest request)
                       throws com.gentics.cr.exceptions.CRException

Description copied from class: AGenticsPortlet

Returns the current contentid for the portlet. The first contentid found by checking the following will be returned:

1. Portlet Session Parameter [portletName]_contentid (which will be removed afterwards)
2. Render Request Parameter [portletName]_contentid
3. Render Request Parameter contentid
4. Default contentid configured for the portlet
5. Startpage configured for the portlet

Overrides:

getContentid in class AGenticsPortlet

Parameters:

request - the request

Returns:

the current contentid

Throws:

com.gentics.cr.exceptions.CRException

doInternalView

protected void doInternalView(javax.portlet.RenderRequest request,
                  javax.portlet.RenderResponse response)
                       throws javax.portlet.PortletException,
                              IOException

Description copied from class: AContentDisplayPortlet

Do internal view. TODO

TODO

Specified by:

doInternalView in class AContentDisplayPortlet

Parameters:

request - the request

response - the response

Throws:

javax.portlet.PortletException - the portlet exception

IOException - Signals that an I/O exception has occurred.