org.opencms.widgets.CmsRadioSelectWidget 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.xml.content.I_CmsXmlContentHandler.DisplayType;
import java.util.Iterator;
import java.util.List;
/**
* Provides a widget for a standard HTML form for a group of radio buttons.
*
* 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.9.1
*/
public class CmsRadioSelectWidget extends A_CmsSelectWidget {
/**
* Creates a new select widget.
*/
public CmsRadioSelectWidget() {
// 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 CmsRadioSelectWidget(List configuration) {
super(configuration);
}
/**
* Creates a select widget with the specified select options.
*
* @param configuration the configuration (possible options) for the select box
*/
public CmsRadioSelectWidget(String configuration) {
super(configuration);
}
/**
* @see org.opencms.widgets.I_CmsADEWidget#getDefaultDisplayType()
*/
@Override
public DisplayType getDefaultDisplayType() {
return DisplayType.wide;
}
/**
* @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("
");
// get select box options from default value String
List options = parseSelectOptions(cms, widgetDialog, param);
String selected = getSelectedValue(cms, param);
Iterator i = options.iterator();
while (i.hasNext()) {
CmsSelectWidgetOption option = i.next();
// create the option
result.append("= 0) {
result.append(" checked");
}
result.append(">");
result.append(option.getOption());
result.append("
");
}
result.append(" ");
return result.toString();
}
/**
* @see org.opencms.widgets.I_CmsADEWidget#getWidgetName()
*/
@Override
public String getWidgetName() {
return CmsRadioSelectWidget.class.getName();
}
/**
* @see org.opencms.widgets.I_CmsWidget#newInstance()
*/
public I_CmsWidget newInstance() {
return new CmsRadioSelectWidget(getConfiguration());
}
}