Package org.silverpeas.core.web.look

Class LookSilverpeasV5Helper

java.lang.Object

org.silverpeas.core.web.look.LookHelper

org.silverpeas.core.web.look.LookSilverpeasV5Helper

public class LookSilverpeasV5Helper
extends LookHelper

Field Summary

Fields inherited from class org.silverpeas.core.web.look.LookHelper

SESSION_ATT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LookSilverpeasV5Helper(javax.servlet.http.HttpSession session)	Constructs a new LookSilverpeasV5Helper instance for the specified session.

Method Summary

Modifier and Type	Method	Description
boolean	displayContextualPDC()
boolean	displayPDCFrame()
boolean	displayPDCInNavigationFrame()
boolean	displaySpaceIcons()
String	getComponentId()
String	getComponentURL(String key)
String	getComponentURL(String key, String function)
String	getDate()
String	getDefaultSpaceId()
UserMenuDisplay	getDisplayUserMenu()
protected Optional<GraphicElementFactory>	getGraphicElementFactory()
String	getLanguage()
List<PublicationDetail>	getLatestPublications(String spaceId, int nbPublis)
List<PublicationDetail>	getLatestPublications(String spaceId, List<String> excludedComponents, int nbPublis)
LayoutConfiguration	getLayoutConfiguration()
LocalizationBundle	getLocalizedBundle()
String	getMainFrame()
protected MainSessionController	getMainSessionController()
int	getNBConnectedUsers()
List<PublicationDetail>	getNews(String spaceId)
protected OrganizationController	getOrganisationController()
protected PublicationHelper	getPublicationHelper()
PublicationService	getPublicationService()
boolean	getSettings(String key)
boolean	getSettings(String key, boolean defaultValue)
int	getSettings(String key, int defaultValue)
String	getSettings(String key, String defaultValue)
SettingBundle	getSettingsBundle()
List<Shortcut>	getShortcuts(String id, int nb)	Returns a list of shortcuts to display on a page (home page, heading page...)
List<UserDetail>	getSpaceAdmins(String spaceId)
DefaultSpaceHomePage	getSpaceHomePage(String spaceId)
String	getSpaceHomePage(String spaceId, javax.servlet.http.HttpServletRequest request)
String	getSpaceId()
String	getSpaceId(String componentId)
String	getSpaceWallPaper()
String	getSpaceWithCSSToApply()
String	getString(String key)
String	getSubSpaceId()
TickerSettings	getTickerSettings()
List<TopItem>	getTopItems()
List<String>	getTopSpaceIds()
String	getURLOfLastVisitedCollaborativeSpace()
UserDetail	getUserDetail()
UserFull	getUserFull()
String	getUserFullName()
String	getUserFullName(String userId)
String	getUserId()
List<PublicationDetail>	getValidPublications(NodePK nodePK)
String	getWallPaper(String spaceId)
ZoneId	getZoneId()
void	init(MainSessionController mainSessionController, SettingBundle resources)
void	initLayoutConfiguration()
boolean	isAnonymousAccess()
boolean	isAnonymousUser()
boolean	isBackOfficeVisible()
boolean	isDisplayPDCInHomePage()
boolean	isEnableUFSContainsState()
boolean	isMenuPersonalisationEnabled()
void	setComponentId(String componentId)
void	setComponentIdAndSpaceIds(String spaceId, String subSpaceId, String componentId)
void	setDisplayUserMenu(UserMenuDisplay displayUserMenu)
void	setMainFrame(String newMainFrame)
void	setSpaceId(String spaceId)
void	setSpaceIdAndSubSpaceId(String spaceId)
void	setSubSpaceId(String subSpaceId)

Methods inherited from class org.silverpeas.core.web.look.LookHelper

getLookHelper, newLookHelper

Methods inherited from class java.lang.Object

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

Constructor Detail

LookSilverpeasV5Helper

protected LookSilverpeasV5Helper(javax.servlet.http.HttpSession session)

Constructs a new LookSilverpeasV5Helper instance for the specified session.

