All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.opencms.widgets.CmsSelectWidget Maven / Gradle / Ivy

Go to download

OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.

There is a newer version: 17.0
Show newest version
/*
 * 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.CmsMacroResolver;

import java.util.Iterator;
import java.util.List;

/**
 * Provides a widget for a standard HTML form select box.

* * Please see the documentation of {@link org.opencms.widgets.CmsSelectWidgetOption} for a description * about the configuration String syntax for the select options.

* * The select widget does use the following select options:

    *
  • {@link org.opencms.widgets.CmsSelectWidgetOption#getValue()} for the value of the HTML select box *
  • {@link org.opencms.widgets.CmsSelectWidgetOption#isDefault()} for pre-selecting a specific value *
  • {@link org.opencms.widgets.CmsSelectWidgetOption#getOption()} for the option of the HTML select box *
*

* * @since 6.0.0 */ public class CmsSelectWidget extends A_CmsSelectWidget { /** * Creates a new select widget.

*/ public CmsSelectWidget() { // 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 CmsSelectWidget(List configuration) { super(configuration); } /** * Creates a select widget with the specified select options.

* * @param configuration the configuration (possible options) for the select box */ public CmsSelectWidget(String configuration) { super(configuration); } /** * @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(""); return result.toString(); } /** * @see org.opencms.widgets.I_CmsADEWidget#getWidgetName() */ @Override public String getWidgetName() { return CmsSelectWidget.class.getName(); } /** * @see org.opencms.widgets.A_CmsWidget#getWidgetStringValue(org.opencms.file.CmsObject, org.opencms.widgets.I_CmsWidgetDialog, org.opencms.widgets.I_CmsWidgetParameter) */ @Override public String getWidgetStringValue(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param) { String result = super.getWidgetStringValue(cms, widgetDialog, param); String configuration = CmsMacroResolver.resolveMacros(getConfiguration(), cms, widgetDialog.getMessages()); if (configuration == null) { configuration = param.getDefault(cms); } List options = CmsSelectWidgetOption.parseOptions(configuration); for (int m = 0; m < options.size(); m++) { CmsSelectWidgetOption option = options.get(m); if (result.equals(option.getValue())) { result = option.getOption(); break; } } return result; } /** * @see org.opencms.widgets.I_CmsWidget#newInstance() */ public I_CmsWidget newInstance() { return new CmsSelectWidget(getConfiguration()); } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy