|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.workplace.editors.CmsEditorDisplayOptions
public class CmsEditorDisplayOptions
Provides methods to determine the display options of a workplace editor for the current user.
On the editor JSP, do the following:
OpenCms.getWorkplaceManager().getEditorDisplayOptions()
.getDisplayOptions(CmsJspActionElement)
.showElement(key, Properties)
to determine if an element is shown./system/workplace/editors/configuration/
.Set navigation position property values on the configuration files and use the permission system to determine which groups and users should use which configuration file.
The configuration with the most enabled options should be the first in navigation, followed by configurations with less enabled options, because the first file readable for the current user will be used for configuration.
If no configuration file can be found for the current user, all display options will be disabled by default.
Field Summary | |
---|---|
static java.lang.String |
FOLDER_EDITORCONFIGURATION
The name of the configuration folder. |
static java.lang.String |
NO_MAPPING_FOR_USER
Mapping entry name that is used if no mapping is available for the user. |
static int |
SIZE_CONFIGURATIONFILES
Maximum size of the stored editor configurations. |
static int |
SIZE_USERENTRIES
Maximum size of the user editor configuration mappings. |
Constructor Summary | |
---|---|
CmsEditorDisplayOptions()
Constructor that initializes the editor display options for the workplace. |
Method Summary | |
---|---|
void |
clearCache()
Clears the cached user configuration data, casing a reload off all configurations. |
java.util.Properties |
getDisplayOptions(CmsJspActionElement jsp)
Reads the editor configuration file valid for the current user and caches the result in a Map. |
java.util.Properties |
getDisplayOptions(CmsObject cms)
Reads the editor configuration file valid for the current user and caches the result in a Map. |
boolean |
showElement(java.lang.String key,
java.util.Properties displayOptions)
Determines if the given element should be shown in the editor. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String FOLDER_EDITORCONFIGURATION
public static final java.lang.String NO_MAPPING_FOR_USER
public static final int SIZE_CONFIGURATIONFILES
public static final int SIZE_USERENTRIES
Constructor Detail |
---|
public CmsEditorDisplayOptions()
Method Detail |
---|
public void clearCache()
public java.util.Properties getDisplayOptions(CmsJspActionElement jsp)
The configuration settings of the found file are stored in a Map holding the loaded configuration with the configuration file name as key.
The configuration file name to use for the current user is stored in another Map with the user name as key.
jsp
- the JSP action element to access the VFS and current user information
public java.util.Properties getDisplayOptions(CmsObject cms)
The configuration settings of the found file are stored in a Map holding the loaded configuration with the configuration file name as key.
The configuration file name to use for the current user is stored in another Map with the user name as key.
cms
- the CmsObject to access the VFS and current user information
public boolean showElement(java.lang.String key, java.util.Properties displayOptions)
key
- the element key name which should be displayeddisplayOptions
- the display options for the current user
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |