com.samskivert.velocity.FormTool Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of samskivert Show documentation
Show all versions of samskivert Show documentation
A collection of Java utilities.
//
// $Id$
//
// samskivert library - useful routines for java programs
// Copyright (C) 2001-2011 Michael Bayne, et al.
//
// This library 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 library 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 library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
package com.samskivert.velocity;
import javax.servlet.http.HttpServletRequest;
import com.samskivert.servlet.util.HTMLUtil;
import com.samskivert.servlet.util.ParameterUtil;
import com.samskivert.util.StringUtil;
/**
* The form tool can be placed into an invocation context and used by the
* template to create form elements which automatically inherit form
* values which were provided to the page at request time.
*
* For example:
*
*
* Please enter your name: $form.text("name", 40) $form.submit("submit")
*
*
* If the servlet was invoked with a value for "name", it will be
* automatically filled into the "name" form field when it is requested.
*/
public class FormTool
{
/**
* Constructs a form tool that will use the supplied HTTP servlet
* request object to prefetch form values.
*/
public FormTool (HttpServletRequest req)
{
_req = req;
}
/**
* Used to deactivate XHTML generation for "old skool" Java HTML viewer.
*/
public void setUseXHTML (boolean useXHTML)
{
_useXHTML = useXHTML;
}
/**
* Creates a text input field with the specified name and no extra
* arguments or default value.
*
* @see #text(String,String,Object)
*/
public String text (String name)
{
return input("text", name, "", "");
}
/**
* Creates a text input field with the specified name and the
* specified extra arguments with no default value.
*
* @see #text(String,String,Object)
*/
public String text (String name, String extra)
{
return input("text", name, extra, "");
}
/**
* Creates a text input field with the specified name, extra arguments
* and default value. For example, a call to text("foo",
* "size=\"5\" maxLength=\"8\"", "bar") would result in an
* input field looking like:
*
*
* <input type="text" name="foo" value="bar" size="5" maxLength="8"/>
*
*
* Assuming the foo parameter had no pre-existing value.
*/
public String text (String name, String extra, Object defaultValue)
{
return input("text", name, extra, defaultValue);
}
/**
* Creates a text input field with the specified name and the
* specified extra arguments and the specified value.
*/
public String fixedText (String name, String extra, Object value)
{
return fixedInput("text", name, value, extra);
}
/**
* Creates a reset form element.
*
* @param name the name of the form element (used by JavaScript).
* @param value the name that will appear on the button.
*/
public String reset (String name, String value)
{
return fixedInput("reset", name, value, "");
}
/**
* Creates a password input field with the specified name and no extra
* arguments or default value.
*
* @see #password(String,String,Object)
*/
public String password (String name)
{
return input("password", name, "", "");
}
/**
* Creates a password input field with the specified name and the
* specified extra arguments with no default value.
*
* @see #password(String,String,Object)
*/
public String password (String name, String extra)
{
return input("password", name, extra, "");
}
/**
* Creates a password input field with the specified name, extra arguments
* and default value. For example, a call to password("foo",
* "size=\"5\"", "bar") would result in an
* input field looking like:
*
*
* <input type="password" name="foo" value="bar" size="5">
*
*
* Assuming the foo parameter had no pre-existing value.
*/
public String password (String name, String extra, Object defaultValue)
{
return input("password", name, extra, defaultValue);
}
/**
* Constructs a submit element with the name submit and
* the specified button text.
*/
public String submit (String text)
{
return fixedInput("submit", "submitBtn", text, "");
}
/**
* Constructs a submit element with the name submit and
* the specified button text with the specified extra text.
*/
public String submitExtra (String text, String extra)
{
return fixedInput("submit", "submitBtn", text, extra);
}
/**
* Constructs a submit element with the specified parameter name and
* the specified button text.
*/
public String submit (String name, String text)
{
return fixedInput("submit", name, text, "");
}
/**
* Constructs a submit element with the specified parameter name and
* the specified button text with the specified extra text.
*/
public String submitExtra (String name, String text, String extra)
{
return fixedInput("submit", name, text, extra);
}
/**
* Constructs a image submit element with the specified parameter name
* and image path.
*/
public String imageSubmit (String name, String imagePath)
{
return fixedInput("image", name, "", "src=\"" + imagePath + "\"");
}
/**
* Constructs a image submit element with the specified parameter name
* and image path.
*/
public String imageSubmit (String name, String value, String imagePath)
{
return fixedInput("image", name, value, "src=\"" + imagePath + "\"");
}
/**
* Constructs a image submit element with the specified parameter name
* and image path.
*/
public String imageSubmit (String name, String value, String imagePath,
String altText)
{
return fixedInput("image", name, value, "src=\"" + imagePath + "\" " +
"alt=\"" + altText + "\"");
}
/**
* Constructs a button input element with the specified parameter name,
* the specified button text, and the specified extra text.
*/
public String button (String name, String text, String extra)
{
return fixedInput("button", name, text, extra);
}
/**
* Constructs a hidden element with the specified parameter name where
* the value is extracted from the appropriate request parameter.
*/
public String hidden (String name)
{
return hidden(name, "");
}
/**
* Constructs a hidden element with the specified parameter name where
* the value is extracted from the appropriate request parameter
* unless there is no value in which case the supplied default value
* is used.
*/
public String hidden (String name, Object defaultValue)
{
return fixedHidden(name, getValue(name, defaultValue));
}
/**
* Constructs a fixed hidden element with the specified parameter name
* and value. The contents of the parameter of the same name are
* ignored when creating this element.
*/
public String fixedHidden (String name, Object value)
{
return fixedInput("hidden", name, value, "");
}
/**
* Generates a hidden form field named action with the
* specified value. This is handy when you have multiple forms
* submitting to the same servlet and you need to distinguist the
* action desired by the user.
*/
public String action (String value)
{
return fixedInput("hidden", "action", value, "");
}
/**
* Constructs a checkbox input field with the specified name and
* default value.
*/
public String checkbox (String name, boolean defaultValue)
{
String value = getParameter(name);
return fixedCheckbox(
name, (value == null) ? defaultValue : !value.equals(""));
}
/**
* Constructs a checkbox input field with the specified name and
* value.
*/
public String fixedCheckbox (String name, boolean value)
{
StringBuilder buf = new StringBuilder();
buf.append("").append(item).append("");
return buf.toString();
}
/**
* Creates a radio button with the specified name and value.
*/
public String radio (String name, String value)
{
return radio(name, value, null);
}
/**
* Creates a radio button with the specified name and value.
*/
public String radio (String name, String value, String defaultValue)
{
StringBuilder buf = new StringBuilder();
buf.append("");
if (value != null) {
buf.append(value);
}
buf.append("");
return buf.toString();
}
/**
* Generates an input form field with the specified type, name,
* defaultValue and extra attributes.
*/
protected String input (String type, String name, String extra,
Object defaultValue)
{
return fixedInput(type, name, getValue(name, defaultValue), extra);
}
/**
* Generates an input form field with the specified type, name, value
* and extra attributes. The value is not fetched from the request
* parameters but is always the value supplied.
*/
protected String fixedInput (
String type, String name, Object value, String extra)
{
StringBuilder buf = new StringBuilder();
buf.append("" : ">";
}
/** A reference to the servlet request in use by this form tool. */
protected HttpServletRequest _req;
/** Whether or not we should aim to generate XHTML or HTML. */
protected boolean _useXHTML = true;
}