fr.paris.lutece.portal.web.portlet

Class PortletJspBean

java.lang.Object

fr.paris.lutece.portal.web.admin.AdminFeaturesPageJspBean

fr.paris.lutece.portal.web.portlet.PortletJspBean

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AliasPortletJspBean

public abstract class PortletJspBean
extends AdminFeaturesPageJspBean

This class represents user interface Portlet. It is the base class of all user interface portlets. It is abstract and the implementation of the interface PortletJspBeanInterface is compulsary.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	PARAMETER_PAGE_ID
protected static String	PARAMETER_PORTLET_ID
protected static String	PARAMETER_PORTLET_TYPE_ID
static String	RIGHT_MANAGE_ADMIN_SITE

Constructor Summary

Constructors

Constructor and Description
PortletJspBean()

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	doCreate(javax.servlet.http.HttpServletRequest request) Processes portlet's creation
abstract String	doModify(javax.servlet.http.HttpServletRequest request) Processes portlet's modification
abstract String	getCreate(javax.servlet.http.HttpServletRequest request) Displays the portlet's creation form
protected fr.paris.lutece.util.html.HtmlTemplate	getCreateTemplate(String strPageId, String strPortletTypeId) Fills templates with common values shared by portlet creation form
protected fr.paris.lutece.util.html.HtmlTemplate	getCreateTemplate(String strPageId, String strPortletTypeId, Map<String,Object> model) Fills templates with common values shared by portlet creation form
abstract String	getModify(javax.servlet.http.HttpServletRequest request) Displays the portlet's modification form
protected fr.paris.lutece.util.html.HtmlTemplate	getModifyTemplate(Portlet portlet) Fills update template with portlet values
protected fr.paris.lutece.util.html.HtmlTemplate	getModifyTemplate(Portlet portlet, Map<String,Object> model) Fills update template with portlet values
protected String	getPageUrl(int nIdPage) Gets the page URL
protected void	putCheckBox(Map<String,Object> model, String strMarkerChecked, boolean bChecked) Put check box.
protected String	setPortletCommonData(javax.servlet.http.HttpServletRequest request, Portlet portlet) Recovers the common attributes of the portlet

Methods inherited from class fr.paris.lutece.portal.web.admin.AdminFeaturesPageJspBean

getAdminPage, getFeatureIcon, getHomeUrl, getLocale, getPageTitle, getUser, init, populate, setFeatureGroup, setFeatureIcon, setPageTitleProperty, validate, validate, validate

Methods inherited from class java.lang.Object

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

Field Detail

RIGHT_MANAGE_ADMIN_SITE

public static final String RIGHT_MANAGE_ADMIN_SITE

See Also:

Constant Field Values

PARAMETER_PAGE_ID

protected static final String PARAMETER_PAGE_ID

See Also:

Constant Field Values

PARAMETER_PORTLET_ID

protected static final String PARAMETER_PORTLET_ID

See Also:

Constant Field Values

PARAMETER_PORTLET_TYPE_ID

protected static final String PARAMETER_PORTLET_TYPE_ID

See Also:

Constant Field Values

Constructor Detail

PortletJspBean

public PortletJspBean()

Method Detail

getCreate

public abstract String getCreate(javax.servlet.http.HttpServletRequest request)

Displays the portlet's creation form

Parameters:

request - The http request

Returns:

The html code for displaying the creation form

doCreate

public abstract String doCreate(javax.servlet.http.HttpServletRequest request)

Processes portlet's creation

Parameters:

request - The http request

Returns:

The Management jsp url

getModify

public abstract String getModify(javax.servlet.http.HttpServletRequest request)

Displays the portlet's modification form

Parameters:

request - The http request

Returns:

The html code for displaying the modification form

doModify

public abstract String doModify(javax.servlet.http.HttpServletRequest request)

Processes portlet's modification

Parameters:

request - The http request

Returns:

The Management jsp url

setPortletCommonData

protected String setPortletCommonData(javax.servlet.http.HttpServletRequest request,
                          Portlet portlet)

Recovers the common attributes of the portlet

Parameters:

request - the http request

portlet - The instance of the portlet

Returns:

An error Key if error, otherwise null.

getCreateTemplate

protected fr.paris.lutece.util.html.HtmlTemplate getCreateTemplate(String strPageId,
                                                       String strPortletTypeId)

Fills templates with common values shared by portlet creation form

Parameters:

strPageId - the page identifier

strPortletTypeId - the Portlet type identifier

Returns:

the template filled

getCreateTemplate

protected fr.paris.lutece.util.html.HtmlTemplate getCreateTemplate(String strPageId,
                                                       String strPortletTypeId,
                                                       Map<String,Object> model)

Fills templates with common values shared by portlet creation form

Parameters:

strPageId - the page identifier

strPortletTypeId - the Portlet type identifier

model - Specific data stored in a hashtable

Returns:

the template filled

getModifyTemplate

protected fr.paris.lutece.util.html.HtmlTemplate getModifyTemplate(Portlet portlet)

Fills update template with portlet values

Parameters:

portlet - the object to update

Returns:

the update template filled

getModifyTemplate

protected fr.paris.lutece.util.html.HtmlTemplate getModifyTemplate(Portlet portlet,
                                                       Map<String,Object> model)

Fills update template with portlet values

Parameters:

portlet - the object to update

model - The Data model

Returns:

the update template filled

putCheckBox

protected void putCheckBox(Map<String,Object> model,
               String strMarkerChecked,
               boolean bChecked)

Put check box.

Parameters:

model - the model

strMarkerChecked - the str marker checked

bChecked - the b checked

getPageUrl

protected String getPageUrl(int nIdPage)

Gets the page URL

Parameters:

nIdPage - Page ID

Returns:

The page URL