CmsFrameset

java.lang.Object
- org.opencms.workplace.CmsWorkplace
- - org.opencms.workplace.CmsFrameset

```
public class CmsFrameset
extends 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
从以下版本开始:

6.0.0

字段概要

字段
限定符和类型	字段和说明
`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.

构造器概要

构造器
构造器和说明

CmsFrameset(CmsJspActionElement jsp)
Public constructor.

构造器
构造器和说明
`CmsFrameset(CmsJspActionElement jsp)` Public constructor.

方法概要

方法
限定符和类型	方法和说明
`java.util.List<CmsProject>`	`filterProjectsForSelector(java.util.List<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(CmsUserSettings settings, javax.servlet.http.HttpSession session)` Sets the users time warp if configured and if the current timewarp setting is different or clears the current time warp setting if the user has no configured timewarp.
`protected void`	`initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)` Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
`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(CmsWorkplaceSettings settings)` Performs certain clear cache actions if the top frame is reloaded.

从类继承的方法 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, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, getStartSiteRoot, getStyleUri, getStyleUri, getStyleUri, getTemporaryFileName, htmlEnd, htmlStart, initMessages, initSettings, initUserSettings, initWorkplaceMembers, initWorkplaceSettings, isForwarded, isHelpEnabled, isSubElement, isTemporaryFile, key, key, keyDefault, nullToEmpty, pageBody, pageHtml, pageHtmlStyle, paramsAsHidden, paramsAsHidden, paramsAsParameterMap, paramsAsRequest, paramValues, resolveMacros, sendCmsRedirect, sendForward, setForwarded, shortKey, substituteSiteTitle, switchToCurrentProject, switchToTempProject

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - FRAMES_LIST
```
public static final java.util.List<java.lang.String> FRAMES_LIST
```
    The names of the supported frames in a list.
  - JSP_WORKPLACE_URI
```
public static final java.lang.String JSP_WORKPLACE_URI
```
    Path to the JSP workplace frame loader file.
    
    另请参阅:
    常量字段值
  - PARAM_WP_FRAME
```
public static final java.lang.String PARAM_WP_FRAME
```
    The request parameter for the selection of the frame.
    
    另请参阅:
    常量字段值
  - PARAM_WP_START
```
public static final java.lang.String PARAM_WP_START
```
    The request parameter for the workplace start selection.
    
    另请参阅:
    常量字段值
  - PARAM_WP_VIEW
```
public static final java.lang.String PARAM_WP_VIEW
```
    The request parameter for the workplace view selection.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - CmsFrameset
```
public CmsFrameset(CmsJspActionElement jsp)
```
    Public constructor.
    
    参数:
    jsp - an initialized JSP action element
- 方法详细资料
  - filterProjectsForSelector
```
public java.util.List<CmsProject> filterProjectsForSelector(java.util.List<CmsProject> projects)
```
    Performs additional filtering on the list of projects for the project selector.
    
    参数:
    projects - the original project list
    
    返回:
    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.
    
    返回:
    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.
    
    返回:
    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.
    
    返回:
    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.
    
    返回:
    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.
    
    参数:
    htmlAttributes - attributes that will be inserted into the generated html
    htmlWidth - additional style attributes containing width information
    
    返回:
    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.
    
    返回:
    the html for the "publish project" button
  - getPublishQueueButton
```
public java.lang.String getPublishQueueButton()
```
    Returns the html for the "publish queue" button.
    
    返回:
    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.
    
    参数:
    htmlAttributes - attributes that will be inserted into the generated html
    
    返回:
    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.
    
    返回:
    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.
    
    参数:
    htmlAttributes - attributes that will be inserted into the generated html
    
    返回:
    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.
    
    返回:
    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.
    
    返回:
    true if a reload of the main body frame is required
  - isSyncEnabled
```
public boolean isSyncEnabled()
```
    Returns true if the user has enabled synchronization.
    
    返回:
    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.
    
    返回:
    true if site selector should be shown, otherwise false
  - initTimeWarp
```
protected void initTimeWarp(CmsUserSettings settings,
                javax.servlet.http.HttpSession session)
```
    从类复制的说明: CmsWorkplace
    
    Sets the users time warp if configured and if the current timewarp setting is different or clears the current time warp setting if the user has no configured timewarp.
    Timwarping is controlled by the session attribute CmsContextInfo.ATTRIBUTE_REQUEST_TIME with a value of type Long.
    
    覆盖:
    
    initTimeWarp 在类中 CmsWorkplace
    
    参数:
    settings - the user settings which are configured via the preferences dialog
    session - the session of the user
    另请参阅:
    CmsWorkplace.initTimeWarp(org.opencms.db.CmsUserSettings, javax.servlet.http.HttpSession)
  - initWorkplaceRequestValues
```
protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                              javax.servlet.http.HttpServletRequest request)
```
    从类复制的说明: CmsWorkplace
    
    Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
    
    指定者:
    
    initWorkplaceRequestValues 在类中 CmsWorkplace
    
    参数:
    settings - the workplace settings
    request - the current request
    另请参阅:
    CmsWorkplace.initWorkplaceRequestValues(org.opencms.workplace.CmsWorkplaceSettings, javax.servlet.http.HttpServletRequest)
  - topFrameReload
```
protected void topFrameReload(CmsWorkplaceSettings settings)
```
    Performs certain clear cache actions if the top frame is reloaded.
    
    参数:
    settings - the current users workplace settings

类 CmsFrameset

字段概要

从类继承的字段 org.opencms.workplace.CmsWorkplace

构造器概要

方法概要

从类继承的方法 org.opencms.workplace.CmsWorkplace

从类继承的方法 java.lang.Object

字段详细资料

FRAMES_LIST

JSP_WORKPLACE_URI

PARAM_WP_FRAME

PARAM_WP_START

PARAM_WP_VIEW

构造器详细资料

CmsFrameset

方法详细资料

filterProjectsForSelector

getBroadcastMessage

getLoginAddress

getLoginTime

getPreferencesButton

getProjectSelect

getPublishButton

getPublishQueueButton

getSiteSelect

getStartupUri

getViewSelect

getWorkplaceReloadUri

isReloadRequired

isSyncEnabled

showSiteSelector

initTimeWarp

initWorkplaceRequestValues

topFrameReload