/*
* $RCSfile: CVOptionTag.java,v $ $Revision: 1.1.1.1 $ $Date: 2005/04/28 20:29:03 $ - $Author: mking_cv $
*
* The contents of this file are subject to the Open Software License
* Version 2.1 (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.centraview.com/opensource/license.html
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
* License for the specific language governing rights and limitations
* under the License.
*
* The Original Code is: CentraView Open Source.
*
* The developer of the Original Code is CentraView. Portions of the
* Original Code created by CentraView are Copyright (c) 2004 CentraView,
* LLC; All Rights Reserved. The terms "CentraView" and the CentraView
* logos are trademarks and service marks of CentraView, LLC.
*/
/*
* $Header: /cvsroot/centraview/centraview/centraview/struts/com/centraview/udt/CVOptionTag.java,v 1.1.1.1 2005/04/28 20:29:03 mking_cv Exp $
* $Revision: 1.1.1.1 $
* $Date: 2005/04/28 20:29:03 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999-2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Struts", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
// package declaration
package com.centraview.udt;
import java.util.Locale;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.BodyTagSupport;
import org.apache.struts.Globals;
import org.apache.struts.taglib.html.Constants;
import org.apache.struts.util.MessageResources;
import org.apache.struts.util.RequestUtils;
import org.apache.struts.util.ResponseUtils;
/**
* Tag for select options. The body of this tag is presented to the user
* in the option list, while the value attribute is the value returned to
* the server if this option is selected.
*
* @author Craig R. McClanahan
* @author David Graham
* @version $Revision: 1.1.1.1 $ $Date: 2005/04/28 20:29:03 $
*/
public class CVOptionTag extends BodyTagSupport {
// ----------------------------------------------------- Instance Variables
/**
* The default locale for our server.
* @deprecated Use Locale.getDefault() directly.
*/
protected static final Locale defaultLocale = Locale.getDefault();
/**
* The message resources for this package.
*/
protected static MessageResources messages =
MessageResources.getMessageResources
("ApplicationResources");
/**
* The message text to be displayed to the user for this tag (if any)
*/
protected String text = null;
// ------------------------------------------------------------- Properties
/**
* The name of the servlet context attribute containing our message
* resources.
*/
protected String bundle = Globals.MESSAGES_KEY;
public String getBundle() {
return (this.bundle);
}
public void setBundle(String bundle) {
this.bundle = bundle;
}
/**
* Is this option disabled?
*/
protected boolean disabled = false;
public boolean getDisabled() {
return (this.disabled);
}
public void setDisabled(boolean disabled) {
this.disabled = disabled;
}
/**
* The key used to look up the text displayed to the user for this
* option, if any.
*/
protected String key = null;
public String getKey() {
return (this.key);
}
public void setKey(String key) {
this.key = key;
}
/**
* The name of the attribute containing the Locale to be used for
* looking up internationalized messages.
*/
protected String locale = Globals.LOCALE_KEY;
public String getLocale() {
return (this.locale);
}
public void setLocale(String locale) {
this.locale = locale;
}
/**
* The style associated with this tag.
*/
private String style = null;
public String getStyle() {
return style;
}
public void setStyle(String style) {
this.style = style;
}
/**
* The named style class associated with this tag.
*/
private String styleClass = null;
public String getStyleClass() {
return styleClass;
}
public void setStyleClass(String styleClass) {
this.styleClass = styleClass;
}
/**
* The identifier associated with this tag.
*/
protected String styleId = null;
/**
* Return the style identifier for this tag.
*/
public String getStyleId() {
return (this.styleId);
}
/**
* Set the style identifier for this tag.
*
* @param styleId The new style identifier
*/
public void setStyleId(String styleId) {
this.styleId = styleId;
}
/**
* The server value for this option, also used to match against the
* current property value to determine whether this option should be
* marked as selected.
*/
protected String value = null;
public String getValue() {
return (this.value);
}
public void setValue(String value) {
this.value = value;
}
// --------------------------------------------------------- Public Methods
/**
* Process the start of this tag.
*
* @exception JspException if a JSP exception has occurred
*/
public int doStartTag() throws JspException {
// Initialize the placeholder for our body content
this.text = null;
// Do nothing until doEndTag() is called
return (EVAL_BODY_TAG);
}
/**
* Process the body text of this tag (if any).
*
* @exception JspException if a JSP exception has occurred
*/
public int doAfterBody() throws JspException {
if (bodyContent != null) {
String text = bodyContent.getString();
if (text != null) {
text = text.trim();
if (text.length() > 0) {
this.text = text;
}
}
}
return (SKIP_BODY);
}
/**
* Process the end of this tag.
*
* @exception JspException if a JSP exception has occurred
*/
public int doEndTag() throws JspException {
ResponseUtils.write(pageContext, this.renderOptionElement());
return (EVAL_PAGE);
}
/**
* Generate an HTML %lt;option> element.
* @throws JspException
* @since Struts 1.1
*/
protected String renderOptionElement() throws JspException {
StringBuffer results = new StringBuffer("<option value=\"");
results.append(this.value);
results.append("\"");
if (disabled) {
results.append(" disabled=\"disabled\"");
}
if (this.selectTag().isMatched(this.value)) {
results.append(" selected=\"selected\"");
}
if (style != null) {
results.append(" style=\"");
results.append(style);
results.append("\"");
}
if (styleId != null) {
results.append(" id=\"");
results.append(styleId);
results.append("\"");
}
if (styleClass != null) {
results.append(" class=\"");
results.append(styleClass);
results.append("\"");
}
results.append(">");
results.append(text());
results.append("</option>");
return results.toString();
}
/**
* Acquire the select tag we are associated with.
* @throws JspException
*/
private CVSelectTag selectTag() throws JspException {
CVSelectTag selectTag =
(CVSelectTag) pageContext.getAttribute(Constants.SELECT_KEY);
if (selectTag == null) {
JspException e =
new JspException(messages.getMessage("optionTag.select"));
RequestUtils.saveException(pageContext, e);
throw e;
}
return selectTag;
}
/**
* Release any acquired resources.
*/
public void release() {
super.release();
bundle = Globals.MESSAGES_KEY;
disabled = false;
key = null;
locale = Globals.LOCALE_KEY;
style = null;
styleClass = null;
text = null;
value = null;
}
// ------------------------------------------------------ Protected Methods
/**
* Return the text to be displayed to the user for this option (if any).
*
* @exception JspException if an error occurs
*/
protected String text() throws JspException {
String optionText = this.text;
if ((optionText == null) && (this.key != null)) {
optionText = RequestUtils.message(pageContext, bundle, locale, key);
}
// no body text and no key to lookup so display the value
if (optionText == null) {
optionText = this.value;
}
return optionText;
}
}