CmsWorkplaceManager

java.lang.Object
- org.opencms.workplace.CmsWorkplaceManager

所有已实现的接口:

I_CmsLocaleHandler, I_CmsEventListener
```
public final class CmsWorkplaceManager
extends java.lang.Object
implements I_CmsLocaleHandler, I_CmsEventListener
```
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.

从以下版本开始:

6.0.0

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`DEFAULT_WORKPLACE_ENCODING` The default encoding for the workplace (UTF-8).
`static java.lang.String`	`PARAM_LOGIN_REQUESTED_RESOURCE` The id of the "requestedResource" parameter for the OpenCms login form.
`static java.lang.String`	`SESSION_WORKPLACE_SETTINGS` Key name for the session workplace settings.

从接口继承的字段 org.opencms.main.I_CmsEventListener
EVENT_BEFORE_PUBLISH_PROJECT, EVENT_CLEAR_CACHES, EVENT_CLEAR_OFFLINE_CACHES, EVENT_CLEAR_ONLINE_CACHES, EVENT_CLEAR_PRINCIPAL_CACHES, EVENT_FLEX_CACHE_CLEAR, EVENT_FLEX_PURGE_JSP_REPOSITORY, EVENT_FULLSTATIC_EXPORT, EVENT_GROUP_MODIFIED, EVENT_LOGIN_USER, EVENT_OU_MODIFIED, EVENT_PROJECT_MODIFIED, EVENT_PROPERTY_DEFINITION_CREATED, EVENT_PROPERTY_DEFINITION_MODIFIED, EVENT_PROPERTY_MODIFIED, EVENT_PUBLISH_PROJECT, EVENT_REBUILD_SEARCHINDEXES, EVENT_RESOURCE_AND_PROPERTIES_MODIFIED, EVENT_RESOURCE_COPIED, EVENT_RESOURCE_CREATED, EVENT_RESOURCE_DELETED, EVENT_RESOURCE_MODIFIED, EVENT_RESOURCE_MOVED, EVENT_RESOURCES_AND_PROPERTIES_MODIFIED, EVENT_RESOURCES_MODIFIED, EVENT_SITEMAP_CHANGED, EVENT_UPDATE_EXPORTS, EVENT_USER_MODIFIED, KEY_CHANGE, KEY_DBCONTEXT, KEY_GROUP_ID, KEY_GROUP_NAME, KEY_INDEX_NAMES, KEY_OU_ID, KEY_OU_NAME, KEY_PROJECTID, KEY_PUBLISHID, KEY_PUBLISHLIST, KEY_REPORT, KEY_RESOURCE, KEY_RESOURCES, KEY_USER_ACTION, KEY_USER_ID, KEY_USER_NAME, LISTENERS_FOR_ALL_EVENTS, VALUE_GROUP_MODIFIED_ACTION_CREATE, VALUE_GROUP_MODIFIED_ACTION_DELETE, VALUE_GROUP_MODIFIED_ACTION_WRITE, VALUE_OU_MODIFIED_ACTION_CREATE, VALUE_OU_MODIFIED_ACTION_DELETE, VALUE_USER_MODIFIED_ACTION_ADD_USER_TO_GROUP, VALUE_USER_MODIFIED_ACTION_CREATE_USER, VALUE_USER_MODIFIED_ACTION_DELETE_USER, VALUE_USER_MODIFIED_ACTION_REMOVE_USER_FROM_GROUP, VALUE_USER_MODIFIED_ACTION_RESET_PASSWORD, VALUE_USER_MODIFIED_ACTION_SET_OU, VALUE_USER_MODIFIED_ACTION_WRITE_USER

构造器概要

构造器
构造器和说明

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

构造器
构造器和说明
`CmsWorkplaceManager()` Creates a new instance for the workplace manager, will be called by the workplace configuration manager.

方法概要