Parameters:

session - the session of a user.

Method Detail

getSpaceId

public String getSpaceId()

Specified by:

getSpaceId in class LookHelper

setSpaceId

public void setSpaceId(String spaceId)

Specified by:

setSpaceId in class LookHelper

getSubSpaceId

public String getSubSpaceId()

Specified by:

getSubSpaceId in class LookHelper

setSubSpaceId

public void setSubSpaceId(String subSpaceId)

Specified by:

setSubSpaceId in class LookHelper

getComponentId

public String getComponentId()

Specified by:

getComponentId in class LookHelper

setComponentId

public void setComponentId(String componentId)

Specified by:

setComponentId in class LookHelper

setSpaceIdAndSubSpaceId

public void setSpaceIdAndSubSpaceId(String spaceId)

Specified by:

setSpaceIdAndSubSpaceId in class LookHelper

Parameters:

spaceId - can be id of a space or a subspace

setComponentIdAndSpaceIds

public void setComponentIdAndSpaceIds(String spaceId,
                                      String subSpaceId,
                                      String componentId)

Specified by:

setComponentIdAndSpaceIds in class LookHelper

init

public final void init(MainSessionController mainSessionController,
                       SettingBundle resources)

Specified by:

init in class LookHelper

initLayoutConfiguration

public void initLayoutConfiguration()

Specified by:

initLayoutConfiguration in class LookHelper

getLayoutConfiguration

public LayoutConfiguration getLayoutConfiguration()

Specified by:

getLayoutConfiguration in class LookHelper

isMenuPersonalisationEnabled

public boolean isMenuPersonalisationEnabled()

Specified by:

isMenuPersonalisationEnabled in class LookHelper

getMainSessionController

protected MainSessionController getMainSessionController()

getOrganisationController

protected OrganizationController getOrganisationController()

getGraphicElementFactory

protected Optional<GraphicElementFactory> getGraphicElementFactory()

getUserFullName

public String getUserFullName(String userId)

Specified by:

getUserFullName in class LookHelper

getUserFullName

public String getUserFullName()

Specified by:

getUserFullName in class LookHelper

getUserId

public String getUserId()

Specified by:

getUserId in class LookHelper

getUserDetail

public UserDetail getUserDetail()

Specified by:

getUserDetail in class LookHelper

getUserFull

public UserFull getUserFull()

getLanguage

public String getLanguage()

Specified by:

getLanguage in class LookHelper

getZoneId

public ZoneId getZoneId()

Specified by:

getZoneId in class LookHelper

isAnonymousUser

public boolean isAnonymousUser()

Specified by:

isAnonymousUser in class LookHelper

displayPDCInNavigationFrame

public boolean displayPDCInNavigationFrame()

Specified by:

displayPDCInNavigationFrame in class LookHelper

displayPDCFrame

public boolean displayPDCFrame()

Specified by:

displayPDCFrame in class LookHelper

displayContextualPDC

public boolean displayContextualPDC()

Specified by:

displayContextualPDC in class LookHelper

displaySpaceIcons

public boolean displaySpaceIcons()

Specified by:

displaySpaceIcons in class LookHelper

getSpaceId

public String getSpaceId(String componentId)

Specified by:

getSpaceId in class LookHelper

getWallPaper

public String getWallPaper(String spaceId)

Specified by:

getWallPaper in class LookHelper

getNBConnectedUsers

public int getNBConnectedUsers()

Specified by:

getNBConnectedUsers in class LookHelper

isAnonymousAccess

public boolean isAnonymousAccess()

Specified by:

isAnonymousAccess in class LookHelper

getSettings

public boolean getSettings(String key)

Specified by:

getSettings in class LookHelper

getSettings

public boolean getSettings(String key,
                           boolean defaultValue)

Specified by:

getSettings in class LookHelper

getSettings

public String getSettings(String key,
                          String defaultValue)

Specified by:

getSettings in class LookHelper

getSettings

public int getSettings(String key,
                       int defaultValue)

Specified by:

getSettings in class LookHelper

