org.opencms.widgets.CmsComboWidget 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.i18n.CmsEncoder;
import org.opencms.util.CmsStringUtil;
import org.opencms.workplace.CmsWorkplace;
import java.util.Iterator;
import java.util.List;
/**
* 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 {@link org.opencms.widgets.CmsSelectWidgetOption} for a description
* about the configuration String syntax for the select options.
*
* The combo widget does use the following select options:
* {@link org.opencms.widgets.CmsSelectWidgetOption#getValue()} for the texts to be displayed in the combo selector
* {@link org.opencms.widgets.CmsSelectWidgetOption#isDefault()} to fill the input with a preselected text
* {@link org.opencms.widgets.CmsSelectWidgetOption#getHelp()} to display an (optional) help text for the combo option
*
*
* @since 6.0.0
*/
public class CmsComboWidget extends A_CmsSelectWidget {
/**
* Creates a new combo widget.
*/
public CmsComboWidget() {
// empty constructor is required for class registration
super();
}
/**
* Creates a combo 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 CmsComboWidget(List configuration) {
super(configuration);
}
/**
* Creates a combo widget with the specified combo options.
*
* @param configuration the configuration (possible options) for the combo box
*/
public CmsComboWidget(String configuration) {
super(configuration);
}
/**
* @see org.opencms.widgets.A_CmsWidget#getDialogHtmlEnd(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter)
*/
@Override
public String getDialogHtmlEnd(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) {
String id = param.getId();
StringBuffer result = new StringBuffer(256);
// get the select box options
List options = parseSelectOptions(cms, widgetDialog, param);
if (options.size() > 0) {
// create combo div
result.append("\n");
if (widgetDialog.useNewStyle()) {
// create help texts for the values in admin view
count = 0;
i = options.iterator();
while (i.hasNext()) {
CmsSelectWidgetOption option = i.next();
if (option.getHelp() != null) {
// help text is optional
String itemId = new StringBuffer(64).append("ci").append(id).append('.').append(
count).toString();
result.append("");
result.append(option.getHelp());
result.append("\n");
count++;
}
}
}
}
// return the icon help text from super class
result.append(super.getDialogHtmlEnd(cms, widgetDialog, param));
return result.toString();
}
/**
* @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) {
StringBuffer result = new StringBuffer(16);
result.append(getJSIncludeFile(CmsWorkplace.getSkinUri() + "components/widgets/combobox.js"));
return result.toString();
}
/**
* @see org.opencms.widgets.I_CmsWidget#getDialogInitCall(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog)
*/
@Override
public String getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog) {
return "\tinitComboBox();\n";
}
/**
* @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);
result.append("");
result.append("");
// medium text input field
result.append("");
result.append(" ");
// button to open combo box
result.append("
");
result.append(" ");
return result.toString();
}
/**
* @see org.opencms.widgets.A_CmsSelectWidget#getWidgetName()
*/
@Override
public String getWidgetName() {
return CmsComboWidget.class.getName();
}
/**
* @see org.opencms.widgets.I_CmsWidget#newInstance()
*/
public I_CmsWidget newInstance() {
return new CmsComboWidget(getConfiguration());
}
}