fr.paris.lutece.portal.service.content
Class PageData

java.lang.Object
  extended by fr.paris.lutece.portal.service.content.PageData

public class PageData
extends java.lang.Object

This class provides a structure to build portal pages.


Constructor Summary
PageData()
           
 
Method Summary
 java.lang.String getContent()
          Returns the page content.
 java.lang.String getCssUrl()
          Returns the URL of the Cascading Style Sheet associated to this page
 java.lang.String getCustomizeCssUrl()
          Returns the URL of the Customize Cascading Style Sheet associated to this page
 java.lang.String getFavicon()
          Returns the favicon of the page
 java.lang.String getFavourite()
          Returns the favourite of the page
 java.lang.String getHeader()
          Returns the header to display at the top of the page.
 java.lang.String getMenu()
          Returns the menu associated to the page
 java.lang.String getMetaAuthor()
          Returns Author to mention in the META tags of the page.
 java.lang.String getMetaCopyright()
          Returns Copyright to mention in the META tags of the page.
 java.lang.String getMetaDescription()
          Returns Description to mention in the META tags of the page.
 java.lang.String getMetaKeywords()
          Returns Keywords to mention in the META tags of the page.
 java.lang.String getName()
          Returns the name of the page
 java.lang.String getPagePath()
          Returns the page path.
 java.lang.String getPluginsCssUrl()
          Returns the URL of the Plugins Cascading Style Sheet associated to this page
 java.lang.String getTheme()
          Returns the theme of the page
 java.lang.String getTreeMenu()
          Returns the page path.
 boolean isHomePage()
          Returns weither the current page is an homepage or not.
 void setContent(java.lang.String strContent)
          Sets the page content.
 void setCssUrl(java.lang.String strCssUrl)
          Sets the URL of the Cascading Style Sheet associated to this page
 void setCustomizeCssUrl(java.lang.String strCustomizeCssUrl)
          Sets the URL of the Customize Cascading Style Sheet associated to this page
 void setFavicon(java.lang.String strFavicon)
          Sets the Favicon of the page to the specified string.
 void setFavourite(java.lang.String strFavourite)
          Sets the favourite of the page to the specified string.
 void setHeader(java.lang.String strHeader)
          Sets the header to display at the top of the page.
 void setHomePage(boolean bHomePage)
          Sets the homepage indicator.
 void setMenu(java.lang.String strMenu)
          Sets the menu associated to the page
 void setMetaAuthor(java.lang.String strMetaAuthor)
          Sets Author to mention in the META tags of the page.
 void setMetaCopyright(java.lang.String strMetaCopyright)
          Sets Copyright to mention in the META tags of the page.
 void setMetaDescription(java.lang.String strMetaDescription)
          Sets Description to mention in the META tags of the page.
 void setMetaKeywords(java.lang.String strMetaKeywords)
          Sets Keywords to mention in the META tags of the page.
 void setName(java.lang.String strName)
          Sets the name of the page to the specified string.
 void setPagePath(java.lang.String strPagePath)
          Set the page path.
 void setPluginsCssUrl(java.lang.String strPluginsCssUrl)
          Sets the URL of the Plugins Cascading Style Sheet associated to this page
 void setTheme(java.lang.String strTheme)
          Sets the Theme of the page to the specified string.
 void setTreeMenu(java.lang.String strTreeMenu)
          Set the page path.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PageData

public PageData()
Method Detail

getName

public java.lang.String getName()
Returns the name of the page

Returns:
The name of the page as a string.

setName

public void setName(java.lang.String strName)
Sets the name of the page to the specified string.

Parameters:
strName - The new name of the page.

getFavourite

public java.lang.String getFavourite()
Returns the favourite of the page

Returns:
The favourite of the page as a string.

setFavourite

public void setFavourite(java.lang.String strFavourite)
Sets the favourite of the page to the specified string.

Parameters:
strFavourite - The new favourite of the page.

getCssUrl

public java.lang.String getCssUrl()
Returns the URL of the Cascading Style Sheet associated to this page

Returns:
the URL of the Cascading Style Sheet associated to this page as a String.

setCssUrl

public void setCssUrl(java.lang.String strCssUrl)
Sets the URL of the Cascading Style Sheet associated to this page

Parameters:
strCssUrl - Sets the URL of the Cascading Style Sheet associated to this page to the specified string.

getCustomizeCssUrl

public java.lang.String getCustomizeCssUrl()
Returns the URL of the Customize Cascading Style Sheet associated to this page

Returns:
the URL of the Customize Cascading Style Sheet associated to this page as a String.

setCustomizeCssUrl