方法
限定符和类型	方法和说明
`void`	`addDialogHandler(I_CmsDialogHandler clazz)` Adds a dialog handler instance to the list of configured dialog handlers.
`void`	`addEditorCssHandler(java.lang.String editorCssHandlerClassName)` Adds an editor CSS handler class to the list of handlers.
`void`	`addEditorCssHandlerToHead(java.lang.String editorCssHandlerClassName)` Adds an editor CSS handler class at the first position of the list of handlers.
`void`	`addExplorerTypeSetting(CmsExplorerTypeSettings settings)` Adds an explorer type setting object to the list of type settings.
`void`	`addExplorerTypeSettings(CmsModule module)` Adds the list of explorer type settings from the given module.
`void`	`addExportPoint(java.lang.String uri, java.lang.String destination)` Adds newly created export point to the workplace configuration.
`void`	`addLabeledFolder(java.lang.String uri)` Adds a folder to the list of labeled folders.
`void`	`addLocalizedFolder(java.lang.String uri)` Adds a new folder to the list of localized workplace folders.
`void`	`addMenuRule(CmsMenuRule menuRule)` Adds a menu rule set from the workplace configuration to the configured menu rules.
`void`	`addPreEditorConditionDefinition(I_CmsPreEditorActionDefinition preEditorCondition)` Adds an initialized condition definition class that is triggered before opening the editor.
`void`	`addPreEditorConditionDefinition(java.lang.String resourceTypeName, java.lang.String preEditorConditionDefinitionClassName)` Adds a condition definition class for a given resource type name that is triggered before opening the editor.
`void`	`addSynchronizeExcludePattern(java.lang.String pattern)` Adds a pattern to be excluded in VFS synchronization.
`boolean`	`autoLockResources()` Returns if the autolock resources feature is enabled.
`void`	`cmsEvent(CmsEvent event)` Implements the event listener of this class.
`java.lang.String`	`createTempFile(CmsObject cms, java.lang.String resourceName, CmsUUID currentProjectId)` Creates a temporary file which is needed while working in an editor with preview option.
`void`	`flushMessageCache()` Flushes the cached workplace messages.
`java.lang.String`	`getAcaciaUnlock()` Gets the value of the acacia-unlock configuration option (null if not set explicitly).
`java.lang.String`	`getCategoryFolder()` Returns the name of the local category folder(s).
`CmsWorkplaceCustomFoot`	`getCustomFoot()` Returns the customized workplace foot.
`CmsExplorerTypeAccess`	`getDefaultAccess()` Gets the access object of the type settings.
`java.util.Locale`	`getDefaultLocale()` Returns the Workplace default locale.
`CmsDefaultUserSettings`	`getDefaultUserSettings()` Returns the Workplace default user settings.
`java.util.Map<java.lang.String,I_CmsDialogHandler>`	`getDialogHandler()` Returns all instantiated dialog handlers for the workplace.
`I_CmsDialogHandler`	`getDialogHandler(java.lang.String key)` Returns the instantiated dialog handler class for the key or null, if there is no mapping for the key.
`I_CmsDirectEditProvider`	`getDirectEditProvider()` Returns a new instance of the configured direct edit provider.
`I_CmsEditorActionHandler`	`getEditorActionHandler()` Returns the instantiated editor action handler class.
`java.util.List<I_CmsEditorCssHandler>`	`getEditorCssHandlers()` Returns the instantiated editor CSS handler classes.
`CmsEditorDisplayOptions`	`getEditorDisplayOptions()` Returns the instantiated editor display option class.
`I_CmsEditorHandler`	`getEditorHandler()` Returns the instantiated editor handler class.
`java.lang.String`	`getEncoding()` Returns the configured workplace encoding.
`CmsExplorerTypeSettings`	`getExplorerTypeSetting(java.lang.String type)` Returns the explorer type settings for the specified resource type.
`java.util.List<CmsExplorerTypeSettings>`	`getExplorerTypeSettings()` Returns the list of explorer type settings.
`java.util.Set<CmsExportPoint>`	`getExportPoints()` Returns the set of configured export points for the workplace.
`long`	`getFileBytesMaxUploadSize(CmsObject cms)` Returns the value (in bytes) for the maximum file upload size of the current user.
`int`	`getFileMaxUploadSize()` Returns the value (in kb) for the maximum file upload size.
`CmsRfsFileViewer`	`getFileViewSettings()` Returns the system-wide file view settings for the workplace.
`java.util.Map<java.lang.String,A_CmsAjaxGallery>`	`getGalleries()` Returns a collection of all available galleries.
`CmsGallerySearchScope`	`getGalleryDefaultScope()` Returns the gallery default scope.
`java.lang.String`	`getGalleryDefaultScopeString()` Gets the configured gallery default scope as a string.
`I_CmsGroupNameTranslation`	`getGroupNameTranslation()` Returns the object used for translating group names.
`java.lang.String`	`getGroupTranslationClass()` Returns the configured class name for translating group names.
`CmsI18nInfo`	`getI18nInfo(javax.servlet.http.HttpServletRequest req, CmsUser user, CmsProject project, java.lang.String resource)` Returns the i18n information to use in the request context.
`java.util.List<java.lang.String>`	`getLabelSiteFolders()` Returns a list of site folders which generate labeled links.
`java.util.List<java.util.Locale>`	`getLocales()` Returns the list of available workplace locales, sorted ascending.
`java.util.List<java.lang.String>`	`getLocalizedFolders()` Returns the configured list of localized workplace folders.
`CmsMenuRule`	`getMenuRule(java.lang.String ruleName)` Returns the menu rule set with the given name.
`java.util.List<CmsMenuRule>`	`getMenuRules()` Returns the configured menu rule sets.
`java.util.Map<java.lang.String,CmsMenuRule>`	`getMenuRulesMap()` Returns the configured menu rule sets as Map.
`CmsWorkplaceMessages`	`getMessages(java.util.Locale locale)` Returns the `CmsWorkplaceMessages` for the given locale.
`CmsExplorerContextMenu`	`getMultiContextMenu()` Returns the configured multi context menu to use in the Explorer view.
`I_CmsPreEditorActionDefinition`	`getPreEditorConditionDefinition(I_CmsResourceType resourceType)` Returns the condition definition for the given resource type that is triggered before opening the editor.
`java.util.List<I_CmsPreEditorActionDefinition>`	`getPreEditorConditionDefinitions()` Returns the condition definitions for the different resource types which are triggered before opening the editor.
`I_CmsRepositoryFolderHandler`	`getRepositoryFolderHandler()` Returns the repository folder handler.
`java.util.ArrayList<java.util.regex.Pattern>`	`getSynchronizeExcludePatterns()` Returns Regex patterns that should be excluded from synchronization.
`CmsUUID`	`getTempFileProjectId()` Returns the id of the temporary file project required by the editors.
`CmsToolManager`	`getToolManager()` Returns the tool manager.
`java.lang.String`	`getUploadHook(CmsObject cms, java.lang.String uploadFolder)` Gets the upload hook URI which should be opened for an upload to a given folder.
`CmsWorkplaceUserInfoManager`	`getUserInfoManager()` Returns the user additional information configuration Manager.
`java.lang.String`	`getUserListModeString()` Returns the user list mode as a string.
`java.util.List<CmsWorkplaceView>`	`getViews()` Returns the map of configured workplace views.
`CmsWorkplaceEditorManager`	`getWorkplaceEditorManager()` Returns the instantiated workplace editor manager class.
`java.util.Locale`	`getWorkplaceLocale(CmsObject cms)` Returns the workplace locale from the current user's settings.
`void`	`initHandler(CmsObject cms)` Will be called during system startup.
`void`	`initialize(CmsObject cms)` Initializes the workplace manager with the OpenCms system configuration.
`boolean`	`isDefaultPropertiesOnStructure()` Returns the default property editing mode on resources.
`boolean`	`isEnableAdvancedPropertyTabs()` Returns if tabs in the advanced property dialog are enabled.
`boolean`	`isKeepAlive()` Returns true if "keep alive" mode is active.
`java.lang.Boolean`	`isKeepAlive(boolean useDefault)` Returns true if the session should be kept alive.
`static boolean`	`isWorkplaceUser(javax.servlet.http.HttpServletRequest req)` Returns true if the provided request was done by a Workplace user.
`boolean`	`isXmlContentAutoCorrect()` Returns if XML content is automatically corrected when opened with the editor.
`boolean`	`lazyUserListsEnabled()` Returns if lazy user lists are enabled.
`void`	`removeExplorerTypeSettings(CmsModule module)` Removes the list of explorer type settings from the given module.
`void`	`setAcaciaUnlock(java.lang.String value)` Sets the value of the acacia-unlock configuration option.
`void`	`setAutoLock(java.lang.String value)` Sets if the autolock resources feature is enabled.
`void`	`setCategoryFolder(java.lang.String categoryFolder)` Sets the name of the local category folder(s).
`void`	`setCustomFoot(CmsWorkplaceCustomFoot footCustom)` Sets the customized workplace foot.
`void`	`setDefaultAccess(CmsExplorerTypeAccess access)` Sets the access object of the type settings.
`void`	`setDefaultLocale(java.lang.String locale)` Sets the Workplace default locale.
`void`	`setDefaultPropertiesOnStructure(java.lang.String defaultPropertiesOnStructure)` Sets the default property editing mode on resources.
`void`	`setDefaultUserSettings(CmsDefaultUserSettings defaultUserSettings)` Sets the Workplace default user settings.
`void`	`setDirectEditProvider(I_CmsDirectEditProvider clazz)` Sets the direct edit provider.
`void`	`setEditorAction(I_CmsEditorActionHandler clazz)` Sets the editor action class.
`void`	`setEditorDisplayOptions(CmsEditorDisplayOptions clazz)` Sets the editor display option class.
`void`	`setEditorHandler(I_CmsEditorHandler clazz)` Sets the editor handler class.
`void`	`setEnableAdvancedPropertyTabs(java.lang.String enableAdvancedPropertyTabs)` Sets if tabs in the advanced property dialog are enabled.
`void`	`setFileMaxUploadSize(java.lang.String value)` Sets the value (in kb) for the maximum file upload size.
`void`	`setFileViewSettings(CmsObject cms, CmsRfsFileViewer fileViewSettings)` Sets the system-wide file view settings for the workplace.
`void`	`setGalleryDefaultScope(java.lang.String galleryDefaultScope)` Sets the gallery default scope.
`void`	`setGroupTranslationClass(java.lang.String translationClassName)` Sets the group translation class name.
`void`	`setKeepAlive(java.lang.String keepAlive)` Sets the "keep alive" mode.
`void`	`setMultiContextMenu(CmsExplorerContextMenu multiContextMenu)` Sets the configured multi context menu to use in the Explorer view.
`void`	`setRepositoryFolderHandler(I_CmsRepositoryFolderHandler clazz)` Sets the repository folder handler.
`void`	`setToolManager(CmsToolManager toolManager)` Sets the tool Manager object.
`void`	`setUserInfoManager(CmsWorkplaceUserInfoManager userInfoManager)` Sets the user additional information configuration manager.
`void`	`setUserListMode(java.lang.String mode)` Sets the user list mode.
`void`	`setUserManagementEnabled(java.lang.String value)` Controls if the user/group icon in the administration view should be shown.
`void`	`setXmlContentAutoCorrect(java.lang.String xmlContentAutoCorrect)` Sets the auto correction of XML contents when they are opened with the editor.
`boolean`	`shouldAcaciaUnlock()` Returns true if the Acacia editor in standalone mode should automatically unlock resources.
`boolean`	`showUserGroupIcon()` Returns if the user/group icon in the administration view should be shown.
`boolean`	`supportsLazyUserLists()` Returns true if lazy user lists should be used.
`java.lang.String`	`translateGroupName(java.lang.String groupName, boolean keepOu)` Translates a group name using the configured `I_CmsGroupNameTranslation`.

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

