org.opencms.widgets.CmsMultiSelectWidget Maven / Gradle / Ivy
Show all versions of opencms-core Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.widgets;
import org.opencms.file.CmsObject;
import org.opencms.util.CmsStringUtil;
import org.opencms.workplace.CmsWorkplace;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
/**
* Provides a widget for a standard HTML form multi select list or a group of check boxes.
*
* Please see the documentation of {@link org.opencms.widgets.CmsSelectWidgetOption} for a description
* about the configuration String syntax for the select options.
*
* The multi select widget does use the following select options:
* {@link org.opencms.widgets.CmsSelectWidgetOption#getValue()} for the value of the option
* {@link org.opencms.widgets.CmsSelectWidgetOption#isDefault()} for pre-selecting a specific value
* {@link org.opencms.widgets.CmsSelectWidgetOption#getOption()} for the display name of the option
*
*
*
* @since 6.0.0
*/
public class CmsMultiSelectWidget extends A_CmsSelectWidget {
/** Configuration parameter to set the height from the select widget in pixel. */
public static final String CONFIGURATION_ASCHECKBOXES = "ascheckboxes";
/** Configuration parameter to indicate the multi-select needs to be activated by a check box. */
public static final String CONFIGURATION_REQUIRES_ACTIVATION = "requiresactivation";
/** Indicates if used html code is a multi selection list or a list of checkboxes. */
private boolean m_asCheckBoxes;
/** Flag to indicate if the multi-select needs to be activated by a check box. */
private boolean m_requiresActivation;
/**
* Creates a new select widget.
*/
public CmsMultiSelectWidget() {
// empty constructor is required for class registration
super();
}
/**
* Creates a select widget with the select options specified in the given configuration List.
*
* The list elements must be of type {@link CmsSelectWidgetOption}.
*
* @param configuration the configuration (possible options) for the select widget
*
* @see CmsSelectWidgetOption
*/
public CmsMultiSelectWidget(List configuration) {
this(configuration, false);
}
/**
* Creates a select widget with the select options specified in the given configuration List.
*
* The list elements must be of type {@link CmsSelectWidgetOption}.
*
* @param configuration the configuration (possible options) for the select widget
* @param asCheckboxes indicates if used html code is a multi selection list or a list of checkboxes
*
* @see CmsSelectWidgetOption
*/
public CmsMultiSelectWidget(List configuration, boolean asCheckboxes) {
super(configuration);
m_asCheckBoxes = asCheckboxes;
}
/**
* Creates a select widget with the specified select options.
*
* @param configuration the configuration (possible options) for the select box
*/
public CmsMultiSelectWidget(String configuration) {
super(configuration);
}
/**
* Sets the value of the widget parameter from the provided form parameters.
*
* @param cms the cms context
* @param formParameters the form parameters
* @param widgetDialog the widget dialog
* @param param the widget parameter
*/
public static void setMultiSelectEditorValue(
CmsObject cms,
Map formParameters,
I_CmsWidgetDialog widgetDialog,
I_CmsWidgetParameter param) {
String[] values = formParameters.get(param.getId());
if ((values != null) && (values.length > 0)) {
StringBuffer value = new StringBuffer(128);
for (int i = 0; i < values.length; i++) {
if (i > 0) {
value.append(',');
}
value.append(values[i]);
}
// set the value
param.setStringValue(cms, value.toString());
} else {
// erase:
param.setStringValue(cms, "");
}
}
/**
* @see org.opencms.widgets.I_CmsWidget#getDialogIncludes(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)
*/
@Override
public String getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog) {
return getJSIncludeFile(CmsWorkplace.getSkinUri() + "components/widgets/multiselector.js");
}
/**
* @see org.opencms.widgets.I_CmsWidget#getDialogWidget(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)
*/
public String getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) {
String id = param.getId();
StringBuffer result = new StringBuffer(16);
List options = parseSelectOptions(cms, widgetDialog, param);
result.append("");
// the configured select widget height start element
if (!m_asCheckBoxes) {
if (m_requiresActivation) {
result.append(
"");
result.append(" ");
// adding hidden input with the current value, because disabled select box value won't be submitted
result.append("");
id = "display" + id;
}
result.append("");
}
result.append(" ");
return result.toString();
}
/**
* @see org.opencms.widgets.I_CmsADEWidget#getWidgetName()
*/
@Override
public String getWidgetName() {
return CmsMultiSelectWidget.class.getName();
}
/**
* @see org.opencms.widgets.I_CmsWidget#newInstance()
*/
public I_CmsWidget newInstance() {
return new CmsMultiSelectWidget(getConfiguration());
}
/**
* @see org.opencms.widgets.A_CmsWidget#setConfiguration(java.lang.String)
*/
@Override
public void setConfiguration(String configuration) {
if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(configuration)) {
int asCheckBoxesIndex = configuration.indexOf(CONFIGURATION_ASCHECKBOXES);
if (asCheckBoxesIndex != -1) {
// the height is set
String asCheckBoxes = configuration.substring(
asCheckBoxesIndex + CONFIGURATION_ASCHECKBOXES.length() + 1);
if (asCheckBoxes.indexOf('|') != -1) {
// cut eventual following configuration values
asCheckBoxes = asCheckBoxes.substring(0, asCheckBoxes.indexOf('|'));
}
m_asCheckBoxes = Boolean.parseBoolean(asCheckBoxes);
}
int reqiresActivationIndex = configuration.indexOf(CONFIGURATION_REQUIRES_ACTIVATION);
if (reqiresActivationIndex != -1) {
// the height is set
String requiresActivation = configuration.substring(
reqiresActivationIndex + CONFIGURATION_REQUIRES_ACTIVATION.length() + 1);
if (requiresActivation.indexOf('|') != -1) {
// cut eventual following configuration values
requiresActivation = requiresActivation.substring(0, requiresActivation.indexOf('|'));
}
m_requiresActivation = Boolean.parseBoolean(requiresActivation);
}
}
super.setConfiguration(configuration);
}
/**
* @see org.opencms.widgets.I_CmsWidget#setEditorValue(org.opencms.file.CmsObject, java.util.Map, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)
*/
@Override
public void setEditorValue(
CmsObject cms,
Map formParameters,
I_CmsWidgetDialog widgetDialog,
I_CmsWidgetParameter param) {
setMultiSelectEditorValue(cms, formParameters, widgetDialog, param);
}
}