Class 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.
    • Constructor Detail

      • LookHelper

        public LookHelper()
    • 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​(String userId)
      • 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()
      • getSpaceId

        public abstract String getSpaceId​(String componentId)
      • getWallPaper

        public abstract String getWallPaper​(String spaceId)
      • 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)
      • getString

        public abstract String getString​(String key)
      • isBackOfficeVisible

        public abstract boolean isBackOfficeVisible()
      • getTopItems

        public abstract List<TopItem> getTopItems()
      • getTopSpaceIds

        public abstract List<String> getTopSpaceIds()
      • getMainFrame

        public abstract String getMainFrame()
      • setMainFrame

        public abstract void setMainFrame​(String mainFrame)
      • getSpaceWallPaper

        public abstract String getSpaceWallPaper()
      • getComponentURL

        public abstract String getComponentURL​(String componentId)
      • getDate

        public abstract String getDate()
      • getDefaultSpaceId

        public abstract String getDefaultSpaceId()
      • 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()
      • getTickerSettings

        public abstract TickerSettings getTickerSettings()
      • getUserDetail

        public abstract UserDetail getUserDetail()
      • initLayoutConfiguration

        public abstract void initLayoutConfiguration()