- 字段详细资料
  - DEFAULT_WORKPLACE_ENCODING
```
public static final java.lang.String DEFAULT_WORKPLACE_ENCODING
```
    The default encoding for the workplace (UTF-8).
    
    另请参阅:
    常量字段值
  - PARAM_LOGIN_REQUESTED_RESOURCE
```
public static final java.lang.String PARAM_LOGIN_REQUESTED_RESOURCE
```
    The id of the "requestedResource" parameter for the OpenCms login form.
    
    另请参阅:
    常量字段值
  - SESSION_WORKPLACE_SETTINGS
```
public static final java.lang.String SESSION_WORKPLACE_SETTINGS
```
    Key name for the session workplace settings.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - CmsWorkplaceManager
```
public CmsWorkplaceManager()
```
    Creates a new instance for the workplace manager, will be called by the workplace configuration manager.
- 方法详细资料
  - isWorkplaceUser
```
public static boolean isWorkplaceUser(javax.servlet.http.HttpServletRequest req)
```
    Returns true if the provided request was done by a Workplace user.
    
    参数:
    req - the request to check
    
    返回:
    true if the provided request was done by a Workplace user
  - addDialogHandler
```
public void addDialogHandler(I_CmsDialogHandler clazz)
```
    Adds a dialog handler instance to the list of configured dialog handlers.
    
    参数:
    clazz - the instantiated dialog handler to add
  - addEditorCssHandler
