Uses of Class
org.opencms.workplace.CmsWorkplace

Packages that use CmsWorkplace

Package	Description
org.opencms.ade.galleries	Contains server side classes for the gallery dialogs.
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.tools	Contains the base classes for implementing a tool in the OpenCms Workplace "Administration" view.

Uses of CmsWorkplace in org.opencms.ade.galleries

Subclasses of CmsWorkplace in org.opencms.ade.galleries

Modifier and Type	Class and Description
class	CmsOpenGallery Provides methods to open gwt-based gallery dialog.

Uses of CmsWorkplace in org.opencms.ui.login

Subclasses of CmsWorkplace in org.opencms.ui.login

Modifier and Type	Class and Description
protected static class	CmsLoginController.UserAgreementHelper Helper subclass of CmsLoginUserAgreement which can be used without a page context.

Uses of CmsWorkplace in org.opencms.workplace

Subclasses of CmsWorkplace in org.opencms.workplace

Modifier and Type	Class and Description
class	CmsDialog Provides methods for building the dialog windows of OpenCms.
class	CmsLoginUserAgreement Provides methods to show a configurable user agreement dialog after a successful workplace login.

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

Modifier and Type	Method and Description
static java.lang.String	CmsWorkplace.generatePageStartSimple(CmsWorkplace wp) Generates the header for the simple report view.
static java.lang.String	CmsWorkplaceMessages.getNewResourceTitle(CmsWorkplace wp, java.lang.String name) Returns the title for the "new resource" dialog.
static java.lang.String	CmsWorkplaceMessages.getResourceTypeDescription(CmsWorkplace wp, java.lang.String name) Returns the description of the given resource type name.
static java.lang.String	CmsWorkplaceMessages.getResourceTypeName(CmsWorkplace wp, java.lang.String name) Returns the localized name of the given resource type name.
void	CmsDialog.includeErrorpage(CmsWorkplace wp, java.lang.Throwable t) Displays the throwable on the error page and logs the error.

Uses of CmsWorkplace in org.opencms.workplace.editors

Subclasses of CmsWorkplace in org.opencms.workplace.editors

Modifier and Type	Class and Description
class	CmsDefaultPageEditor Provides methods for building editors for the CmsDefaultPage page type.
class	CmsDialogCopyLanguage Provides methods for the editor copy language dialog.
class	CmsDialogElements Provides methods for the editor elements dialog.
class	CmsEditor Provides basic methods for building the file editors of OpenCms.
class	CmsEditorBase Base class for all editors that turns of time warp deletion inherited from CmsWorkplace.
class	CmsEditorFrameset Helper class to create the editor frameset.
class	CmsPreEditorAction Handles the actions that should be performed before opening the editor frameset.
class	CmsSimpleEditor Creates the output for editing a resource (text or JSP files).
class	CmsSimplePageEditor Creates the output for editing a CmsDefaultPage with the simple textarea editor.
class	CmsXmlContentEditor Creates the editor for XML content definitions.

Uses of CmsWorkplace in org.opencms.workplace.galleries

Subclasses of CmsWorkplace in org.opencms.workplace.galleries

Modifier and Type	Class and Description
class	A_CmsAjaxGallery Provides the general helper methods to generate the content of a gallery dialog used in the XML content editors, WYSIWYG editors and context menu.
class	CmsAjaxDownloadGallery Provides the specific constants, members and helper methods to generate the content of the download gallery dialog used in the XML content editors, WYSIWYG editors and context menu.
class	CmsAjaxImageGallery Provides the specific constants, members and helper methods to generate the content of the image gallery dialog used in the XML content editors, WYSIWYG editors and context menu.
class	CmsAjaxLinkGallery Provides the specific constants, members and helper methods to generate the content of the external link gallery dialog used in the XML content editors, WYSIWYG editors and context menu.

Uses of CmsWorkplace in org.opencms.workplace.tools

Subclasses of CmsWorkplace in org.opencms.workplace.tools

Modifier and Type	Class and Description
class	CmsExplorerDialog Dialog for explorer views in the administration view.
class	CmsToolDialog Helper class that encapsulates all the code for the "new" style of the administration dialogs.

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

Modifier and Type	Method and Description
java.lang.String	CmsTool.buttonHtml(CmsWorkplace wp) Returns the necessary html code for a link to this tool.
java.lang.String	I_CmsHtmlIconButton.buttonHtml(CmsWorkplace wp) Returns the necessary html code.
java.lang.String	CmsToolManager.generateNavBar(java.lang.String toolPath, CmsWorkplace wp) Returns the navigation bar html code for the given tool path.
java.lang.String	CmsToolManager.getBaseToolPath(CmsWorkplace wp) Returns the base tool path for the active user.
CmsToolRootHandler	CmsToolManager.getCurrentRoot(CmsWorkplace wp) Returns the current user's root handler.
CmsTool	CmsToolManager.getCurrentTool(CmsWorkplace wp) Returns the current tool.
java.lang.String	CmsToolManager.getCurrentToolPath(CmsWorkplace wp) Returns the current tool path.
java.util.Map<java.lang.String,java.lang.String[]>	A_CmsToolHandler.getParameters(CmsWorkplace wp)
java.util.Map<java.lang.String,java.lang.String[]>	I_CmsToolHandler.getParameters(CmsWorkplace wp) Returns the evaluated map of parameters.
java.lang.String	CmsToolManager.getParent(CmsWorkplace wp, java.lang.String toolPath) Returns the path to the parent of the tool identified by the given tool path.
java.util.List<CmsTool>	CmsToolManager.getToolsForPath(CmsWorkplace wp, java.lang.String baseTool, boolean includeSubtools) Returns a list of all tools in the given path.
CmsToolUserData	CmsToolManager.getUserData(CmsWorkplace wp) Returns the CmsToolUserData object for a given user.
java.lang.String	CmsTool.groupHtml(CmsWorkplace wp) Returns the necessary html code for the tool subgroups.
java.lang.String	CmsToolGroup.groupHtml(CmsWorkplace wp) Returns the necessary html code.
boolean	A_CmsToolHandler.isEnabled(CmsWorkplace wp)
boolean	I_CmsToolHandler.isEnabled(CmsWorkplace wp) Returns the state of the admin tool for a given workplace context.
boolean	A_CmsToolHandler.isVisible(CmsWorkplace wp)
boolean	I_CmsToolHandler.isVisible(CmsWorkplace wp) Returns the visibility flag for a given workplace context.
void	CmsToolManager.jspForwardPage(CmsWorkplace wp, java.lang.String pagePath, java.util.Map<java.lang.String,java.lang.String[]> params) Redirects to the given page with the given parameters.
void	CmsToolManager.jspForwardTool(CmsWorkplace wp, java.lang.String toolPath, java.util.Map<java.lang.String,java.lang.String[]> params) Redirects to the given tool with the given parameters.
static java.lang.String	CmsToolMacroResolver.resolveMacros(java.lang.String input, CmsWorkplace wp) Resolves the macros in the given input using the provided parameters.
void	CmsToolManager.setBaseToolPath(CmsWorkplace wp, java.lang.String baseToolPath) Sets the base tool path.
void	CmsToolManager.setCurrentRoot(CmsWorkplace wp, java.lang.String key) Sets the current user's root key.
void	CmsToolManager.setCurrentToolPath(CmsWorkplace wp, java.lang.String currentToolPath) Sets the current tool path.

Constructors in org.opencms.workplace.tools with parameters of type CmsWorkplace

Constructor and Description
CmsToolMacroResolver(CmsWorkplace wp) Default private constructor.