Java Doc for CmsWorkplaceManager.java in » Content-Management-System » opencms » org » opencms » workplace » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Content Management System » opencms » org.opencms.workplace

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.opencms.workplace .CmsWorkplaceManager

CmsWorkplaceManager

final public class CmsWorkplaceManager implements I_CmsLocaleHandler,I_CmsEventListener(Code)

Manages the global OpenCms workplace settings for all users.

This class reads the settings from the "opencms.properties" and stores them in member variables. For each setting one or more get methods are provided.

author:
   Andreas Zahner
version:
   $Revision: 1.89 $
since:
   6.0.0

Field Summary
final public static String	DEFAULT_WORKPLACE_ENCODING The default encoding for the workplace (UTF-8).
final public static String	PARAM_LOGIN_REQUESTED_RESOURCE The id of the "requestedResource" parameter for the OpenCms login form.
final public static String	SESSION_WORKPLACE_SETTINGS Key name for the session workplace settings.

Constructor Summary
public	CmsWorkplaceManager()

Method Summary
public void	addDialogHandler(I_CmsDialogHandler clazz)
public void	addEditorCssHandler(String editorCssHandlerClassName)
public void	addEditorCssHandlerToHead(String editorCssHandlerClassName)
public void	addExplorerTypeSetting(CmsExplorerTypeSettings settings)
public void	addExplorerTypeSettings(CmsModule module)
public void	addExportPoint(String uri, String destination)
public void	addLabeledFolder(String uri)
public void	addLocalizedFolder(String uri)
public void	addMenuRule(CmsMenuRule menuRule)
public void	addPreEditorConditionDefinition(String resourceTypeName, String preEditorConditionDefinitionClassName)
public boolean	autoLockResources()
public void	cmsEvent(CmsEvent event)
public String	createTempFile(CmsObject cms, String resourceName, CmsUUID currentProjectId)
public CmsWorkplaceCustomFoot	getCustomFoot()
public CmsExplorerTypeAccess	getDefaultAccess()
public Locale	getDefaultLocale()
public CmsDefaultUserSettings	getDefaultUserSettings()
public Map	getDialogHandler()
public Object	getDialogHandler(String key)
public I_CmsDirectEditProvider	getDirectEditProvider()
public I_CmsEditorActionHandler	getEditorActionHandler()
public List	getEditorCssHandlers()
public CmsEditorDisplayOptions	getEditorDisplayOptions()
public I_CmsEditorHandler	getEditorHandler()
public String	getEncoding()
public CmsExplorerTypeSettings	getExplorerTypeSetting(String type)
public List	getExplorerTypeSettings()
public Set	getExportPoints()
public long	getFileBytesMaxUploadSize(CmsObject cms)
public int	getFileMaxUploadSize()
public CmsRfsFileViewer	getFileViewSettings()
public Map	getGalleries()
public CmsI18nInfo	getI18nInfo(HttpServletRequest req, CmsUser user, CmsProject project, String resource)
public List	getLabelSiteFolders()
public List	getLocales()
public List	getLocalizedFolders()
public CmsMenuRule	getMenuRule(String ruleName)
public List	getMenuRules()
public Map	getMenuRulesMap()
public CmsWorkplaceMessages	getMessages(Locale locale) Returns the CmsWorkplaceMessages for the given locale. The workplace messages are a collection of resource bundles, containing the messages for all OpenCms core bundles and of all initialized modules. Please note that the message objects are cached internally.
public CmsExplorerContextMenu	getMultiContextMenu()
public I_CmsPreEditorActionDefinition	getPreEditorConditionDefinition(I_CmsResourceType resourceType)
public List	getPreEditorConditionDefinitions()
public CmsUUID	getTempFileProjectId()
public CmsToolManager	getToolManager()
public CmsWorkplaceUserInfoManager	getUserInfoManager()
public List	getViews()
public CmsWorkplaceEditorManager	getWorkplaceEditorManager()
public void	initHandler(CmsObject cms)
public synchronized void	initialize(CmsObject cms)
public boolean	isDefaultPropertiesOnStructure()
public boolean	isEnableAdvancedPropertyTabs()
public static boolean	isWorkplaceUser(HttpServletRequest req)
public boolean	isXmlContentAutoCorrect()
public void	removeExplorerTypeSettings(CmsModule module)
public void	setAutoLock(String value)
public void	setCustomFoot(CmsWorkplaceCustomFoot footCustom)
public void	setDefaultAccess(CmsExplorerTypeAccess access)
public void	setDefaultLocale(String locale)
public void	setDefaultPropertiesOnStructure(String defaultPropertiesOnStructure)
public void	setDefaultUserSettings(CmsDefaultUserSettings defaultUserSettings)
public void	setDirectEditProvider(I_CmsDirectEditProvider clazz)
public void	setEditorAction(I_CmsEditorActionHandler clazz)
public void	setEditorDisplayOptions(CmsEditorDisplayOptions clazz)
public void	setEditorHandler(I_CmsEditorHandler clazz)
public void	setEnableAdvancedPropertyTabs(String enableAdvancedPropertyTabs)
public void	setFileMaxUploadSize(String value)
public void	setFileViewSettings(CmsObject cms, CmsRfsFileViewer fileViewSettings) Sets the system-wide file view settings for the workplace. Parameters: cms - the CmsObject for ensuring security constraints.
public void	setMultiContextMenu(CmsExplorerContextMenu multiContextMenu)
public void	setToolManager(CmsToolManager toolManager)
public void	setUserInfoManager(CmsWorkplaceUserInfoManager userInfoManager)
public void	setUserManagementEnabled(String value)
public void	setXmlContentAutoCorrect(String xmlContentAutoCorrect)
public boolean	showUserGroupIcon()

