Package org.opencms.widgets
Class CmsDisplayTypeSelectWidget
- java.lang.Object
-
- org.opencms.widgets.A_CmsWidget
-
- org.opencms.widgets.A_CmsSelectWidget
-
- org.opencms.widgets.CmsSelectWidget
-
- org.opencms.widgets.CmsDisplayTypeSelectWidget
-
- All Implemented Interfaces:
I_CmsADEWidget
,I_CmsWidget
public class CmsDisplayTypeSelectWidget extends CmsSelectWidget
Widget to select a type and formatter combination.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.opencms.widgets.A_CmsWidget
A_CmsWidget.CmsDummyWidgetDialog
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATTR_USE_CONFIG_FORMATTERS
Name of the sitemap attribute to control whether the old or new way of collecting formatter options should be used.static java.lang.String
MATCH_TYPES_KEY
The match display types key.-
Fields inherited from class org.opencms.widgets.A_CmsSelectWidget
CONFIGURATION_HEIGHT
-
Fields inherited from class org.opencms.widgets.A_CmsWidget
HELP_POSTFIX, LABEL_PREFIX
-
-
Constructor Summary
Constructors Constructor Description CmsDisplayTypeSelectWidget()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getConfiguration()
Returns the configuration string.java.lang.String
getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
Returns the configuration string for the ADE content editor widget.java.lang.String
getWidgetName()
Returns the class name of the widget.I_CmsWidget
newInstance()
Creates a duplicate of this widget instance.protected java.util.List<CmsSelectWidgetOption>
parseSelectOptions(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
Returns the list of configured select options, parsing the configuration String if required.void
setConfiguration(java.lang.String configuration)
Sets the configuration of this widget.-
Methods inherited from class org.opencms.widgets.CmsSelectWidget
getDialogWidget, getWidgetStringValue
-
Methods inherited from class org.opencms.widgets.A_CmsSelectWidget
addSelectOption, getCssResourceLinks, getDefaultDisplayType, getHeight, getInitCall, getJavaScriptResourceLinks, getResourcePath, getSelectedValue, getSelectedValues, getSelectOptions, isInternal, setSelectOptions
-
Methods inherited from class org.opencms.widgets.A_CmsWidget
equals, getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, hashCode, isCompactViewEnabled, setEditorValue
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.opencms.widgets.I_CmsWidget
getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpText, isCompactViewEnabled, setEditorValue
-
-
-
-
Field Detail
-
ATTR_USE_CONFIG_FORMATTERS
public static final java.lang.String ATTR_USE_CONFIG_FORMATTERS
Name of the sitemap attribute to control whether the old or new way of collecting formatter options should be used.- See Also:
- Constant Field Values
-
MATCH_TYPES_KEY
public static final java.lang.String MATCH_TYPES_KEY
The match display types key.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsDisplayTypeSelectWidget
public CmsDisplayTypeSelectWidget()
-
-
Method Detail
-
getConfiguration
public java.lang.String getConfiguration()
Description copied from class:A_CmsWidget
Returns the configuration string.- Specified by:
getConfiguration
in interfaceI_CmsWidget
- Overrides:
getConfiguration
in classA_CmsSelectWidget
- Returns:
- the configuration string
- See Also:
A_CmsSelectWidget.getConfiguration()
-
getConfiguration
public java.lang.String getConfiguration(CmsObject cms, A_CmsXmlContentValue schemaType, CmsMessages messages, CmsResource resource, java.util.Locale contentLocale)
Description copied from interface:I_CmsADEWidget
Returns the configuration string for the ADE content editor widget.- Specified by:
getConfiguration
in interfaceI_CmsADEWidget
- Overrides:
getConfiguration
in classA_CmsSelectWidget
- Parameters:
cms
- the OpenCms contextschemaType
- the schema typemessages
- the messagesresource
- the edited resourcecontentLocale
- the content locale- Returns:
- the configuration string
- See Also:
A_CmsSelectWidget.getConfiguration(org.opencms.file.CmsObject, org.opencms.xml.types.A_CmsXmlContentValue, org.opencms.i18n.CmsMessages, org.opencms.file.CmsResource, java.util.Locale)
-
getWidgetName
public java.lang.String getWidgetName()
Description copied from interface:I_CmsADEWidget
Returns the class name of the widget.- Specified by:
getWidgetName
in interfaceI_CmsADEWidget
- Overrides:
getWidgetName
in classCmsSelectWidget
- Returns:
- the class name
- See Also:
CmsSelectWidget.getWidgetName()
-
newInstance
public I_CmsWidget newInstance()
Description copied from interface:I_CmsWidget
Creates a duplicate of this widget instance.- Specified by:
newInstance
in interfaceI_CmsWidget
- Overrides:
newInstance
in classCmsSelectWidget
- Returns:
- a duplicate of this widget instance
- See Also:
CmsSelectWidget.newInstance()
-
setConfiguration
public void setConfiguration(java.lang.String configuration)
Description copied from interface:I_CmsWidget
Sets the configuration of this widget.This can be used to enable / disable certain widget features that should not always be available, or to pass specific initialization information to the widget. It depends on the widget implementation on how this information is used.
- Specified by:
setConfiguration
in interfaceI_CmsWidget
- Overrides:
setConfiguration
in classA_CmsSelectWidget
- Parameters:
configuration
- the configuration to set- See Also:
A_CmsSelectWidget.setConfiguration(java.lang.String)
-
parseSelectOptions
protected java.util.List<CmsSelectWidgetOption> parseSelectOptions(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
Description copied from class:A_CmsSelectWidget
Returns the list of configured select options, parsing the configuration String if required.The list elements are of type
. The configuration String is parsed only once and then stored internally.CmsSelectWidgetOption
- Overrides:
parseSelectOptions
in classA_CmsSelectWidget
- Parameters:
cms
- the current users OpenCms contextwidgetDialog
- the dialog of this widgetparam
- the widget parameter of this dialog- Returns:
- the list of select options
- See Also:
A_CmsSelectWidget.parseSelectOptions(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)
-
-