public void setCustomizeCssUrl(java.lang.String strCustomizeCssUrl)
Sets the URL of the Customize Cascading Style Sheet associated to this page

Parameters:
strCustomizeCssUrl - Sets the URL of the Customize Cascading Style Sheet associated to this page to the specified string.

getPluginsCssUrl

public java.lang.String getPluginsCssUrl()
Returns the URL of the Plugins Cascading Style Sheet associated to this page

Returns:
the URL of the Plugins Cascading Style Sheet associated to this page as a String.

setPluginsCssUrl

public void setPluginsCssUrl(java.lang.String strPluginsCssUrl)
Sets the URL of the Plugins Cascading Style Sheet associated to this page

Parameters:
strPluginsCssUrl - Sets the URL of the Plugins Cascading Style Sheet associated to this page to the specified string.

getMetaAuthor

public java.lang.String getMetaAuthor()
Returns Author to mention in the META tags of the page.

Returns:
Author to mention in the META tags of the page as a String.

setMetaAuthor

public void setMetaAuthor(java.lang.String strMetaAuthor)
Sets Author to mention in the META tags of the page.

Parameters:
strMetaAuthor - The Author to mention in the META tags of the page

getMetaCopyright

public java.lang.String getMetaCopyright()
Returns Copyright to mention in the META tags of the page.

Returns:
Copyright to mention in the META tags of the page as a String.

setMetaCopyright

public void setMetaCopyright(java.lang.String strMetaCopyright)
Sets Copyright to mention in the META tags of the page.

Parameters:
strMetaCopyright - The Copyright to mention in the META tags of the page

getMetaKeywords

public java.lang.String getMetaKeywords()
Returns Keywords to mention in the META tags of the page.

Returns:
Keywords to mention in the META tags of the page as a String.

setMetaKeywords

public void setMetaKeywords(java.lang.String strMetaKeywords)
Sets Keywords to mention in the META tags of the page.

Parameters:
strMetaKeywords - The Keywords to mention in the META tags of the page.

getMetaDescription

public java.lang.String getMetaDescription()
Returns Description to mention in the META tags of the page.

Returns:
Description to mention in the META tags of the page as a String.

setMetaDescription

public void setMetaDescription(java.lang.String strMetaDescription)
Sets Description to mention in the META tags of the page.

Parameters:
strMetaDescription - The Description to mention in the META tags of the page.

getHeader

public java.lang.String getHeader()
Returns the header to display at the top of the page.

Returns:
The header HTML code as a String.

setHeader

public void setHeader(java.lang.String strHeader)
Sets the header to display at the top of the page.

Parameters:
strHeader - Sets the header to display at the top of the page.

getMenu

public java.lang.String getMenu()
Returns the menu associated to the page

Returns:
The HTML code of the menu associated to the page as a String

setMenu

public void setMenu(java.lang.String strMenu)
Sets the menu associated to the page

Parameters:
strMenu - The HTML code of the menu to associate to the page as a String

getPagePath

public java.lang.String getPagePath()
Returns the page path.

Returns:
the page path.

setPagePath

public void setPagePath(java.lang.String strPagePath)
Set the page path.

Parameters:
strPagePath - the page path

getTreeMenu

public java.lang.String getTreeMenu()
Returns the page path.

Returns:
the page path.

setTreeMenu

public void setTreeMenu(java.lang.String strTreeMenu)
Set the page path.

Parameters:
strTreeMenu - the page path

getContent

public java.lang.String getContent()
Returns the page content.

Returns:
The HTML code of the page content as a String.

setContent

public void setContent(java.lang.String strContent)
Sets the page content.

Parameters:
strContent - The HTML code of the page content as a String.

getFavicon

public java.lang.String getFavicon()
Returns the favicon of the page

Returns:
The favicon of the page as a string.

setFavicon

public void setFavicon(java.lang.String strFavicon)
Sets the Favicon of the page to the specified string.

Parameters:
strFavicon - The new Favicon of the page.

getTheme

public java.lang.String getTheme()
Returns the theme of the page

Returns:
The theme of the page as a string.

setTheme

public void setTheme(java.lang.String strTheme)
Sets the Theme of the page to the specified string.

Parameters:
strTheme - The new Theme of the page.

isHomePage

public boolean isHomePage()
Returns weither the current page is an homepage or not.

Returns:
true if the page is an homepage, otherwise false.

setHomePage

public void setHomePage(boolean bHomePage)
Sets the homepage indicator.

Parameters:
bHomePage - Should be true if the page is an homepage, otherwise false.


Copyright © 2011 Mairie de Paris. All Rights Reserved.