fr.paris.lutece.plugins.jsr168.business.portlet
Class Jsr168Portlet

java.lang.Object
  extended by fr.paris.lutece.portal.business.portlet.Portlet
      extended by fr.paris.lutece.plugins.jsr168.business.portlet.Jsr168Portlet
All Implemented Interfaces:
fr.paris.lutece.portal.business.XmlContent

public class Jsr168Portlet
extends fr.paris.lutece.portal.business.portlet.Portlet

This class represents business objects HtmlPortlet


Field Summary
 
Fields inherited from interface fr.paris.lutece.portal.business.XmlContent
TAG_CHILD_PAGES_LIST, TAG_CURRENT_PAGE_ID, 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
Jsr168Portlet()
          Sets the identifier of the portlet type to value specified
 
Method Summary
protected  java.lang.String addPortletTags(java.lang.StringBuffer sbPortlet)
          Add the common tags to all the portlets to the XML document
 java.lang.String getJsr168Name()
          Returns the name of the jsr 168 name
 java.lang.String getXml(javax.servlet.http.HttpServletRequest request)
          Returns the Xml code of the HTML portlet without Xml header
 java.lang.String getXmlDocument(javax.servlet.http.HttpServletRequest request)
          Returns the Xml code of the HTML portlet with Xml header
 void remove()
          Removes the current instance of the HtmlPortlet object
 void setJsr168Name(java.lang.String strJsr168Name)
          Sets the name of the jsr 168 portlet
 void update()
          Updates the current instance of the HtmlPortlet object
 
Methods inherited from class fr.paris.lutece.portal.business.portlet.Portlet
copy, getAcceptAlias, getColumn, getDateUpdate, getDisplayPortletTitle, getHomeClassName, getId, getName, getOrder, getPageId, getPluginName, getPortletTypeId, getPortletTypeName, getStatus, getStyleId, getUrlCreation, getUrlUpdate, getXslFile, getXslParams, getXslSource, setAcceptAlias, setColumn, setDateUpdate, setDisplayPortletTitle, setHomeClassName, setId, setName, setOrder, setPageId, setPluginName, setPortletTypeId, setPortletTypeName, setStatus, setStyleId, setUrlCreation, setUrlUpdate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Jsr168Portlet

public Jsr168Portlet()
Sets the identifier of the portlet type to value specified

Method Detail

setJsr168Name

public void setJsr168Name(java.lang.String strJsr168Name)
Sets the name of the jsr 168 portlet

Parameters:
strJsr168Name - the name of the jsr 168 portlet

getJsr168Name

public java.lang.String getJsr168Name()
Returns the name of the jsr 168 name

Returns:
the name of the Jsr 168 portlet

addPortletTags

protected java.lang.String addPortletTags(java.lang.StringBuffer sbPortlet)
Add the common tags to all the portlets to the XML document

Overrides:
addPortletTags in class fr.paris.lutece.portal.business.portlet.Portlet
Parameters:
sbPortlet - The string buffer which contains the XML content of this portlet
Returns:
The XML content of this portlet encapsulated by the common tags

remove

public void remove()
Removes the current instance of the HtmlPortlet object

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

getXml

public java.lang.String getXml(javax.servlet.http.HttpServletRequest request)
Returns the Xml code of the HTML portlet without Xml header

Parameters:
request - Current user HTTP Request
Returns:
the Xml code of the HTML portlet content

getXmlDocument

public java.lang.String getXmlDocument(javax.servlet.http.HttpServletRequest request)
Returns the Xml code of the HTML portlet with Xml header

Parameters:
request - Current user HTTP Request
Returns:
the Xml code of the HTML portlet

update

public void update()
Updates the current instance of the HtmlPortlet object



Copyright © 2008 Mairie de Paris. All Rights Reserved.