org.kuali.kfs.sys.document.web.renderers.DropDownRenderer.java Source code

Introduction

Here is the source code for org.kuali.kfs.sys.document.web.renderers.DropDownRenderer.java

Source

/*
 * The Kuali Financial System, a comprehensive financial management system for higher education.
 * 
 * Copyright 2005-2014 The Kuali Foundation
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program 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 Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.kuali.kfs.sys.document.web.renderers;

import java.io.IOException;

import javax.servlet.jsp.JspException;
import javax.servlet.jsp.JspWriter;
import javax.servlet.jsp.PageContext;
import javax.servlet.jsp.tagext.Tag;

import org.apache.commons.lang.StringUtils;
import org.kuali.kfs.sys.document.web.util.RendererUtil;
import org.kuali.rice.core.api.util.KeyValue;

/**
 * This renders a drop down field to JSP
 */
public class DropDownRenderer extends FieldRendererBase {

    /**
     * 
     * @see org.kuali.kfs.sys.document.web.renderers.Renderer#render(javax.servlet.jsp.PageContext, javax.servlet.jsp.tagext.Tag)
     */
    public void render(PageContext pageContext, Tag parentTag) throws JspException {
        JspWriter out = pageContext.getOut();

        try {
            out.write(buildSelectControl());
            renderQuickFinderIfNecessary(pageContext, parentTag);
            if (isShowError()) {
                renderErrorIcon(pageContext);
            }
            RendererUtil.registerEditableProperty(pageContext, getFieldName());
        } catch (IOException ioe) {
            throw new JspException("Difficulty rendering drop down control", ioe);
        }
    }

    /**
     * Builds a drop down control, based on the field
     * @param propertyPrefix the prefix of the property from the form to the business object
     * @return a String containing the HTML for the drop down control/select box
     */
    protected String buildSelectControl() {
        StringBuilder selectControl = new StringBuilder();
        selectControl.append("<select");

        selectControl.append(" id=\"");
        selectControl.append(getFieldName());
        selectControl.append("\" ");

        selectControl.append(" name=\"");
        selectControl.append(getFieldName());
        selectControl.append("\" ");

        selectControl.append(" title=\"");
        selectControl.append(this.getAccessibleTitle());
        selectControl.append("\"");

        final String onBlur = buildOnBlur();
        if (!StringUtils.isBlank(onBlur)) {
            selectControl.append(" onblur=\"");
            selectControl.append(onBlur);
            selectControl.append("\"");
        }

        selectControl.append(">");

        selectControl.append(buildOptions());

        selectControl.append("</select>");

        return selectControl.toString();
    }

    /**
     * Builds the options for the select box, given the valid values in the field
     * @return a String containing all the option tags for this drop down control
     */
    protected String buildOptions() {
        StringBuilder options = new StringBuilder();

        for (Object keyLabelPairAsObj : getField().getFieldValidValues()) {
            options.append(buildOption((KeyValue) keyLabelPairAsObj));
        }

        return options.toString();
    }

    /**
     * Builds an option tag for the given key label pair
     * @param keyLabelPair the key label pair to create an option tag from
     * @return the String with the option tag in it
     */
    protected String buildOption(KeyValue keyLabelPair) {
        StringBuilder option = new StringBuilder();

        option.append("<option value=\"");
        option.append(keyLabelPair.getKey());
        option.append("\"");
        if (getField().getPropertyValue().equalsIgnoreCase(keyLabelPair.getKey().toString())) {
            option.append(" selected=\"selected\"");
        }
        option.append(">");

        option.append(keyLabelPair.getValue());

        option.append("</options>");

        return option.toString();
    }

    /**
     * No quickfinder for us, thanks
     * @see org.kuali.kfs.sys.document.web.renderers.FieldRenderer#renderQuickfinder()
     */
    public boolean renderQuickfinder() {
        return false;
    }

}