Java Doc for FormTool.java in » Template-Engine » Velocity » org » apache » velocity » tools » struts » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Template Engine » Velocity » org.apache.velocity.tools.struts

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.apache.velocity.tools.struts .FormTool

FormTool

public class FormTool (Code)

View tool to work with HTML forms in Struts.

 Template example(s):
 <input type="hidden" name="$form.tokenName" value="$form.token">
 <input type="submit" name="$form.cancelName" value="Cancel">
 Toolbox configuration:
 <tool>
 <key>form</key>
 <scope>request</scope>
 <class>org.apache.velocity.tools.struts.FormTool</class>
 </tool>

This tool should only be used in the request scope.

author:
   Gabe Sidler
since:
   VelocityTools 1.0
version:
   $Id: FormTool.java 477914 2006-11-21 21:52:11Z henning $

Field Summary
protected HttpServletRequest	request A reference to the HtttpServletRequest.
protected HttpSession	session A reference to the HtttpSession.

Constructor Summary
public	FormTool() Default constructor.

Method Summary
public ActionForm	getBean() Returns the form bean associated with this action mapping. This is a convenience method.
public String	getCancelName()
public String	getName()
public String	getToken() Returns the transaction control token for this session or `null` if no token exists.
public String	getTokenName() Returns the query parameter name under which a transaction token must be reported.
public void	init(Object obj) Initializes this tool.

Field Detail

request
protected HttpServletRequest request(Code)
	A reference to the HtttpServletRequest.

session
protected HttpSession session(Code)
	A reference to the HtttpSession.

Constructor Detail

FormTool
public FormTool()(Code)
	Default constructor. Tool must be initialized before use.

Method Detail

getBean

public ActionForm getBean()(Code)

Returns the form bean associated with this action mapping.

This is a convenience method. The form bean is automatically available in the Velocity context under the name defined in the Struts configuration.

If the form bean is used repeatedly, it is recommended to create a local variable referencing the bean rather than calling getBean() multiple times.

 Example:
 #set ($defaults = $form.bean)
 <input type="text" name="username" value="$defaults.username">

the ActionForm associated with this request ornull if there is no form bean associated with this mapping

getCancelName

public String getCancelName()(Code)

Returns the query parameter name under which a cancel button press must be reported if form validation is to be skipped.

This is the value of org.apache.struts.taglib.html.Constants.CANCEL_PROPERTY

getName
public String getName()(Code)
	Returns the form bean name associated with this action mapping. the name of the ActionForm associated with this request or`null` if there is no form bean associated with this mapping

getToken
public String getToken()(Code)
	Returns the transaction control token for this session or `null` if no token exists.

getTokenName
public String getTokenName()(Code)
	Returns the query parameter name under which a transaction token must be reported. This is the value of `org.apache.struts.taglib.html.Constants.TOKEN_KEY`

init
public void init(Object obj)(Code)
	Initializes this tool. Parameters: obj - the current ViewContext throws: IllegalArgumentException - if the param is not a ViewContext

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.