Field Detail

DEFAULT_WORKPLACE_ENCODING
final public static String DEFAULT_WORKPLACE_ENCODING(Code)
	The default encoding for the workplace (UTF-8).

PARAM_LOGIN_REQUESTED_RESOURCE
final public static String PARAM_LOGIN_REQUESTED_RESOURCE(Code)
	The id of the "requestedResource" parameter for the OpenCms login form.

SESSION_WORKPLACE_SETTINGS
final public static String SESSION_WORKPLACE_SETTINGS(Code)
	Key name for the session workplace settings.

Constructor Detail

CmsWorkplaceManager
public CmsWorkplaceManager()(Code)
	Creates a new instance for the workplace manager, will be called by the workplace configuration manager.

Method Detail

addDialogHandler
public void addDialogHandler(I_CmsDialogHandler clazz)(Code)
	Adds a dialog handler instance to the list of configured dialog handlers. Parameters: clazz - the instantiated dialog handler to add

addEditorCssHandler
public void addEditorCssHandler(String editorCssHandlerClassName)(Code)
	Adds an editor CSS handler class to the list of handlers. Parameters: editorCssHandlerClassName - full class name of the css handler class

addEditorCssHandlerToHead
public void addEditorCssHandlerToHead(String editorCssHandlerClassName)(Code)
	Adds an editor CSS handler class at the first position of the list of handlers. Parameters: editorCssHandlerClassName - full class name of the css handler class

addExplorerTypeSetting
public void addExplorerTypeSetting(CmsExplorerTypeSettings settings)(Code)
	Adds an explorer type setting object to the list of type settings. Parameters: settings - the explorer type settings

addExplorerTypeSettings
public void addExplorerTypeSettings(CmsModule module)(Code)
	Adds the list of explorer type settings from the given module. Parameters: module - the module witch contains the explorer type settings to add

addExportPoint
public void addExportPoint(String uri, String destination)(Code)
	Adds newly created export point to the workplace configuration. Parameters: uri - the export point uri Parameters: destination - the export point destination

addLabeledFolder
public void addLabeledFolder(String uri)(Code)
	Adds a folder to the list of labeled folders. Parameters: uri - the folder uri to add

addLocalizedFolder
public void addLocalizedFolder(String uri)(Code)
	Adds a new folder to the list of localized workplace folders. Parameters: uri - a new folder to add to the list of localized workplace folders

addMenuRule
public void addMenuRule(CmsMenuRule menuRule)(Code)
	Adds a menu rule set from the workplace configuration to the configured menu rules. Parameters: menuRule - the menu rule to add

addPreEditorConditionDefinition
public void addPreEditorConditionDefinition(String resourceTypeName, String preEditorConditionDefinitionClassName)(Code)
	Adds a condition definition class for a given resource type glass name that is triggered before opening the editor. Parameters: resourceTypeName - the name of the resource type Parameters: preEditorConditionDefinitionClassName - full class name of the condition definition class

autoLockResources
public boolean autoLockResources()(Code)
	Returns if the autolock resources feature is enabled. true if the autolock resources feature is enabled, otherwise false

