Package org.opencms.workplace

Class CmsFrameset

  • public class CmsFrameset
extends org.opencms.workplace.CmsWorkplace
    Provides methods for building the main framesets of the OpenCms Workplace.

    The following files use this class:

    • /views/top.html
    • /views/top_foot.html
    • /views/top_head.html

    Since:
    6.0.0

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.util.List<java.lang.String> FRAMES_LIST
      The names of the supported frames in a list.
      static java.lang.String JSP_WORKPLACE_URI
      Path to the JSP workplace frame loader file.
      static java.lang.String PARAM_WP_FRAME
      The request parameter for the selection of the frame.
      static java.lang.String PARAM_WP_START
      The request parameter for the workplace start selection.
      static java.lang.String PARAM_WP_VIEW
      The request parameter for the workplace view selection.

      • Fields inherited from class org.opencms.workplace.CmsWorkplace

        DEBUG, DEFAULT_DATE_STRING, DEFAULT_LANGUAGE, DEFAULT_LOCALE, DIALOG_PATH_COMMON, FILE_DIALOG_CLOSE, FILE_DIALOG_SCREEN_CONFIRM, FILE_DIALOG_SCREEN_ERROR, FILE_DIALOG_SCREEN_ERRORPAGE, FILE_DIALOG_SCREEN_WAIT, FILE_EXPLORER_FILELIST, FILE_REPORT_OUTPUT, HTML_END, HTML_START, INPUT_DEFAULT, INPUT_NONE, PARAM_DIRECTPUBLISH, PARAM_MODELFILE, PARAM_NEWRESOURCETYPE, PARAM_PUBLISHSIBLINGS, PARAM_RELATEDRESOURCES, PARAM_RESOURCELIST, PARAM_SUBRESOURCES, PARAM_WP_EXPLORER_RESOURCE, PARAM_WP_PROJECT, PARAM_WP_SITE, PATH_DIALOGS, PATH_WORKPLACE, REQUEST_ATTRIBUTE_MULTIPART, REQUEST_ATTRIBUTE_RELOADTREE, RES_PATH_FILETYPES, RFS_PATH_RESOURCES, SESSION_WORKPLACE_CLASS, VFS_DIR_DEFAULTBODIES, VFS_DIR_TEMPLATES, VFS_PATH_COMMONS, VFS_PATH_EDITORS, VFS_PATH_GALLERIES, VFS_PATH_LOCALES, VFS_PATH_MODELDIALOG, VFS_PATH_MODULES, VFS_PATH_NEWRESOURCEDIALOG, VFS_PATH_RESOURCES, VFS_PATH_SITES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_ADMIN, VIEW_DIRECT_EDIT, VIEW_EXPLORER, VIEW_GALLERY, VIEW_LIST, VIEW_WORKPLACE

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsFrameset​(org.opencms.jsp.CmsJspActionElement jsp)
      Public constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<org.opencms.file.CmsProject> filterProjectsForSelector​(java.util.List<org.opencms.file.CmsProject> projects)
      Performs additional filtering on the list of projects for the project selector.
      java.lang.String getBroadcastMessage()
      Returns the javascript code for the broadcast message alert in the foot of the workplace.
      java.lang.String getLoginAddress()
      Returns the remote ip address of the current user.
      java.lang.String getLoginTime()
      Returns the last login time of the current user in localized format.
      java.lang.String getPreferencesButton()
      Returns the html for the "preferences" button depending on the current users permissions and the default workplace settings.
      java.lang.String getProjectSelect​(java.lang.String htmlAttributes, java.lang.String htmlWidth)
      Returns a html select box filled with the current users accessible projects.
      java.lang.String getPublishButton()
      Returns the html for the "publish project" button depending on the current users permissions and the default workplace settings.
      java.lang.String getPublishQueueButton()
      Returns the html for the "publish queue" button.
      java.lang.String getSiteSelect​(java.lang.String htmlAttributes)
      Returns a html select box filled with the current users accessible sites.
      java.lang.String getStartupUri()
      Returns the startup URI for display in the main body frame, this can either be the user default view, or (if set) a specific startup resource.
      java.lang.String getViewSelect​(java.lang.String htmlAttributes)
      Returns a html select box filled with the views accessible by the current user.
      java.lang.String getWorkplaceReloadUri()
      Returns the reload URI for the OpenCms workplace.
      protected void initTimeWarp​(org.opencms.db.CmsUserSettings settings, javax.servlet.http.HttpSession session)  
      protected void initWorkplaceRequestValues​(org.opencms.workplace.CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)  
      boolean isReloadRequired()
      Returns true if a reload of the main body frame is required.
      boolean isSyncEnabled()
      Returns true if the user has enabled synchronization.
      boolean showSiteSelector()
      Indicates if the site selector should be shown in the top frame depending on the count of accessible sites.
      protected void topFrameReload​(org.opencms.workplace.CmsWorkplaceSettings settings)
      Performs certain clear cache actions if the top frame is reloaded.

      • Methods inherited from class org.opencms.workplace.CmsWorkplace

        addMessages, addMessages, allParamsAsHidden, allParamsAsRequest, allParamValues, bodyEnd, bodyStart, bodyStart, buildSelect, buildSelect, button, button, buttonBar, buttonBar, buttonBarHorizontalLine, buttonBarLabel, buttonBarLabel, buttonBarLine, buttonBarLineSpacer, buttonBarSeparator, buttonBarSpacer, buttonBarStartTab, canEditPermissionsForRoles, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, generateCssStyle, generatePageEndExtended, generatePageEndSimple, generatePageStartExtended, generatePageStartSimple, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStartSiteRoot, getStaticResourceUri, getStaticResourceUri, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, getWorkplaceExplorerLink, getWorkplaceExplorerLink, getWorkplaceSettings, htmlEnd, htmlStart, initMessages, initSettings, initUserSettings, initWorkplaceMembers, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, pageBody, pageHtml, pageHtmlStyle, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, substituteSiteTitleStatic, switchToCurrentProject, switchToTempProject, updateUserPreferences

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CmsFrameset

        public CmsFrameset​(org.opencms.jsp.CmsJspActionElement jsp)
        Public constructor.

        Parameters:
        jsp - an initialized JSP action element

    • Method Detail

      • filterProjectsForSelector

        public java.util.List<org.opencms.file.CmsProject> filterProjectsForSelector​(java.util.List<org.opencms.file.CmsProject> projects)
        Performs additional filtering on the list of projects for the project selector.

        Parameters:
        projects - the original project list
        Returns:
        the filtered project list

      • getBroadcastMessage

        public java.lang.String getBroadcastMessage()
        Returns the javascript code for the broadcast message alert in the foot of the workplace.

        Returns:
        javascript code showing an alert box when the foot load

      • getLoginAddress

        public java.lang.String getLoginAddress()
        Returns the remote ip address of the current user.

        Returns:
        the remote ip address of the current user

      • getLoginTime

        public java.lang.String getLoginTime()
        Returns the last login time of the current user in localized format.

        Returns:
        the last login time of the current user in localized format

      • getPreferencesButton

        public java.lang.String getPreferencesButton()
        Returns the html for the "preferences" button depending on the current users permissions and the default workplace settings.

        Returns:
        the html for the "preferences" button

      • getProjectSelect

        public java.lang.String getProjectSelect​(java.lang.String htmlAttributes,
                                         java.lang.String htmlWidth)
        Returns a html select box filled with the current users accessible projects.

        Parameters:
        htmlAttributes - attributes that will be inserted into the generated html
        htmlWidth - additional style attributes containing width information
        Returns:
        a html select box filled with the current users accessible projects

      • getPublishButton

        public java.lang.String getPublishButton()
        Returns the html for the "publish project" button depending on the current users permissions and the default workplace settings.

        Returns:
        the html for the "publish project" button

      • getPublishQueueButton

        public java.lang.String getPublishQueueButton()
        Returns the html for the "publish queue" button.

        Returns:
        the html for the "publish queue" button

      • getSiteSelect

        public java.lang.String getSiteSelect​(java.lang.String htmlAttributes)
        Returns a html select box filled with the current users accessible sites.

        Parameters:
        htmlAttributes - attributes that will be inserted into the generated html
        Returns:
        a html select box filled with the current users accessible sites

      • getStartupUri

        public java.lang.String getStartupUri()
        Returns the startup URI for display in the main body frame, this can either be the user default view, or (if set) a specific startup resource.

        Returns:
        the startup URI for display in the main body frame

      • getViewSelect

        public java.lang.String getViewSelect​(java.lang.String htmlAttributes)
        Returns a html select box filled with the views accessible by the current user.

        Parameters:
        htmlAttributes - attributes that will be inserted into the generated html
        Returns:
        a html select box filled with the views accessible by the current user

      • getWorkplaceReloadUri

        public java.lang.String getWorkplaceReloadUri()
        Returns the reload URI for the OpenCms workplace.

        Returns:
        the reload URI for the OpenCms workplace

      • isReloadRequired

        public boolean isReloadRequired()
        Returns true if a reload of the main body frame is required.

        This value is modified with the select options (project, site or view) in the head frame of the Workplace. If a user changes one of these select values, the head frame is posted "against itself". The posted values will be processed by this class, causing the internal Workplace settings to change. After these settings have been changed, a reload of the main body frame is required in order to update it with the new values. A JavaScript in the Workplace head frame will be executed in this case.

        Returns:
        true if a reload of the main body frame is required

      • isSyncEnabled

        public boolean isSyncEnabled()
        Returns true if the user has enabled synchronization.

        Returns:
        true if the user has enabled synchronization

      • showSiteSelector

        public boolean showSiteSelector()
        Indicates if the site selector should be shown in the top frame depending on the count of accessible sites.

        Returns:
        true if site selector should be shown, otherwise false

      • initTimeWarp

        protected void initTimeWarp​(org.opencms.db.CmsUserSettings settings,
                            javax.servlet.http.HttpSession session)
        Overrides:
        initTimeWarp in class org.opencms.workplace.CmsWorkplace
        See Also:
        CmsWorkplace.initTimeWarp(org.opencms.db.CmsUserSettings, javax.servlet.http.HttpSession)

      • initWorkplaceRequestValues

        protected void initWorkplaceRequestValues​(org.opencms.workplace.CmsWorkplaceSettings settings,
                                          javax.servlet.http.HttpServletRequest request)
        Specified by:
        initWorkplaceRequestValues in class org.opencms.workplace.CmsWorkplace
        See Also:
        CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)

      • topFrameReload

        protected void topFrameReload​(org.opencms.workplace.CmsWorkplaceSettings settings)
        Performs certain clear cache actions if the top frame is reloaded.

        Parameters:
        settings - the current users workplace settings