getLocalizedBundle

public LocalizationBundle getLocalizedBundle()

getString

public String getString(String key)

Specified by:

getString in class LookHelper

isBackOfficeVisible

public boolean isBackOfficeVisible()

Specified by:

isBackOfficeVisible in class LookHelper

getTopItems

public List<TopItem> getTopItems()

Specified by:

getTopItems in class LookHelper

getTopSpaceIds

public List<String> getTopSpaceIds()

Specified by:

getTopSpaceIds in class LookHelper

getMainFrame

public String getMainFrame()

Specified by:

getMainFrame in class LookHelper

setMainFrame

public void setMainFrame(String newMainFrame)

Specified by:

setMainFrame in class LookHelper

getSpaceWallPaper

public String getSpaceWallPaper()

Specified by:

getSpaceWallPaper in class LookHelper

getSpaceWithCSSToApply

public String getSpaceWithCSSToApply()

Specified by:

getSpaceWithCSSToApply in class LookHelper

getComponentURL

public String getComponentURL(String key,
                              String function)

getComponentURL

public String getComponentURL(String key)

Specified by:

getComponentURL in class LookHelper

getDate

public String getDate()

Specified by:

getDate in class LookHelper

getDefaultSpaceId

public String getDefaultSpaceId()

Specified by:

getDefaultSpaceId in class LookHelper

getPublicationHelper

protected PublicationHelper getPublicationHelper()
                                          throws ClassNotFoundException,
                                                 InstantiationException,
                                                 IllegalAccessException

Throws:

ClassNotFoundException

InstantiationException

IllegalAccessException

getLatestPublications

public List<PublicationDetail> getLatestPublications(String spaceId,
                                                     int nbPublis)

Specified by:

getLatestPublications in class LookHelper

getLatestPublications

public List<PublicationDetail> getLatestPublications(String spaceId,
                                                     List<String> excludedComponents,
                                                     int nbPublis)

Specified by:

getLatestPublications in class LookHelper

getValidPublications

public List<PublicationDetail> getValidPublications(NodePK nodePK)

Specified by:

getValidPublications in class LookHelper

getPublicationService

public PublicationService getPublicationService()

getSpaceHomePage

public String getSpaceHomePage(String spaceId,
                               javax.servlet.http.HttpServletRequest request)
                        throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getDisplayUserMenu

public UserMenuDisplay getDisplayUserMenu()

Specified by:

getDisplayUserMenu in class LookHelper

Returns:

user favorite space menu display mode

setDisplayUserMenu

public void setDisplayUserMenu(UserMenuDisplay displayUserMenu)

Specified by:

setDisplayUserMenu in class LookHelper

isEnableUFSContainsState

public boolean isEnableUFSContainsState()

Specified by:

isEnableUFSContainsState in class LookHelper

Returns:

true if displaying three states, false if displaying two states

getShortcuts

public List<Shortcut> getShortcuts(String id,
                                   int nb)

Returns a list of shortcuts to display on a page (home page, heading page...)

Parameters:

id - identify the area of shorcuts

nb - the number of shortcuts to retrieve

Returns:

a List of Shorcut

isDisplayPDCInHomePage

public boolean isDisplayPDCInHomePage()

Specified by:

isDisplayPDCInHomePage in class LookHelper

Returns:

the displayPDCInHomePage

getSpaceHomePage

public DefaultSpaceHomePage getSpaceHomePage(String spaceId)

Specified by:

getSpaceHomePage in class LookHelper

getSpaceAdmins

public List<UserDetail> getSpaceAdmins(String spaceId)

getNews

public List<PublicationDetail> getNews(String spaceId)

getTickerSettings

public TickerSettings getTickerSettings()

Specified by:

getTickerSettings in class LookHelper

getURLOfLastVisitedCollaborativeSpace

public String getURLOfLastVisitedCollaborativeSpace()

Specified by:

getURLOfLastVisitedCollaborativeSpace in class LookHelper

getSettingsBundle

public SettingBundle getSettingsBundle()