cmsEvent
public void cmsEvent(CmsEvent event)(Code)
	Implements the event listener of this class. See Also: org.opencms.main.I_CmsEventListener.cmsEvent(org.opencms.main.CmsEvent)

createTempFile
public String createTempFile(CmsObject cms, String resourceName, CmsUUID currentProjectId) throws CmsException(Code)
	Creates a temporary file which is needed while working in an editor with preview option. Parameters: cms - the cms context Parameters: resourceName - the name of the resource to copy Parameters: currentProjectId - the id of the project to work with the file name of the temporary file throws: CmsException - if something goes wrong

getCustomFoot
public CmsWorkplaceCustomFoot getCustomFoot()(Code)
	Returns the customized workplace foot. the customized workplace foot

getDefaultAccess
public CmsExplorerTypeAccess getDefaultAccess()(Code)
	Gets the access object of the type settings. access object of the type settings

getDefaultLocale
public Locale getDefaultLocale()(Code)
	Returns the Workplace default locale. the Workplace default locale

getDefaultUserSettings
public CmsDefaultUserSettings getDefaultUserSettings()(Code)
	Returns the Workplace default user settings. the Workplace default user settings

getDialogHandler
public Map getDialogHandler()(Code)
	Returns all instantiated dialog handlers for the workplace. all instantiated dialog handlers for the workplace

getDialogHandler
public Object getDialogHandler(String key)(Code)
	Returns the instantiated dialog handler class for the key or null, if there is no mapping for the key. Parameters: key - the key whose associated value is to be returned the instantiated dialog handler class for the key

getDirectEditProvider
public I_CmsDirectEditProvider getDirectEditProvider()(Code)
	Returns a new instance of the configured direct edit provider. a new instance of the configured direct edit provider

getEditorActionHandler
public I_CmsEditorActionHandler getEditorActionHandler()(Code)
	Returns the instantiated editor action handler class. the instantiated editor action handler class

getEditorCssHandlers
public List getEditorCssHandlers()(Code)
	Returns the instantiated editor CSS handler classes. the instantiated editor CSS handler classes

getEditorDisplayOptions
public CmsEditorDisplayOptions getEditorDisplayOptions()(Code)
	Returns the instantiated editor display option class. the instantiated editor display option class

getEditorHandler
public I_CmsEditorHandler getEditorHandler()(Code)
	Returns the instantiated editor handler class. the instantiated editor handler class

getEncoding
public String getEncoding()(Code)
	Returns the configured workplace encoding. the configured workplace encoding

getExplorerTypeSetting
public CmsExplorerTypeSettings getExplorerTypeSetting(String type)(Code)
	Returns the explorer type settings for the specified resource type. Parameters: type - the resource type for which the settings are required the explorer type settings for the specified resource type

getExplorerTypeSettings

public List getExplorerTypeSettings()(Code)

Returns the list of explorer type settings.

These settings provide information for the new resource dialog and the context menu appearance.

the list of explorer type settings

getExportPoints
public Set getExportPoints()(Code)
	Returns the set of configured export points for the workplace. the set of configured export points for the workplace

getFileBytesMaxUploadSize
public long getFileBytesMaxUploadSize(CmsObject cms)(Code)
	Returns the value (in bytes) for the maximum file upload size of the current user. Parameters: cms - the initialized CmsObject the value (in bytes) for the maximum file upload size

getFileMaxUploadSize
public int getFileMaxUploadSize()(Code)
	Returns the value (in kb) for the maximum file upload size. the value (in kb) for the maximum file upload size

getFileViewSettings

public CmsRfsFileViewer getFileViewSettings()(Code)

Returns the system-wide file view settings for the workplace.

Note that this instance may not modified (invocation of setters) directly or a org.opencms.main.CmsRuntimeException will be thrown.

It has to be cloned first and then may be written back to the workplace settings using method CmsWorkplaceManager.setFileViewSettings(CmsObject,org.opencms.util.CmsRfsFileViewer) .

the system-wide file view settings for the workplace

getGalleries

public Map getGalleries()(Code)

Returns a collection of all available galleries.

The Map has the gallery type name as key and an instance of the gallery class (not completely initialized) as value.

a collection of all available galleries

