org.opencms.workplace
Class 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

Since:

6.0.0

Field Summary

static List<String>	FRAMES_LIST The names of the supported frames in a list.
static String	JSP_WORKPLACE_URI Path to the JSP workplace frame loader file.
static String	PARAM_WP_FRAME The request parameter for the selection of the frame.
static String	PARAM_WP_START The request parameter for the workplace start selection.
static String	PARAM_WP_VIEW The request parameter for the workplace view selection.

Fields inherited from class org.opencms.workplace.CmsWorkplace

DEBUG, 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, 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_MODULES, VFS_PATH_RESOURCES, VFS_PATH_SYSTEM, VFS_PATH_VIEWS, VFS_PATH_WORKPLACE, VIEW_DIRECT_EDIT, VIEW_WORKPLACE

Constructor Summary

CmsFrameset(CmsJspActionElement jsp)
Public constructor.

Method Summary

String	getBroadcastMessage() Returns the javascript code for the broadcast message alert in the foot of the workplace.
String	getLoginAddress() Returns the remote ip address of the current user.
String	getLoginTime() Returns the last login time of the current user in localized format.
String	getPreferencesButton() Returns the html for the "preferences" button depending on the current users permissions and the default workplace settings.
String	getProjectSelect(String htmlAttributes, String htmlWidth) Returns a html select box filled with the current users accessible projects.
String	getPublishButton() Returns the html for the "publish project" button depending on the current users permissions and the default workplace settings.
String	getPublishQueueButton() Returns the html for the "publish queue" button.
String	getSiteSelect(String htmlAttributes) Returns a html select box filled with the current users accessible sites.
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.
String	getViewSelect(String htmlAttributes) Returns a html select box filled with the views accessible by the current user.
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.

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, checkLock, checkLock, checkRole, decodeParamValue, fillParamValues, fillParamValues, getBroadcastMessageString, getCms, getEncoding, getExplorerFileListFullUri, getFrameSource, getJsp, getLocale, getMacroResolver, getMessages, getMultiPartFileItems, getParameterMap, getResourceUri, getResourceUri, getSession, getSettings, getSkinUri, 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

Methods inherited from class java.lang.Object

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

Field Detail

FRAMES_LIST

public static final List<String> FRAMES_LIST

The names of the supported frames in a list.

JSP_WORKPLACE_URI

public static final String JSP_WORKPLACE_URI

Path to the JSP workplace frame loader file.

See Also:

Constant Field Values

PARAM_WP_FRAME

public static final String PARAM_WP_FRAME

The request parameter for the selection of the frame.

See Also:

Constant Field Values

PARAM_WP_START

public static final String PARAM_WP_START

The request parameter for the workplace start selection.

See Also:

Constant Field Values

PARAM_WP_VIEW

public static final String PARAM_WP_VIEW

The request parameter for the workplace view selection.

See Also:

Constant Field Values

Constructor Detail

CmsFrameset

public CmsFrameset(CmsJspActionElement jsp)

Public constructor.

Parameters:

jsp - an initialized JSP action element

Method Detail

getBroadcastMessage

public 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 String getLoginAddress()

Returns the remote ip address of the current user.

Returns:

the remote ip address of the current user

getLoginTime

public 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 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 String getProjectSelect(String htmlAttributes,
                               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 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 String getPublishQueueButton()

Returns the html for the "publish queue" button.

Returns:

the html for the "publish queue" button

getSiteSelect

public String getSiteSelect(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 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 String getViewSelect(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 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(CmsUserSettings settings,
                            javax.servlet.http.HttpSession session)

Description copied from class: 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.

Overrides:

initTimeWarp in class CmsWorkplace

Parameters:

settings - the user settings which are configured via the preferences dialog

session - the session of the user

See Also:

CmsWorkplace.initTimeWarp(org.opencms.db.CmsUserSettings, javax.servlet.http.HttpSession)

initWorkplaceRequestValues

protected void initWorkplaceRequestValues(CmsWorkplaceSettings settings,
                                          javax.servlet.http.HttpServletRequest request)

Description copied from class: CmsWorkplace

Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.

Specified by:

initWorkplaceRequestValues in class CmsWorkplace

Parameters:

settings - the workplace settings

request - the current request

See Also:

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.

Parameters:

settings - the current users workplace settings