StaticListClass.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This 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 software 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.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package com.xpn.xwiki.objects.classes;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Map;

import org.apache.commons.lang3.StringUtils;
import org.apache.ecs.xhtml.input;

import com.xpn.xwiki.XWiki;
import com.xpn.xwiki.XWikiContext;
import com.xpn.xwiki.internal.xml.XMLAttributeValueFilter;
import com.xpn.xwiki.objects.BaseCollection;
import com.xpn.xwiki.objects.BaseProperty;
import com.xpn.xwiki.objects.meta.PropertyMetaClass;

public class StaticListClass extends ListClass
{
    private static final String XCLASSNAME = "staticlist";

    public StaticListClass(PropertyMetaClass wclass)
    {
        super(XCLASSNAME, "Static List", wclass);
        setSeparators("|, ");
    }

    public StaticListClass()
    {
        this(null);
    }

    public String getValues()
    {
        return getStringValue("values");
    }

    public void setValues(String values)
    {
        setStringValue("values", values);
    }

    @Override
    public List<String> getList(XWikiContext context)
    {
        String sort = getSort();
        if (StringUtils.isEmpty(sort) || "none".equals(sort)) {
            return getListFromString(getValues());
        }

        Map<String, ListItem> valuesMap = getMap(context);
        List<ListItem> values = new ArrayList<ListItem>(valuesMap.size());
        values.addAll(valuesMap.values());

        if ("id".equals(sort)) {
            Collections.sort(values, ListItem.ID_COMPARATOR);
        } else if ("value".equals(sort)) {
            Collections.sort(values, ListItem.VALUE_COMPARATOR);
        }

        List<String> result = new ArrayList<String>(values.size());
        for (ListItem value : values) {
            result.add(value.getId());
        }
        return result;
    }

    @Override
    public Map<String, ListItem> getMap(XWikiContext context)
    {
        String values = getValues();
        return getMapFromString(values);
    }

    @Override
    public void displayEdit(StringBuffer buffer, String name, String prefix, BaseCollection object, XWikiContext context)
    {
        if (getDisplayType().equals(DISPLAYTYPE_INPUT)) {
            input input = new input();
            input.setAttributeFilter(new XMLAttributeValueFilter());
            BaseProperty prop = (BaseProperty) object.safeget(name);
            if (prop != null) {
                input.setValue(this.toFormString(prop));
            }
            input.setType("text");
            input.setSize(getSize());
            input.setName(prefix + name);
            input.setID(prefix + name);
            input.setDisabled(isDisabled());

            if (isPicker()) {
                input.setClass("suggested");
                String path = "";
                XWiki xwiki = context.getWiki();
                path = xwiki.getURL("Main.WebHome", "view", context);

                String classname = this.getObject().getName();
                String fieldname = this.getName();
                String secondCol = "-", firstCol = "-";

                String script =
                    "\"" + path + "?xpage=suggest&classname=" + classname + "&fieldname=" + fieldname + "&firCol="
                        + firstCol + "&secCol=" + secondCol + "&\"";
                String varname = "\"input\"";
                String seps = "\"" + this.getSeparators() + "\"";
                if (isMultiSelect()) {
                    input.setOnFocus("new ajaxSuggest(this, {script:" + script + ", varname:" + varname + ", seps:"
                        + seps + "} )");
                } else {
                    input.setOnFocus("new ajaxSuggest(this, {script:" + script + ", varname:" + varname + "} )");
                }
            }

            buffer.append(input.toString());

        } else if (getDisplayType().equals(DISPLAYTYPE_RADIO) || getDisplayType().equals(DISPLAYTYPE_CHECKBOX)) {
            displayRadioEdit(buffer, name, prefix, object, context);
        } else {
            displaySelectEdit(buffer, name, prefix, object, context);

            // We need a hidden input with an empty value to be able to clear the selected values from the above select
            // when it has multiple selection enabled and no value selected.
            org.apache.ecs.xhtml.input hidden = new input(input.hidden, prefix + name, "");
            hidden.setAttributeFilter(new XMLAttributeValueFilter());
            hidden.setDisabled(isDisabled());
            buffer.append(hidden);
        }
    }
}