getI18nInfo
public CmsI18nInfo getI18nInfo(HttpServletRequest req, CmsUser user, CmsProject project, String resource)(Code)
	See Also: org.opencms.i18n.I_CmsLocaleHandler.getI18nInfo(javax.servlet.http.HttpServletRequestorg.opencms.file.CmsUserorg.opencms.file.CmsProjectjava.lang.String)

getLabelSiteFolders
public List getLabelSiteFolders()(Code)
	Returns a list of site folders which generate labeled links. a list of site folders which generate labeled links

getLocales

public List getLocales()(Code)

Returns the list of available workplace locales, sorted ascending.

Please note: Be careful not to modify the returned Set as it is not a clone.

the set of available workplace locales

getLocalizedFolders
public List getLocalizedFolders()(Code)
	Returns the configured list of localized workplace folders. the configured list of localized workplace folders

getMenuRule

public CmsMenuRule getMenuRule(String ruleName)(Code)

Returns the menu rule set with the given name.

If no rule set with the specified name is found, null is returned.

Parameters:
ruleName - the name of the rule set to get the menu rule set with the given name

getMenuRules
public List getMenuRules()(Code)
	Returns the configured menu rule sets. the configured menu rule sets

getMenuRulesMap
public Map getMenuRulesMap()(Code)
	Returns the configured menu rule sets as Map. the configured menu rule sets as Map

getMessages

public CmsWorkplaceMessages getMessages(Locale locale)(Code)

Returns the CmsWorkplaceMessages for the given locale.

The workplace messages are a collection of resource bundles, containing the messages for all OpenCms core bundles and of all initialized modules.

Please note that the message objects are cached internally. The returned message object should therefore never be modified directly in any way.

Parameters:
locale - the locale to get the messages for the CmsWorkplaceMessages for the given locale

getMultiContextMenu
public CmsExplorerContextMenu getMultiContextMenu()(Code)
	Returns the configured multi context menu to use in the Explorer view. the configured multi context menu to use in the Explorer view

getPreEditorConditionDefinition
public I_CmsPreEditorActionDefinition getPreEditorConditionDefinition(I_CmsResourceType resourceType)(Code)
	Returns the condition definition for the given resource type that is triggered before opening the editor. Parameters: resourceType - the resource type the condition definition for the given resource type class name or null if none is found

getPreEditorConditionDefinitions
public List getPreEditorConditionDefinitions()(Code)
	Returns the condition definitions for the different resource types which are triggered before opening the editor. the condition definitions

getTempFileProjectId
public CmsUUID getTempFileProjectId()(Code)
	Returns the id of the temporary file project required by the editors. the id of the temporary file project required by the editors

getToolManager
public CmsToolManager getToolManager()(Code)
	Returns the tool manager. the tool manager

getUserInfoManager
public CmsWorkplaceUserInfoManager getUserInfoManager()(Code)
	Returns the user additional information configuration Manager. the user additional information configuration manager

getViews
public List getViews()(Code)
	Returns the map of configured workplace views. the map of configured workplace views

getWorkplaceEditorManager
public CmsWorkplaceEditorManager getWorkplaceEditorManager()(Code)
	Returns the instantiated workplace editor manager class. the instantiated workplace editor manager class

initHandler
public void initHandler(CmsObject cms)(Code)
	See Also: org.opencms.i18n.I_CmsLocaleHandler.initHandler(org.opencms.file.CmsObject)

initialize
public synchronized void initialize(CmsObject cms) throws CmsException, CmsRoleViolationException(Code)
	Initializes the workplace manager with the OpenCms system configuration. Parameters: cms - an OpenCms context object that must have been initialized with "Admin" permissions throws: CmsRoleViolationException - if the provided OpenCms user context does not have `CmsRole.WORKPLACE_MANAGER` role permissions throws: CmsException - if something goes wrong

isDefaultPropertiesOnStructure
public boolean isDefaultPropertiesOnStructure()(Code)
	Returns the default property editing mode on resources. the default property editing mode on resources

isEnableAdvancedPropertyTabs
public boolean isEnableAdvancedPropertyTabs()(Code)
	Returns if tabs in the advanced property dialog are enabled. `true` if tabs should be enabled, otherwise `false`

isWorkplaceUser
public static boolean isWorkplaceUser(HttpServletRequest req)(Code)
	Returns true if the provided request was done by a Workplace user. Parameters: req - the request to check true if the provided request was done by a Workplace user

isXmlContentAutoCorrect
public boolean isXmlContentAutoCorrect()(Code)
	Returns if XML content is automatically corrected when opened with the editor. `true` if XML content is automatically corrected when opened with the editor, otherwise `false`

removeExplorerTypeSettings
public void removeExplorerTypeSettings(CmsModule module)(Code)
	Removes the list of explorer type settings from the given module. Parameters: module - the module witch contains the explorer type settings to remove

setAutoLock
public void setAutoLock(String value)(Code)
	Sets if the autolock resources feature is enabled. Parameters: value - `"true"` if the autolock resources feature is enabled, otherwise false

setCustomFoot
public void setCustomFoot(CmsWorkplaceCustomFoot footCustom)(Code)
	Sets the customized workplace foot. Parameters: footCustom - the customized workplace foot

setDefaultAccess
public void setDefaultAccess(CmsExplorerTypeAccess access)(Code)
	Sets the access object of the type settings. Parameters: access - access object

setDefaultLocale
public void setDefaultLocale(String locale)(Code)
	Sets the Workplace default locale. Parameters: locale - the locale to set

setDefaultPropertiesOnStructure
public void setDefaultPropertiesOnStructure(String defaultPropertiesOnStructure)(Code)
	Sets the default property editing mode on resources. Parameters: defaultPropertiesOnStructure - the default property editing mode on resources

setDefaultUserSettings
public void setDefaultUserSettings(CmsDefaultUserSettings defaultUserSettings)(Code)
	Sets the Workplace default user settings. Parameters: defaultUserSettings - the user settings to set

setDirectEditProvider
public void setDirectEditProvider(I_CmsDirectEditProvider clazz)(Code)
	Sets the direct edit provider. Parameters: clazz - the direct edit provider to set

setEditorAction
public void setEditorAction(I_CmsEditorActionHandler clazz)(Code)
	Sets the editor action class. Parameters: clazz - the editor action class to set

setEditorDisplayOptions
public void setEditorDisplayOptions(CmsEditorDisplayOptions clazz)(Code)
	Sets the editor display option class. Parameters: clazz - the editor display option class to set

setEditorHandler
public void setEditorHandler(I_CmsEditorHandler clazz)(Code)
	Sets the editor handler class. Parameters: clazz - the editor handler class to set

setEnableAdvancedPropertyTabs
public void setEnableAdvancedPropertyTabs(String enableAdvancedPropertyTabs)(Code)
	Sets if tabs in the advanced property dialog are enabled. Parameters: enableAdvancedPropertyTabs - true if tabs should be enabled, otherwise false

setFileMaxUploadSize
public void setFileMaxUploadSize(String value)(Code)
	Sets the value (in kb) for the maximum file upload size. Parameters: value - the value (in kb) for the maximum file upload size

setFileViewSettings
public void setFileViewSettings(CmsObject cms, CmsRfsFileViewer fileViewSettings) throws CmsRoleViolationException(Code)
	Sets the system-wide file view settings for the workplace. Parameters: cms - the CmsObject for ensuring security constraints. Parameters: fileViewSettings - the system-wide file view settings for the workplace to set throws: CmsRoleViolationException - if the current user does not own the administrator role (CmsRole.ROOT_ADMIN)

setMultiContextMenu
public void setMultiContextMenu(CmsExplorerContextMenu multiContextMenu)(Code)
	Sets the configured multi context menu to use in the Explorer view. Parameters: multiContextMenu - the configured multi context menu to use in the Explorer view

setToolManager
public void setToolManager(CmsToolManager toolManager)(Code)
	Sets the tool Manager object. Parameters: toolManager - the tool Manager object to set

setUserInfoManager
public void setUserInfoManager(CmsWorkplaceUserInfoManager userInfoManager)(Code)
	Sets the user additional information configuration manager. Parameters: userInfoManager - the manager to set

setUserManagementEnabled
public void setUserManagementEnabled(String value)(Code)
	Controls if the user/group icon in the administration view should be shown. Parameters: value - `"true"` if the user/group icon in the administration view should be shown, otherwise false

setXmlContentAutoCorrect
public void setXmlContentAutoCorrect(String xmlContentAutoCorrect)(Code)
	Sets the auto correction of XML contents when they are opened with the editor. Parameters: xmlContentAutoCorrect - if "true", the content will be corrected without notification, otherwise a confirmation is needed

showUserGroupIcon
public boolean showUserGroupIcon()(Code)
	Returns if the user/group icon in the administration view should be shown. true if the user/group icon in the administration view should be shown, otherwise false

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.