Uses of Class
org.opencms.workplace.CmsWorkplaceSettings

Packages that use CmsWorkplaceSettings

Package	Description
org.opencms.ui	General code for the Vaadin UI
org.opencms.ui.login	Contains the user interface components for the Vaadin-based login dialog
org.opencms.workplace	The base classes for the OpenCms Workplace (standard dialog, tab dialog, report based dialog) and the Workplace configuration classes are located here.
org.opencms.workplace.editors	Base classes for the editors (WYSIWYG, plain text, XML content) used in the OpenCms Workplace.
org.opencms.workplace.galleries	Contains the various "Galleries" which are available in the editors and widgets of the OpenCms Workplace.
org.opencms.workplace.threads	A collection of thread classes that are used in the OpenCms Workplace, usually in connection with a report.
org.opencms.workplace.tools	Contains the base classes for implementing a tool in the OpenCms Workplace "Administration" view.

Uses of CmsWorkplaceSettings in org.opencms.ui

Methods in org.opencms.ui that return CmsWorkplaceSettings

Modifier and Type	Method and Description
CmsWorkplaceSettings	A_CmsUI.getWorkplaceSettings() Returns the workplace settings.

Uses of CmsWorkplaceSettings in org.opencms.ui.login

Methods in org.opencms.ui.login that return CmsWorkplaceSettings

Modifier and Type	Method and Description
CmsWorkplaceSettings	CmsLoginController.UserAgreementHelper.getSettings()
static CmsWorkplaceSettings	CmsLoginHelper.initSiteAndProject(CmsObject cms) Initializes the site and project for a CMS context after login, and returns the workplace settings for the corresponding user.

Methods in org.opencms.ui.login with parameters of type CmsWorkplaceSettings

Modifier and Type	Method and Description
static java.lang.String	CmsLoginController.getLoginTarget(CmsObject currentCms, CmsWorkplaceSettings settings, java.lang.String requestedResource) Gets the login target link.

Constructors in org.opencms.ui.login with parameters of type CmsWorkplaceSettings

Constructor and Description
UserAgreementHelper(CmsObject cms, CmsWorkplaceSettings wpSettings) Creates a new instance.

Uses of CmsWorkplaceSettings in org.opencms.workplace

Methods in org.opencms.workplace that return CmsWorkplaceSettings

Modifier and Type	Method and Description
CmsWorkplaceSettings	CmsWorkplace.getSettings() Returns the current users workplace settings.
static CmsWorkplaceSettings	CmsWorkplace.getWorkplaceSettings(CmsObject cms, javax.servlet.http.HttpServletRequest req) Returns the workplace settings of the current user.
static CmsWorkplaceSettings	CmsWorkplace.initUserSettings(CmsObject cms, CmsWorkplaceSettings settings, boolean update) Updates the user settings in the given workplace settings for the current user, reading the user settings from the database if required.
static CmsWorkplaceSettings	CmsWorkplace.initWorkplaceSettings(CmsObject cms, CmsWorkplaceSettings settings, boolean update) Updates the given workplace settings, also re-initializing the state of the Workplace to the users preferences (for example setting the startup site and project).

Methods in org.opencms.workplace with parameters of type CmsWorkplaceSettings

Modifier and Type	Method and Description
void	CmsWorkplace.fillParamValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) First sets site and project in the workplace settings, then fills all class parameter values from the data provided in the current request.
static java.lang.String	CmsWorkplace.getStartSiteRoot(CmsObject cms, CmsWorkplaceSettings settings) Returns the start site from the given workplace settings.
boolean	CmsWorkplace.initSettings(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Sets site and project in the workplace settings with the request values of parameters CmsWorkplace.PARAM_WP_SITE and CmsWorkplace.PARAM_WP_PROJECT.
static CmsWorkplaceSettings	CmsWorkplace.initUserSettings(CmsObject cms, CmsWorkplaceSettings settings, boolean update) Updates the user settings in the given workplace settings for the current user, reading the user settings from the database if required.
protected void	CmsLoginUserAgreement.initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
protected abstract void	CmsWorkplace.initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request) Analyzes the request for workplace parameters and adjusts the workplace settings accordingly.
protected void	CmsDialog.initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
static CmsWorkplaceSettings	CmsWorkplace.initWorkplaceSettings(CmsObject cms, CmsWorkplaceSettings settings, boolean update) Updates the given workplace settings, also re-initializing the state of the Workplace to the users preferences (for example setting the startup site and project).

Uses of CmsWorkplaceSettings in org.opencms.workplace.editors

Methods in org.opencms.workplace.editors with parameters of type CmsWorkplaceSettings

Modifier and Type	Method and Description
protected void	CmsSimpleEditor.initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
protected void	CmsSimplePageEditor.initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
protected void	CmsDialogCopyLanguage.initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
protected void	CmsXmlContentEditor.initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
protected void	CmsDialogElements.initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
protected void	CmsEditorFrameset.initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)

Uses of CmsWorkplaceSettings in org.opencms.workplace.galleries

Methods in org.opencms.workplace.galleries with parameters of type CmsWorkplaceSettings

Modifier and Type	Method and Description
protected void	CmsOpenGallery.initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)
protected void	A_CmsAjaxGallery.initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)

Uses of CmsWorkplaceSettings in org.opencms.workplace.threads

Constructors in org.opencms.workplace.threads with parameters of type CmsWorkplaceSettings

Constructor and Description
CmsRelationsValidatorThread(CmsObject cms, CmsPublishList publishList, CmsWorkplaceSettings settings) Creates a thread that validates the relations in the list of unpublished file(s) of the current (offline) project.

Uses of CmsWorkplaceSettings in org.opencms.workplace.tools

Methods in org.opencms.workplace.tools with parameters of type CmsWorkplaceSettings

Modifier and Type	Method and Description
protected void	CmsToolDialog.initWorkplaceRequestValues(CmsWorkplaceSettings settings, javax.servlet.http.HttpServletRequest request)