Skip to content
OpenCms documentation
OpenCms documentation

Editor field description for Shared element settings

Predefined element settings which can be shared by multiple formatter configurations.
Setting
Optional - Can occur as often as necessary
An element setting definition.
Formatter key
(Text input)
Optional - Can occur as often as necessary
Key of a formatter for which this setting definition should be used.
Include name
(Text input)
Optional
The name that has to be used in a formatter configuration to include this setting definition.
Name
(Text input)
Optional
The name for this setting. The setting value can be accessed in the JSP using this name.
Alias
(Text input)
Optional
Displayed name
(Text input)
Optional
The name displayed in the element setting dialog for the content manager.
Description
(Text input)
Optional
The description should supply information about what this setting is used for, any which input values are allowed. The description is displayed in the element setting dialog for the content manager.
Visibility
(Select box)
Optional
Widget
(Combo box)
Optional
The widget to use to edit the setting.
Default
(Text input)
Optional
The default value.
Widget configuration
(Text input)
Optional
The widget configuration parameter(s).
Value translation
(Text input)
Optional
Validation rule
(Text input)
Optional
A regular expression used to validate the users input.
Validation type
(Select box)
Optional
Specifies if failing the regular expression test causes an error or a warning.
Error message
(Text input)
Optional
The error message to display when the validation fails.
Comment
(Text area)
Optional