```
public void addEditorCssHandler(java.lang.String editorCssHandlerClassName)
```
    Adds an editor CSS handler class to the list of handlers.
    
    参数:
    editorCssHandlerClassName - full class name of the css handler class
  - addEditorCssHandlerToHead
```
public void addEditorCssHandlerToHead(java.lang.String editorCssHandlerClassName)
```
    Adds an editor CSS handler class at the first position of the list of handlers.
    
    参数:
    editorCssHandlerClassName - full class name of the css handler class
  - addExplorerTypeSetting
```
public void addExplorerTypeSetting(CmsExplorerTypeSettings settings)
```
    Adds an explorer type setting object to the list of type settings.
    
    参数:
    settings - the explorer type settings
  - addExplorerTypeSettings
```
public void addExplorerTypeSettings(CmsModule module)
```
    Adds the list of explorer type settings from the given module.
    
    参数:
    module - the module witch contains the explorer type settings to add
  - addExportPoint
```
public void addExportPoint(java.lang.String uri,
                  java.lang.String destination)
```
    Adds newly created export point to the workplace configuration.
    
    参数:
    uri - the export point uri
    destination - the export point destination
  - addLabeledFolder
```
public void addLabeledFolder(java.lang.String uri)
```
    Adds a folder to the list of labeled folders.
    
    参数:
    uri - the folder uri to add
  - addLocalizedFolder
```
public void addLocalizedFolder(java.lang.String uri)
```
    Adds a new folder to the list of localized workplace folders.
    
    参数:
    uri - a new folder to add to the list of localized workplace folders
  - addMenuRule
```
public void addMenuRule(CmsMenuRule menuRule)
```
    Adds a menu rule set from the workplace configuration to the configured menu rules.
    
    参数:
    menuRule - the menu rule to add
  - addPreEditorConditionDefinition
```
public void addPreEditorConditionDefinition(I_CmsPreEditorActionDefinition preEditorCondition)
```
    Adds an initialized condition definition class that is triggered before opening the editor.
    
    参数:
    preEditorCondition - the initialized condition definition class
  - addPreEditorConditionDefinition
```
public void addPreEditorConditionDefinition(java.lang.String resourceTypeName,
                                   java.lang.String preEditorConditionDefinitionClassName)
```
    Adds a condition definition class for a given resource type name that is triggered before opening the editor.
    
    参数:
    resourceTypeName - the name of the resource type
    preEditorConditionDefinitionClassName - full class name of the condition definition class
  - addSynchronizeExcludePattern
```
public void addSynchronizeExcludePattern(java.lang.String pattern)
```
    Adds a pattern to be excluded in VFS synchronization.
    
    参数:
    pattern - a java regex to applied on the file name
  - autoLockResources
```
public boolean autoLockResources()
```
    Returns if the autolock resources feature is enabled.
    
    返回:
    true if the autolock resources feature is enabled, otherwise false
  - cmsEvent
```
public void cmsEvent(CmsEvent event)
```
    Implements the event listener of this class.
    
    指定者:
    
    cmsEvent 在接口中 I_CmsEventListener
    
    参数:
    event - CmsEvent that has occurred
    另请参阅:
    I_CmsEventListener.cmsEvent(org.opencms.main.CmsEvent)
  - createTempFile
```
public java.lang.String createTempFile(CmsObject cms,
                              java.lang.String resourceName,
                              CmsUUID currentProjectId)
                                throws CmsException
```
    Creates a temporary file which is needed while working in an editor with preview option.
    Note: This method is synchronized to avoid rare issues that might be caused by double requests fired by some browser/OS combinations.
    
    参数:
    cms - the cms context
    resourceName - the name of the resource to copy
    currentProjectId - the id of the project to work with
    
    返回:
    the file name of the temporary file
    
    抛出:
    
    CmsException - if something goes wrong
  - flushMessageCache
```
public void flushMessageCache()
```
    Flushes the cached workplace messages.
  - getAcaciaUnlock
```
public java.lang.String getAcaciaUnlock()
```
    Gets the value of the acacia-unlock configuration option (null if not set explicitly).
    
    返回:
    the value of the acacia-unlock configuration option
  - getCategoryFolder
```
public java.lang.String getCategoryFolder()
```
    Returns the name of the local category folder(s).
    
    返回:
    the name of the local category folder(s)
  - getCustomFoot
```
public CmsWorkplaceCustomFoot getCustomFoot()
```
    Returns the customized workplace foot.
    
    返回:
    the customized workplace foot
  - getDefaultAccess
```
public CmsExplorerTypeAccess getDefaultAccess()
```
    Gets the access object of the type settings.
    
    返回:
    access object of the type settings
  - getDefaultLocale
```
public java.util.Locale getDefaultLocale()
```
    Returns the Workplace default locale.
    
    返回:
    the Workplace default locale
  - getDefaultUserSettings
```
public CmsDefaultUserSettings getDefaultUserSettings()
```
    Returns the Workplace default user settings.
    
    返回:
    the Workplace default user settings
  - getDialogHandler
```
public java.util.Map<java.lang.String,I_CmsDialogHandler> getDialogHandler()
```
    Returns all instantiated dialog handlers for the workplace.
    
    返回:
    all instantiated dialog handlers for the workplace
  - getDialogHandler
```
public I_CmsDialogHandler getDialogHandler(java.lang.String key)
```
    Returns the instantiated dialog handler class for the key or null, if there is no mapping for the key.
    
    参数:
    key - the key whose associated value is to be returned
    
    返回:
    the instantiated dialog handler class for the key
  - getDirectEditProvider
```
public I_CmsDirectEditProvider getDirectEditProvider()
```
    Returns a new instance of the configured direct edit provider.
    
    返回:
    a new instance of the configured direct edit provider
  - getEditorActionHandler
```
public I_CmsEditorActionHandler getEditorActionHandler()
```
    Returns the instantiated editor action handler class.
    
    返回:
    the instantiated editor action handler class
  - getEditorCssHandlers
```
public java.util.List<I_CmsEditorCssHandler> getEditorCssHandlers()
```
    Returns the instantiated editor CSS handler classes.
    
    返回:
    the instantiated editor CSS handler classes
  - getEditorDisplayOptions
```
public CmsEditorDisplayOptions getEditorDisplayOptions()
```
    Returns the instantiated editor display option class.
    
    返回:
    the instantiated editor display option class
  - getEditorHandler
```
public I_CmsEditorHandler getEditorHandler()
```
    Returns the instantiated editor handler class.
    
    返回:
    the instantiated editor handler class
  - getEncoding
```
public java.lang.String getEncoding()
```
    Returns the configured workplace encoding.
    
    返回:
    the configured workplace encoding
  - getExplorerTypeSetting
```
public CmsExplorerTypeSettings getExplorerTypeSetting(java.lang.String type)
```
    Returns the explorer type settings for the specified resource type.
    
    参数:
    type - the resource type for which the settings are required
    
    返回:
    the explorer type settings for the specified resource type
  - getExplorerTypeSettings
```
public java.util.List<CmsExplorerTypeSettings> getExplorerTypeSettings()
```
    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 java.util.Set<CmsExportPoint> getExportPoints()
```
    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)
```
    Returns the value (in bytes) for the maximum file upload size of the current user.
    
    参数:
    cms - the initialized CmsObject
    
    返回:
    the value (in bytes) for the maximum file upload size
  - getFileMaxUploadSize
```
public int getFileMaxUploadSize()
```
    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()
```
    Returns the system-wide file view settings for the workplace.
    Note that this instance may not modified (invocation of setters) directly or a CmsRuntimeException will be thrown.
    It has to be cloned first and then may be written back to the workplace settings using method setFileViewSettings(CmsObject, org.opencms.util.CmsRfsFileViewer).
    
    返回:
    the system-wide file view settings for the workplace
  - getGalleries
```
public java.util.Map<java.lang.String,A_CmsAjaxGallery> getGalleries()
```
    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
  - getGalleryDefaultScope
```
public CmsGallerySearchScope getGalleryDefaultScope()
```
    Returns the gallery default scope.
    
    返回:
    the gallery default scope
  - getGalleryDefaultScopeString
```
public java.lang.String getGalleryDefaultScopeString()
```
    Gets the configured gallery default scope as a string.
    
    返回:
    the gallery default scope as a string
  - getGroupNameTranslation
```
public I_CmsGroupNameTranslation getGroupNameTranslation()
```
    Returns the object used for translating group names.
    
    返回:
    the group name translator
  - getGroupTranslationClass
```
public java.lang.String getGroupTranslationClass()
```
    Returns the configured class name for translating group names.
    
    返回:
    the group translation class name
  - getI18nInfo
```
public CmsI18nInfo getI18nInfo(javax.servlet.http.HttpServletRequest req,
                      CmsUser user,
                      CmsProject project,
                      java.lang.String resource)
