org.springframework.web.servlet.tags.form.OptionsTag Maven / Gradle / Ivy
/*
* Copyright 2002-2007 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.web.servlet.tags.form;
import javax.servlet.jsp.JspException;
import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;
import org.springframework.web.servlet.support.BindStatus;
import org.springframework.web.util.TagUtils;
/**
* Convenient tag that allows one to supply a collection of objects
* that are to be rendered as 'option' tags within a
* 'select' tag.
*
* Must be used within a {@link SelectTag 'select' tag}.
*
* @author Rob Harrop
* @since 2.0
*/
public class OptionsTag extends AbstractFormTag {
/**
* The {@link java.util.Collection}, {@link java.util.Map} or array of
* objects used to generate the inner 'option' tags.
*/
private Object items;
/**
* The name of the property mapped to the 'value' attribute
* of the 'option' tag.
*/
private String itemValue;
/**
* The name of the property mapped to the inner text of the
* 'option' tag.
*/
private String itemLabel;
/**
* Set the {@link java.util.Collection}, {@link java.util.Map} or array
* of objects used to generate the inner 'option' tags.
*
Required when wishing to render 'option' tags from an
* array, {@link java.util.Collection} or {@link java.util.Map}.
*
Typically a runtime expression.
* @param items said items
* @throws IllegalArgumentException if the supplied items instance is null
*/
public void setItems(Object items) {
this.items = items;
}
/**
* Get the {@link java.util.Collection}, {@link java.util.Map} or array
* of objects used to generate the inner 'option' tags.
*
Typically a runtime expression.
*/
protected Object getItems() {
return this.items;
}
/**
* Set the name of the property mapped to the 'value'
* attribute of the 'option' tag.
*
Required when wishing to render 'option' tags from
* an array or {@link java.util.Collection}.
*
May be a runtime expression.
*/
public void setItemValue(String itemValue) {
Assert.hasText(itemValue, "'itemValue' must not be empty");
this.itemValue = itemValue;
}
protected String getItemValue() {
return this.itemValue;
}
/**
* Set the name of the property mapped to the label (inner text) of the
* 'option' tag.
*
May be a runtime expression.
*/
public void setItemLabel(String itemLabel) {
Assert.hasText(itemLabel, "'itemLabel' must not be empty");
this.itemLabel = itemLabel;
}
/**
* Get the name of the property mapped to the label (inner text) of the
* 'option' tag.
*
May be a runtime expression.
*/
protected String getItemLabel() {
return this.itemLabel;
}
protected int writeTagContent(TagWriter tagWriter) throws JspException {
assertUnderSelectTag();
Object items = getItems();
Object itemsObject = (items instanceof String ? evaluate("items", (String) items) : items);
if (itemsObject != null) {
String itemValue = getItemValue();
String itemLabel = getItemLabel();
String valueProperty =
(itemValue != null ? ObjectUtils.getDisplayString(evaluate("itemValue", itemValue)) : null);
String labelProperty =
(itemLabel != null ? ObjectUtils.getDisplayString(evaluate("itemLabel", itemLabel)) : null);
OptionWriter optionWriter =
new OptionWriter(itemsObject, getBindStatus(), valueProperty, labelProperty, isHtmlEscape());
optionWriter.writeOptions(tagWriter);
}
return EVAL_PAGE;
}
private void assertUnderSelectTag() {
TagUtils.assertHasAncestorOfType(this, SelectTag.class, "options", "select");
}
private BindStatus getBindStatus() {
return (BindStatus) this.pageContext.getAttribute(SelectTag.LIST_VALUE_PAGE_ATTRIBUTE);
}
}