Package org.silverpeas.core.web.look
Class LookHelper
- java.lang.Object
-
- org.silverpeas.core.web.look.LookHelper
-
- Direct Known Subclasses:
LookSilverpeasV5Helper
public abstract class LookHelper extends Object
A LookHelper is an utility class aiming to facilitate the access of the current Web navigation of the user in the Silverpeas Web interface as well of some settings on the Web displaying. As such a LookHelper is instantiated once per user session.
-
-
Field Summary
Fields Modifier and Type Field Description static String
SESSION_ATT
-
Constructor Summary
Constructors Constructor Description LookHelper()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description abstract boolean
displayContextualPDC()
abstract boolean
displayPDCFrame()
abstract boolean
displayPDCInNavigationFrame()
abstract boolean
displaySpaceIcons()
abstract String
getComponentId()
abstract String
getComponentURL(String componentId)
abstract String
getDate()
abstract String
getDefaultSpaceId()
abstract UserMenuDisplay
getDisplayUserMenu()
abstract String
getLanguage()
abstract List<PublicationDetail>
getLatestPublications(String spaceId, int nbPublis)
abstract List<PublicationDetail>
getLatestPublications(String spaceId, List<String> excludedComponents, int nbPublis)
abstract LayoutConfiguration
getLayoutConfiguration()
static LookHelper
getLookHelper(javax.servlet.http.HttpSession session)
Gets the look helper actually set in the user session.abstract String
getMainFrame()
abstract int
getNBConnectedUsers()
abstract boolean
getSettings(String key)
abstract boolean
getSettings(String key, boolean defaultValue)
abstract int
getSettings(String key, int defaultValue)
abstract String
getSettings(String key, String defaultValue)
abstract DefaultSpaceHomePage
getSpaceHomePage(String spaceId)
abstract String
getSpaceId()
abstract String
getSpaceId(String componentId)
abstract String
getSpaceWallPaper()
abstract String
getSpaceWithCSSToApply()
abstract String
getString(String key)
abstract String
getSubSpaceId()
abstract TickerSettings
getTickerSettings()
abstract List<TopItem>
getTopItems()
abstract List<String>
getTopSpaceIds()
abstract String
getURLOfLastVisitedCollaborativeSpace()
abstract UserDetail
getUserDetail()
abstract String
getUserFullName()
abstract String
getUserFullName(String userId)
abstract String
getUserId()
abstract List<PublicationDetail>
getValidPublications(NodePK nodePK)
abstract String
getWallPaper(String spaceId)
abstract ZoneId
getZoneId()
abstract void
init(MainSessionController mainSessionController, org.silverpeas.kernel.bundle.SettingBundle resources)
Deprecated.abstract void
initLayoutConfiguration()
abstract boolean
isAccessGuest()
abstract boolean
isAnonymousAccess()
abstract boolean
isAnonymousUser()
abstract boolean
isBackOfficeVisible()
boolean
isConnectedUsersDisplayEnabled()
boolean
isDirectoryDisplayEnabled()
abstract boolean
isDisplayPDCInHomePage()
abstract boolean
isEnableUFSContainsState()
abstract boolean
isMenuPersonalisationEnabled()
static LookHelper
newLookHelper(javax.servlet.http.HttpSession session)
Creates a new look helper instance and put it into the current user session.abstract void
setComponentId(String componentId)
abstract void
setComponentIdAndSpaceIds(String spaceId, String subSpaceId, String componentId)
abstract void
setDisplayUserMenu(UserMenuDisplay userMenuDisplayMode)
abstract void
setMainFrame(String mainFrame)
abstract void
setSpaceId(String spaceId)
abstract void
setSpaceIdAndSubSpaceId(String spaceId)
abstract void
setSubSpaceId(String subSpaceId)
-
-
-
Field Detail
-
SESSION_ATT
public static final String SESSION_ATT
- See Also:
- Constant Field Values
-
-
Method Detail
-
newLookHelper
public static LookHelper newLookHelper(javax.servlet.http.HttpSession session)
Creates a new look helper instance and put it into the current user session.- Parameters:
session
- a user HTTP session.- Returns:
- a new look helper.
-
getLookHelper
public static LookHelper getLookHelper(javax.servlet.http.HttpSession session)
Gets the look helper actually set in the user session.- Parameters:
session
- an HTTP user session.- Returns:
- a look helper or null if no one was registered into the current user session.
-
getURLOfLastVisitedCollaborativeSpace
public abstract String getURLOfLastVisitedCollaborativeSpace()
-
getSpaceId
public abstract String getSpaceId()
-
setSpaceId
public abstract void setSpaceId(String spaceId)
-
getSubSpaceId
public abstract String getSubSpaceId()
-
setSubSpaceId
public abstract void setSubSpaceId(String subSpaceId)
-
getComponentId
public abstract String getComponentId()
-
setComponentId
public abstract void setComponentId(String componentId)
-
isMenuPersonalisationEnabled
public abstract boolean isMenuPersonalisationEnabled()
-
setSpaceIdAndSubSpaceId
public abstract void setSpaceIdAndSubSpaceId(String spaceId)
- Parameters:
spaceId
- can be id of a space or a subspace
-
setComponentIdAndSpaceIds
public abstract void setComponentIdAndSpaceIds(String spaceId, String subSpaceId, String componentId)
-
init
@Deprecated public abstract void init(MainSessionController mainSessionController, org.silverpeas.kernel.bundle.SettingBundle resources)
Deprecated.
-
getUserFullName
public abstract String getUserFullName()
-
getUserId
public abstract String getUserId()
-
getLanguage
public abstract String getLanguage()
-
getZoneId
public abstract ZoneId getZoneId()
-
isAnonymousUser
public abstract boolean isAnonymousUser()
-
isAccessGuest
public abstract boolean isAccessGuest()
-
isConnectedUsersDisplayEnabled
public boolean isConnectedUsersDisplayEnabled()
-
isDirectoryDisplayEnabled
public boolean isDirectoryDisplayEnabled()
-
displayPDCInNavigationFrame
public abstract boolean displayPDCInNavigationFrame()
-
displayPDCFrame
public abstract boolean displayPDCFrame()
-
displayContextualPDC
public abstract boolean displayContextualPDC()
-
displaySpaceIcons
public abstract boolean displaySpaceIcons()
-
getNBConnectedUsers
public abstract int getNBConnectedUsers()
-
isAnonymousAccess
public abstract boolean isAnonymousAccess()
-
getSettings
public abstract boolean getSettings(String key)
-
getSettings
public abstract boolean getSettings(String key, boolean defaultValue)
-
getSettings
public abstract int getSettings(String key, int defaultValue)
-
isBackOfficeVisible
public abstract boolean isBackOfficeVisible()
-
getMainFrame
public abstract String getMainFrame()
-
setMainFrame
public abstract void setMainFrame(String mainFrame)
-
getSpaceWallPaper
public abstract String getSpaceWallPaper()
-
getDate
public abstract String getDate()
-
getDefaultSpaceId
public abstract String getDefaultSpaceId()
-
getLatestPublications
public abstract List<PublicationDetail> getLatestPublications(String spaceId, int nbPublis)
-
getLatestPublications
public abstract List<PublicationDetail> getLatestPublications(String spaceId, List<String> excludedComponents, int nbPublis)
-
getValidPublications
public abstract List<PublicationDetail> getValidPublications(NodePK nodePK)
-
getDisplayUserMenu
public abstract UserMenuDisplay getDisplayUserMenu()
-
setDisplayUserMenu
public abstract void setDisplayUserMenu(UserMenuDisplay userMenuDisplayMode)
-
isEnableUFSContainsState
public abstract boolean isEnableUFSContainsState()
-
isDisplayPDCInHomePage
public abstract boolean isDisplayPDCInHomePage()
-
getSpaceWithCSSToApply
public abstract String getSpaceWithCSSToApply()
-
getSpaceHomePage
public abstract DefaultSpaceHomePage getSpaceHomePage(String spaceId)
-
getTickerSettings
public abstract TickerSettings getTickerSettings()
-
getUserDetail
public abstract UserDetail getUserDetail()
-
getLayoutConfiguration
public abstract LayoutConfiguration getLayoutConfiguration()
-
initLayoutConfiguration
public abstract void initLayoutConfiguration()
-
-