```
    从接口复制的说明: I_CmsLocaleHandler
    
    Returns the i18n information to use in the request context.
    
    指定者:
    
    getI18nInfo 在接口中 I_CmsLocaleHandler
    
    参数:
    req - the current http request
    user - the current user
    project - the current project
    resource - the URI of the requested resource (with full site root added)
    
    返回:
    the i18n information to use for the given request context
    另请参阅:
    I_CmsLocaleHandler.getI18nInfo(javax.servlet.http.HttpServletRequest, org.opencms.file.CmsUser, org.opencms.file.CmsProject, java.lang.String)
  - getLabelSiteFolders
```
public java.util.List<java.lang.String> getLabelSiteFolders()
```
    Returns a list of site folders which generate labeled links.
    
    返回:
    a list of site folders which generate labeled links
  - getLocales
```
public java.util.List<java.util.Locale> getLocales()
```
    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 java.util.List<java.lang.String> getLocalizedFolders()
```
    Returns the configured list of localized workplace folders.
    
    返回:
    the configured list of localized workplace folders
  - getMenuRule
```
public CmsMenuRule getMenuRule(java.lang.String ruleName)
```
    Returns the menu rule set with the given name.
    If no rule set with the specified name is found, null is returned.
    
    参数:
    ruleName - the name of the rule set to get
    
    返回:
    the menu rule set with the given name
  - getMenuRules
```
public java.util.List<CmsMenuRule> getMenuRules()
```
    Returns the configured menu rule sets.
    
    返回:
    the configured menu rule sets
  - getMenuRulesMap
```
public java.util.Map<java.lang.String,CmsMenuRule> getMenuRulesMap()
```
    Returns the configured menu rule sets as Map.
    
    返回:
    the configured menu rule sets as Map
  - getMessages
```
public CmsWorkplaceMessages getMessages(java.util.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. The returned message object should therefore never be modified directly in any way.
    
    参数:
    locale - the locale to get the messages for
    
    返回:
    the CmsWorkplaceMessages for the given locale
  - getMultiContextMenu
```
public CmsExplorerContextMenu getMultiContextMenu()
```
    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)
```
    Returns the condition definition for the given resource type that is triggered before opening the editor.
    
    参数:
    resourceType - the resource type
    
    返回:
    the condition definition for the given resource type class name or null if none is found
  - getPreEditorConditionDefinitions
```
public java.util.List<I_CmsPreEditorActionDefinition> getPreEditorConditionDefinitions()
```
    Returns the condition definitions for the different resource types which are triggered before opening the editor.
    
    返回:
    the condition definitions
  - getRepositoryFolderHandler
```
public I_CmsRepositoryFolderHandler getRepositoryFolderHandler()
```
    Returns the repository folder handler.
    
    返回:
    the repository folder handler
  - getSynchronizeExcludePatterns
```
public java.util.ArrayList<java.util.regex.Pattern> getSynchronizeExcludePatterns()
```
    Returns Regex patterns that should be excluded from synchronization.
    
    返回:
    the exclude patterns
  - getTempFileProjectId
```
public CmsUUID getTempFileProjectId()
```
    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()
```
    Returns the tool manager.
    
    返回:
    the tool manager
  - getUploadHook
```
public java.lang.String getUploadHook(CmsObject cms,
                             java.lang.String uploadFolder)
```
    Gets the upload hook URI which should be opened for an upload to a given folder.
    This method will return null if no upload hook should be used for the given upload folder.
    The API for this upload hook is as follows: The upload hook will be called with the following parameters: resources (required): a comma separated list of the structure ids of the uploaded resources if this is omitted closelink (optional): a link which should be opened once the upload hook has finished whatever it is doing
    
    参数:
    cms - the current CMS context
    uploadFolder - the folder for which the upload hook should be found
    
    返回:
    the URI of the upload hook or null
  - getUserInfoManager
```
public CmsWorkplaceUserInfoManager getUserInfoManager()
```
    Returns the user additional information configuration Manager.
    
    返回:
    the user additional information configuration manager
  - getUserListModeString
```
public java.lang.String getUserListModeString()
```
    Returns the user list mode as a string.
    
    返回:
    the user list mode as a string
  - getViews
```
public java.util.List<CmsWorkplaceView> getViews()
```
    Returns the map of configured workplace views.
    
    返回:
    the map of configured workplace views
  - getWorkplaceEditorManager
```
public CmsWorkplaceEditorManager getWorkplaceEditorManager()
```
    Returns the instantiated workplace editor manager class.
    
    返回:
    the instantiated workplace editor manager class
  - getWorkplaceLocale
```
public java.util.Locale getWorkplaceLocale(CmsObject cms)
```
    Returns the workplace locale from the current user's settings.
    
    参数:
    cms - the current cms object
    
    返回:
    the workplace locale
  - initHandler
```
public void initHandler(CmsObject cms)
```
    从接口复制的说明: I_CmsLocaleHandler
    
    Will be called during system startup.
    
    指定者:
    
    initHandler 在接口中 I_CmsLocaleHandler
    
    参数:
    cms - an initialized cms permission context for VFS access
    另请参阅:
    I_CmsLocaleHandler.initHandler(org.opencms.file.CmsObject)
  - initialize
```
public void initialize(CmsObject cms)
                throws CmsException,
                       CmsRoleViolationException
