org.opencms.widgets
Class CmsCheckboxWidget

java.lang.Object
  org.opencms.widgets.A_CmsWidget
      org.opencms.widgets.CmsCheckboxWidget

All Implemented Interfaces:

I_CmsWidget

public class CmsCheckboxWidget
extends A_CmsWidget

Provides a standard HTML form checkbox widget, for use on a widget dialog.

Since:

6.0.0

Field Summary

static String

HIDDEN_SUFFIX Suffix for the hidden input that contains the original value.

Fields inherited from class org.opencms.widgets.A_CmsWidget

HELP_POSTFIX, LABEL_PREFIX

Constructor Summary

CmsCheckboxWidget()
Creates a new checkbox widget.

CmsCheckboxWidget(String configuration)
Creates a new checkbox widget with the given configuration.

Method Summary

String	getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Generates the widget HTML for the provided widget parameter.
I_CmsWidget	newInstance() Creates a duplicate of this widget instance.
void	setEditorValue(CmsObject cms, Map<String,String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) Sets the value of in the given widget parameter by reading the "right" value from the offered map of parameters.

Methods inherited from class org.opencms.widgets.A_CmsWidget

equals, getConfiguration, getDialogHtmlEnd, getDialogIncludes, getDialogInitCall, getDialogInitMethod, getHelpBubble, getHelpKey, getHelpText, getJsHelpMouseHandler, getJSIncludeFile, getLabelKey, getWidgetStringValue, hashCode, setConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

HIDDEN_SUFFIX

public static final String HIDDEN_SUFFIX

Suffix for the hidden input that contains the original value.

See Also:

Constant Field Values

Constructor Detail

CmsCheckboxWidget

public CmsCheckboxWidget()

Creates a new checkbox widget.

CmsCheckboxWidget

public CmsCheckboxWidget(String configuration)

Creates a new checkbox widget with the given configuration.

Parameters:

configuration - the configuration to use

Method Detail

getDialogWidget

public 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 CmsObject

widgetDialog - the dialog where the widget is used on

param - 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)

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()

setEditorValue

public void setEditorValue(CmsObject cms,
                           Map<String,String[]> formParameters,
                           I_CmsWidgetDialog widgetDialog,
                           I_CmsWidgetParameter param)

Description copied from interface: I_CmsWidget

Sets the value of in the given widget parameter by reading the "right" value from the offered map of parameters.

Specified by:

setEditorValue in interface I_CmsWidget

Overrides:

setEditorValue in class A_CmsWidget

Parameters:

cms - the current users OpenCms context

formParameters - the map of parameters to get the value from

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

See Also:

I_CmsWidget.setEditorValue(org.opencms.file.CmsObject, java.util.Map, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)