/*
* Copyright 2004 The Apache Software Foundation.
*
* 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.
*
* $Header:$
*/
package org.apache.beehive.netui.tags.html;
// java imports
// internal imports
import org.apache.beehive.netui.tags.AbstractClassicTag;
import org.apache.beehive.netui.util.Bundle;
import javax.servlet.jsp.JspException;
import javax.servlet.jsp.tagext.JspTag;
import javax.servlet.jsp.tagext.SimpleTagSupport;
/**
* Writes a URL parameter to a URL on its parent tag. The parent tag must implement IUrlParams.
* @jsptagref.tagdescription Writes a name/value pair to the URL or the parent tag.
*
* You can dynamically determine the value of the <netui:parameter> through
* the <code>value</code> attribute.
* @example In this sample, the hyperlink is amended with the parameter <code>q=Socrates</code>
*
* <pre> <netui:anchor href="http://www.google.com/search">
* Search Google with the query "Socrates"
* <netui:parameter name="q" value="Socrates" />
* </netui:anchor></pre>
*
* The URL produced appears below:
*
* <pre> http://www.google.com/search?q=Socrates</pre>
* @netui:tag name="parameter" description="Writes a URL parameter to a URL on its parent tag."
*/
public class Parameter
extends AbstractClassicTag
{
private String _name = null;
private Object _value = null;
/**
* Return the name of the Tag.
*/
public String getTagName()
{
return "Parameter";
}
/**
* Sets the name of the URL parameter.
* @param name the parameter name.
* @jsptagref.attributedescription The name of the parameter.
* @jsptagref.databindable false
* @jsptagref.attributesyntaxvalue <i>string_name</i>
* @netui:attribute required="true" rtexprvalue="true"
* description="The name of the parameter."
*/
public void setName(String name)
{
_name = name;
}
/**
* Sets the value of the URL parameter. This can be an expression.
* @param value the parameter value.
* @jsptagref.attributedescription The value of the parameter. May be a literal or a data binding expression.
* @jsptagref.databindable true
* @jsptagref.attributesyntaxvalue <i>string_or_expression_value</i>
* @netui:attribute required="true" rtexprvalue="true" type="java.lang.Object"
* description="The value of the parameter."
*/
public void setValue(Object value)
throws JspException
{
_value = value;
}
/**
* Add the URL parameter to the Parameter's parent.
* @throws JspException if a JSP exception has occurred
*/
public int doStartTag() throws JspException
{
JspTag parentTag = SimpleTagSupport.findAncestorWithClass(this, IUrlParams.class);
if (parentTag == null) {
String msg = Bundle.getString("Tags_InvalidParameterParent");
registerTagError(msg, null);
reportErrors();
}
else {
IUrlParams parent = (IUrlParams) parentTag;
parent.addParameter(_name, _value, null);
}
localRelease();
return SKIP_BODY;
}
/**
* Release any acquired resources.
*/
protected void localRelease()
{
super.localRelease();
_name = null;
_value = null;
}
}