Java Doc for ActionMessagesTool.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 .MessageResourcesTool

org.apache.velocity.tools.struts .ActionMessagesTool

All known Subclasses:   org.apache.velocity.tools.struts .ErrorsTool,
ActionMessagesTool
public class ActionMessagesTool extends MessageResourcesTool (Code)

View tool to work with the Struts action messages.

Template example(s): #if( $messages.exist() ) #foreach( $e in $messages.all ) $e <br> #end #end Toolbox configuration: <tool> <key>messages</key> <scope>request</scope> <class>org.apache.velocity.tools.struts.ActionMessagesTool</class> </tool>

This tool should only be used in the request scope.

author:
   Gabe Sidler
author:
   Nathan Bubna
since:
   VelocityTools 1.1
version:
   $Id: ActionMessagesTool.java 479724 2006-11-27 18:49:37Z nbubna $

Field Summary
final protected static Log LOG

protected ActionMessages actionMsgs
     A reference to the queued action messages.

Constructor Summary
public ActionMessagesTool()
     Default constructor.

Method Summary
public boolean exist()

public boolean exist(String property)

public List get(String property)
     Returns the set of localized action messages as an java.util.List of strings for all actionMsgs queued of the specified category or null if no messages are queued for the specified category.
public List get(String property, String bundle)
     Returns the set of localized action messages as a java.util.List of strings for all action messages queued of the specified category or null if no action messages are queued for the specified category.
public List getAll()
     Returns the set of localized action messages as an java.util.List of strings for all actionMsgs queued or null if no messages are queued.
public List getAll(String bundle)
     Returns a List of all queued action messages using the specified message resource bundle.
public List getGlobal()

This a convenience method and the equivalent of $messages.get($messages.globalName).

Returns the set of localized action messages as an list of strings for all action messages queued of the global category or null if no messages are queued for the specified category.
public String getGlobalName()
     Returns the default "GLOBAL" category name that can be used for messages that are not associated with a particular property.
public int getSize()
     Returns the number of action messages queued.
public int getSize(String property)
     Returns the number of action messages queued for a particular property.
public void init(Object obj)
     Initializes this tool.

Field Detail
LOG
final protected static Log LOG(Code)

actionMsgs
protected ActionMessages actionMsgs(Code)
A reference to the queued action messages.

Constructor Detail
ActionMessagesTool
public ActionMessagesTool()(Code)
Default constructor. Tool must be initialized before use.

Method Detail
exist
public boolean exist()(Code)

Returns true if there are action messages queued, otherwise false.

exist
public boolean exist(String property)(Code)

Returns true if there are action messages queued for the specified category of messages, otherwise false.

Parameters:
  property - the category of messages to check for

get
public List get(String property)(Code)
Returns the set of localized action messages as an java.util.List of strings for all actionMsgs queued of the specified category or null if no messages are queued for the specified category. If the message resources don't contain a message for a particular key, the key itself is used as the message.
Parameters:
  property - the category of actionMsgs to operate on

get
public List get(String property, String bundle)(Code)
Returns the set of localized action messages as a java.util.List of strings for all action messages queued of the specified category or null if no action messages are queued for the specified category. If the message resources don't contain an action message for a particular action key, the key itself is used as action message.
Parameters:
  property - the category of actionMsgs to operate on
Parameters:
  bundle - the message resource bundle to use

getAll
public List getAll()(Code)
Returns the set of localized action messages as an java.util.List of strings for all actionMsgs queued or null if no messages are queued. If the message resources don't contain a message for a particular key, the key itself is used as the message.

getAll
public List getAll(String bundle)(Code)
Returns a List of all queued action messages using the specified message resource bundle.
Parameters:
  bundle - the message resource bundle to use
See Also:   ActionMessagesTool.getAll()

getGlobal
public List getGlobal()(Code)

This a convenience method and the equivalent of $messages.get($messages.globalName).

Returns the set of localized action messages as an list of strings for all action messages queued of the global category or null if no messages are queued for the specified category. If the message resources don't contain an action message for a particular message key, the key itself is used.
a list of all messages stored under the "global" property

getGlobalName
public String getGlobalName()(Code)
Returns the default "GLOBAL" category name that can be used for messages that are not associated with a particular property.

getSize
public int getSize()(Code)
Returns the number of action messages queued.

getSize
public int getSize(String property)(Code)
Returns the number of action messages queued for a particular property.
Parameters:
  property - the category of messages to check for

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

Fields inherited from org.apache.velocity.tools.struts.MessageResourcesTool
final protected static Log LOG(Code)(Java Doc)
protected ServletContext application(Code)(Java Doc)
protected Locale locale(Code)(Java Doc)
protected HttpServletRequest request(Code)(Java Doc)
protected MessageResources resources(Code)(Java Doc)

Methods inherited from org.apache.velocity.tools.struts.MessageResourcesTool
protected MessageResources getResources(String bundle)(Code)(Java Doc)
public void init(Object obj)(Code)(Java Doc)

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.