fr.paris.lutece.plugins.htmldocs.business.portlet

Class HtmldocsPortlet

java.lang.Object

fr.paris.lutece.portal.business.portlet.Portlet

fr.paris.lutece.portal.business.portlet.PortletHtmlContent

fr.paris.lutece.plugins.htmldocs.business.portlet.HtmldocsPortlet

All Implemented Interfaces:

fr.paris.lutece.portal.business.XmlContent

public class HtmldocsPortlet
extends fr.paris.lutece.portal.business.portlet.PortletHtmlContent

This class represents business objects HtmldocsPortlet

Field Summary

Fields

Modifier and Type	Field and Description
static String	RESOURCE_ID

Fields inherited from class fr.paris.lutece.portal.business.portlet.Portlet

FLAG_DISPLAY_ON_LARGE_DEVICE, FLAG_DISPLAY_ON_NORMAL_DEVICE, FLAG_DISPLAY_ON_SMALL_DEVICE, FLAG_DISPLAY_ON_XLARGE_DEVICE, STATUS_PUBLISHED, STATUS_UNPUBLISHED

Fields inherited from interface fr.paris.lutece.portal.business.XmlContent

TAG_CHILD_PAGES_LIST, TAG_CURRENT_PAGE_ID, TAG_DISPLAY_ON_LARGE_DEVICE, TAG_DISPLAY_ON_NORMAL_DEVICE, TAG_DISPLAY_ON_SMALL_DEVICE, TAG_DISPLAY_ON_XLARGE_DEVICE, TAG_DISPLAY_PORTLET_TITLE, TAG_MENU, TAG_MENU_INDEX, TAG_MENU_LIST, TAG_MODE, TAG_PAGE, TAG_PAGE_DESCRIPTION, TAG_PAGE_ID, TAG_PAGE_IMAGE, TAG_PAGE_LEVEL, TAG_PAGE_NAME, TAG_PARENT_PAGE_ID, TAG_PLUGIN_NAME, TAG_PORTLET, TAG_PORTLET_ID, TAG_PORTLET_NAME, TAG_SUBLEVEL_INDEX, TAG_SUBLEVEL_MENU, TAG_SUBLEVEL_MENU_LIST

Constructor Summary

Constructors

Constructor and Description
HtmldocsPortlet() Sets the identifier of the portlet type to value specified

Method Summary

Modifier and Type	Method and Description
int	getContentId() Get the id of the html document
String	getHtmlContent(javax.servlet.http.HttpServletRequest request) Returns the HTML code of the HtmldocsPortlet portlet with XML heading
HtmlDocPublication	getHtmlDocPublication() Get the HtmlDocPublication of the html document
String	getPortletName() Get the name of the html document
void	remove() Removes the current instance of the HtmldocsPortlet object
void	setContentId(int nContentId) Sets the id of the html document
void	setHtmlDocPublication(HtmlDocPublication htmlDocPublication) Sets the HtmlDocPublication of the html document
void	setPortletName(String strName) Sets the name of the html document
void	update() Updates the current instance of the HtmldocsPortlet object

Methods inherited from class fr.paris.lutece.portal.business.portlet.PortletHtmlContent

getXml, getXmlDocument, isContentGeneratedByXmlAndXsl

Methods inherited from class fr.paris.lutece.portal.business.portlet.Portlet

addPortletTags, canBeCachedForAnonymousUsers, canBeCachedForConnectedUsers, copy, getAcceptAlias, getColumn, getDateUpdate, getDeviceDisplayFlags, getDisplayPortletTitle, getHomeClassName, getId, getName, getOrder, getPageId, getPluginName, getPortletTypeId, getPortletTypeName, getRole, getStatus, getStyleId, getUrlCreation, getUrlUpdate, getXslFile, getXslParams, getXslSource, hasDeviceDisplayFlag, setAcceptAlias, setColumn, setDateUpdate, setDeviceDisplayFlags, setDisplayPortletTitle, setHomeClassName, setId, setName, setOrder, setPageId, setPluginName, setPortletTypeId, setPortletTypeName, setRole, setStatus, setStyleId, setUrlCreation, setUrlUpdate

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE_ID

public static final String RESOURCE_ID

See Also:

Constant Field Values

Constructor Detail

HtmldocsPortlet

public HtmldocsPortlet()

Sets the identifier of the portlet type to value specified

Method Detail

getHtmlContent

public String getHtmlContent(javax.servlet.http.HttpServletRequest request)

Returns the HTML code of the HtmldocsPortlet portlet with XML heading

Specified by:

getHtmlContent in class fr.paris.lutece.portal.business.portlet.PortletHtmlContent

Parameters:

request - The HTTP servlet request

Returns:

the HTML code of the HtmldocsPortlet portlet

update

public void update()

Updates the current instance of the HtmldocsPortlet object

remove

public void remove()

Removes the current instance of the HtmldocsPortlet object

Specified by:

remove in class fr.paris.lutece.portal.business.portlet.Portlet

setContentId

public void setContentId(int nContentId)

Sets the id of the html document

Parameters:

the - id of the document

getContentId

public int getContentId()

Get the id of the html document

Returns:

the id of the document

setHtmlDocPublication

public void setHtmlDocPublication(HtmlDocPublication htmlDocPublication)

Sets the HtmlDocPublication of the html document

Parameters:

the - HtmlDocPublication of the document

getHtmlDocPublication

public HtmlDocPublication getHtmlDocPublication()

Get the HtmlDocPublication of the html document

Returns:

the HtmlDocPublication of the document

setPortletName

public void setPortletName(String strName)

Sets the name of the html document

Parameters:

the - name of the document

getPortletName

public String getPortletName()

Get the name of the html document

Returns:

the name of the document