```
    Initializes the workplace manager with the OpenCms system configuration.
    
    参数:
    cms - an OpenCms context object that must have been initialized with "Admin" permissions
    
    抛出:
    
    CmsRoleViolationException - if the provided OpenCms user context does not have CmsRole.WORKPLACE_MANAGER role permissions
    
    CmsException - if something goes wrong
  - isDefaultPropertiesOnStructure
```
public boolean isDefaultPropertiesOnStructure()
```
    Returns the default property editing mode on resources.
    
    返回:
    the default property editing mode on resources
  - isEnableAdvancedPropertyTabs
```
public boolean isEnableAdvancedPropertyTabs()
```
    Returns if tabs in the advanced property dialog are enabled.
    
    返回:
    true if tabs should be enabled, otherwise false
  - isKeepAlive
```
public boolean isKeepAlive()
```
    Returns true if "keep alive" mode is active.
    
    返回:
    true if the session should be kept alive
  - isKeepAlive
```
public java.lang.Boolean isKeepAlive(boolean useDefault)
```
    Returns true if the session should be kept alive.
    
    参数:
    useDefault - if true, the default value will be returned if the "keep alive" setting is not explicitly configured
    
    返回:
    True if the "keep alive" mode is active
  - isXmlContentAutoCorrect
```
public boolean isXmlContentAutoCorrect()
```
    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
  - lazyUserListsEnabled
```
public boolean lazyUserListsEnabled()
```
    Returns if lazy user lists are enabled.
    
    返回:
    true if lazy user lists are enabled
  - removeExplorerTypeSettings
```
public void removeExplorerTypeSettings(CmsModule module)
```
    Removes the list of explorer type settings from the given module.
    
    参数:
    module - the module witch contains the explorer type settings to remove
  - setAcaciaUnlock
```
public void setAcaciaUnlock(java.lang.String value)
```
    Sets the value of the acacia-unlock configuration option.
    
    参数:
    value - the value of the acacia-unlock configuration option
  - setAutoLock
```
public void setAutoLock(java.lang.String value)
```
    Sets if the autolock resources feature is enabled.
    
    参数:
    value - "true" if the autolock resources feature is enabled, otherwise false
  - setCategoryFolder
```
public void setCategoryFolder(java.lang.String categoryFolder)
```
    Sets the name of the local category folder(s).
    
    参数:
    categoryFolder - the name of the local category folder(s)
  - setCustomFoot
```
public void setCustomFoot(CmsWorkplaceCustomFoot footCustom)
```
    Sets the customized workplace foot.
    
    参数:
    footCustom - the customized workplace foot
  - setDefaultAccess
```
public void setDefaultAccess(CmsExplorerTypeAccess access)
```
    Sets the access object of the type settings.
    
    参数:
    access - access object
  - setDefaultLocale
```
public void setDefaultLocale(java.lang.String locale)
```
    Sets the Workplace default locale.
    
    参数:
    locale - the locale to set
  - setDefaultPropertiesOnStructure
```
public void setDefaultPropertiesOnStructure(java.lang.String defaultPropertiesOnStructure)
```
    Sets the default property editing mode on resources.
    
    参数:
    defaultPropertiesOnStructure - the default property editing mode on resources
  - setDefaultUserSettings
```
public void setDefaultUserSettings(CmsDefaultUserSettings defaultUserSettings)
```
    Sets the Workplace default user settings.
    
    参数:
    defaultUserSettings - the user settings to set
  - setDirectEditProvider
```
public void setDirectEditProvider(I_CmsDirectEditProvider clazz)
```
    Sets the direct edit provider.
    
    参数:
    clazz - the direct edit provider to set
  - setEditorAction
```
public void setEditorAction(I_CmsEditorActionHandler clazz)
```
    Sets the editor action class.
    
    参数:
    clazz - the editor action class to set
  - setEditorDisplayOptions
```
public void setEditorDisplayOptions(CmsEditorDisplayOptions clazz)
```
    Sets the editor display option class.
    
    参数:
    clazz - the editor display option class to set
  - setEditorHandler
```
public void setEditorHandler(I_CmsEditorHandler clazz)
```
    Sets the editor handler class.
    
    参数:
    clazz - the editor handler class to set
  - setEnableAdvancedPropertyTabs
```
public void setEnableAdvancedPropertyTabs(java.lang.String enableAdvancedPropertyTabs)
```
    Sets if tabs in the advanced property dialog are enabled.
    
    参数:
    enableAdvancedPropertyTabs - true if tabs should be enabled, otherwise false
  - setFileMaxUploadSize
```
public void setFileMaxUploadSize(java.lang.String value)
```
    Sets the value (in kb) for the maximum file upload size.
    
    参数:
    value - the value (in kb) for the maximum file upload size
  - setFileViewSettings
```
public void setFileViewSettings(CmsObject cms,
                       CmsRfsFileViewer fileViewSettings)
                         throws CmsRoleViolationException
```
    Sets the system-wide file view settings for the workplace.
    
    参数:
    cms - the CmsObject for ensuring security constraints.
    fileViewSettings - the system-wide file view settings for the workplace to set
    
    抛出:
    
    CmsRoleViolationException - if the current user does not own the administrator role (CmsRole.ROOT_ADMIN)
  - setGalleryDefaultScope
```
public void setGalleryDefaultScope(java.lang.String galleryDefaultScope)
```
    Sets the gallery default scope.
    
    参数:
    galleryDefaultScope - the gallery default scope
  - setGroupTranslationClass
```
public void setGroupTranslationClass(java.lang.String translationClassName)
```
    Sets the group translation class name.
    
    参数:
    translationClassName - the group translation class name
  - setKeepAlive
```
public void setKeepAlive(java.lang.String keepAlive)
```
    Sets the "keep alive" mode.
    
    参数:
    keepAlive - the keep-alive mode
  - setMultiContextMenu
```
public void setMultiContextMenu(CmsExplorerContextMenu multiContextMenu)
```
    Sets the configured multi context menu to use in the Explorer view.
    
    参数:
    multiContextMenu - the configured multi context menu to use in the Explorer view
  - setRepositoryFolderHandler
```
public void setRepositoryFolderHandler(I_CmsRepositoryFolderHandler clazz)
```
    Sets the repository folder handler.
    
    参数:
    clazz - the repository folder handler
  - setToolManager
```
public void setToolManager(CmsToolManager toolManager)
```
    Sets the tool Manager object.
    
    参数:
    toolManager - the tool Manager object to set
  - setUserInfoManager
```
public void setUserInfoManager(CmsWorkplaceUserInfoManager userInfoManager)
```
    Sets the user additional information configuration manager.
    
    参数:
    userInfoManager - the manager to set
  - setUserListMode
```
public void setUserListMode(java.lang.String mode)
```
    Sets the user list mode.
    
    参数:
    mode - the user list mode
  - setUserManagementEnabled
```
public void setUserManagementEnabled(java.lang.String value)
```
    Controls if the user/group icon in the administration view should be shown.
    
    参数:
    value - "true" if the user/group icon in the administration view should be shown, otherwise false
  - setXmlContentAutoCorrect
```
public void setXmlContentAutoCorrect(java.lang.String xmlContentAutoCorrect)
```
    Sets the auto correction of XML contents when they are opened with the editor.
    
    参数:
    xmlContentAutoCorrect - if "true", the content will be corrected without notification, otherwise a confirmation is needed
  - shouldAcaciaUnlock
```
public boolean shouldAcaciaUnlock()
```
    Returns true if the Acacia editor in standalone mode should automatically unlock resources.
    
    返回:
    true if resources should be automatically unlocked in standalone mode
  - showUserGroupIcon
```
public boolean showUserGroupIcon()
```
    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
  - supportsLazyUserLists
```
public boolean supportsLazyUserLists()
```
    Returns true if lazy user lists should be used.
    
    返回:
    true if lazy user lists should be used
  - translateGroupName
```
public java.lang.String translateGroupName(java.lang.String groupName,
                                  boolean keepOu)
```
    Translates a group name using the configured I_CmsGroupNameTranslation.
    
    参数:
    groupName - the group name
    keepOu - if true, the OU will be appended to the translated name
    
    返回:
    the translated group name

类 CmsWorkplaceManager

字段概要

从接口继承的字段 org.opencms.main.I_CmsEventListener

构造器概要

方法概要

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

字段详细资料

DEFAULT_WORKPLACE_ENCODING

PARAM_LOGIN_REQUESTED_RESOURCE

SESSION_WORKPLACE_SETTINGS

构造器详细资料

CmsWorkplaceManager

方法详细资料

isWorkplaceUser

addDialogHandler

addEditorCssHandler

addEditorCssHandlerToHead

addExplorerTypeSetting

addExplorerTypeSettings

addExportPoint

addLabeledFolder

addLocalizedFolder

addMenuRule

addPreEditorConditionDefinition

addPreEditorConditionDefinition

addSynchronizeExcludePattern

autoLockResources

cmsEvent

createTempFile

flushMessageCache

getAcaciaUnlock

getCategoryFolder

getCustomFoot

getDefaultAccess

getDefaultLocale

getDefaultUserSettings

getDialogHandler

getDialogHandler

getDirectEditProvider

getEditorActionHandler

getEditorCssHandlers

getEditorDisplayOptions

getEditorHandler

getEncoding

getExplorerTypeSetting

getExplorerTypeSettings

getExportPoints

getFileBytesMaxUploadSize

getFileMaxUploadSize

getFileViewSettings

getGalleries

getGalleryDefaultScope

getGalleryDefaultScopeString

getGroupNameTranslation

getGroupTranslationClass

getI18nInfo

getLabelSiteFolders

getLocales

getLocalizedFolders

getMenuRule

getMenuRules

getMenuRulesMap

getMessages

getMultiContextMenu

getPreEditorConditionDefinition

getPreEditorConditionDefinitions

getRepositoryFolderHandler

getSynchronizeExcludePatterns

getTempFileProjectId

getToolManager

getUploadHook

getUserInfoManager

getUserListModeString

getViews

getWorkplaceEditorManager

getWorkplaceLocale

initHandler

initialize

isDefaultPropertiesOnStructure

isEnableAdvancedPropertyTabs