Package org.opencms.widgets
Class CmsComboWidget
- java.lang.Object
-
- org.opencms.widgets.A_CmsWidget
-
- org.opencms.widgets.A_CmsSelectWidget
-
- org.opencms.widgets.CmsComboWidget
-
- All Implemented Interfaces:
I_CmsADEWidget
,I_CmsWidget
- Direct Known Subclasses:
CmsSelectComboWidget
,CmsTypeComboWidget
public class CmsComboWidget extends A_CmsSelectWidget
Provides a HTML text input field with optional values to select in a combo box, for use on a widget dialog.Please see the documentation of
for a description about the configuration String syntax for the select options.CmsSelectWidgetOption
The combo widget does use the following select options:
for the texts to be displayed in the combo selectorCmsSelectWidgetOption.getValue()
to fill the input with a preselected textCmsSelectWidgetOption.isDefault()
to display an (optional) help text for the combo optionCmsSelectWidgetOption.getHelp()
- Since:
- 6.0.0
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.opencms.widgets.A_CmsWidget
A_CmsWidget.CmsDummyWidgetDialog
-
-
Field Summary
-
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 CmsComboWidget()
Creates a new combo widget.CmsComboWidget(java.lang.String configuration)
Creates a combo widget with the specified combo options.CmsComboWidget(java.util.List<CmsSelectWidgetOption> configuration)
Creates a combo widget with the select options specified in the given configuration List.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDialogHtmlEnd(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
Generates the html to include at the end of the dialog for this widget.java.lang.String
getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
Generates the necessary JavaScript inclusion code for this widget.java.lang.String
getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog)
Generates the initialisation method JavaScript code for this widget.java.lang.String
getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
Generates the widget HTML for the provided widget parameter.java.lang.String
getWidgetName()
Returns the class name of the widget.I_CmsWidget
newInstance()
Creates a duplicate of this widget instance.-
Methods inherited from class org.opencms.widgets.A_CmsSelectWidget
addSelectOption, getConfiguration, getConfiguration, getCssResourceLinks, getDefaultDisplayType, getHeight, getInitCall, getJavaScriptResourceLinks, getResourcePath, getSelectedValue, getSelectedValues, getSelectOptions, isInternal, parseSelectOptions, setConfiguration, setSelectOptions
-
Methods inherited from class org.opencms.widgets.A_CmsWidget
equals, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, getWidgetStringValue, 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
getDialogInitMethod, getHelpBubble, getHelpText, getWidgetStringValue, isCompactViewEnabled, setEditorValue
-
-
-
-
Constructor Detail
-
CmsComboWidget
public CmsComboWidget()
Creates a new combo widget.
-
CmsComboWidget
public CmsComboWidget(java.util.List<CmsSelectWidgetOption> configuration)
Creates a combo widget with the select options specified in the given configuration List.The list elements must be of type
.CmsSelectWidgetOption
- Parameters:
configuration
- the configuration (possible options) for the select widget- See Also:
CmsSelectWidgetOption
-
CmsComboWidget
public CmsComboWidget(java.lang.String configuration)
Creates a combo widget with the specified combo options.- Parameters:
configuration
- the configuration (possible options) for the combo box
-
-
Method Detail
-
getDialogHtmlEnd
public java.lang.String getDialogHtmlEnd(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
Description copied from interface:I_CmsWidget
Generates the html to include at the end of the dialog for this widget.The "help bubble" text div's are added using this method.
- Specified by:
getDialogHtmlEnd
in interfaceI_CmsWidget
- Overrides:
getDialogHtmlEnd
in classA_CmsWidget
- Parameters:
cms
- the current users OpenCms contextwidgetDialog
- the dialog where the widget is used onparam
- the widget parameter to generate the widget for- Returns:
- the html to include at the end of the dialog for this widget
- See Also:
A_CmsWidget.getDialogHtmlEnd(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)
-
getDialogIncludes
public java.lang.String getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
Description copied from interface:I_CmsWidget
Generates the necessary JavaScript inclusion code for this widget.- Specified by:
getDialogIncludes
in interfaceI_CmsWidget
- Overrides:
getDialogIncludes
in classA_CmsWidget
- Parameters:
cms
- the current users OpenCms contextwidgetDialog
- the dialog where the widget is used on- Returns:
- the JavaScript inclusion code
- See Also:
I_CmsWidget.getDialogIncludes(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)
-
getDialogInitCall
public java.lang.String getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog)
Description copied from interface:I_CmsWidget
Generates the initialisation method JavaScript code for this widget.- Specified by:
getDialogInitCall
in interfaceI_CmsWidget
- Overrides:
getDialogInitCall
in classA_CmsWidget
- Parameters:
cms
- the current users OpenCms contextwidgetDialog
- the dialog where the widget is used on- Returns:
- the initialisation method JavaScript code
- See Also:
I_CmsWidget.getDialogInitCall(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)
-
getDialogWidget
public java.lang.String getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
Description copied from interface:I_CmsWidget
Generates the widget HTML for the provided widget parameter.- Parameters:
cms
- an initialized instance of a CmsObjectwidgetDialog
- the dialog where the widget is used onparam
- the widget parameter to generate the widget for- Returns:
- the widget HTML for the provided widget parameter
- See Also:
I_CmsWidget.getDialogWidget(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)
-
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 classA_CmsSelectWidget
- Returns:
- the class name
- See Also:
A_CmsSelectWidget.getWidgetName()
-
newInstance
public I_CmsWidget newInstance()
Description copied from interface:I_CmsWidget
Creates a duplicate of this widget instance.- Returns:
- a duplicate of this widget instance
- See Also:
I_CmsWidget.newInstance()
-
-