Java Doc for VelocityManager.java in » Web-Framework » struts-2.0.11 » org » apache » struts2 » views » velocity » 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 » Web Framework » struts 2.0.11 » org.apache.struts2.views.velocity

Source Cross Reference

Class Diagram

Java Document (Java Doc)

java.lang .Object

org.apache.struts2.views.velocity .VelocityManager

VelocityManager
public class VelocityManager (Code)
	Manages the environment for Velocity result types

Field Summary
final public static String	PARENT
final public static String	STRUTS
final public static String	TAG
protected ToolboxManager	toolboxManager A reference to the toolbox manager.

Constructor Summary
public	VelocityManager()

Method Summary
public Context	createContext(ValueStack stack, HttpServletRequest req, HttpServletResponse res) This method is responsible for creating the standard VelocityContext used by all WW2 velocity views.
public VelocityEngine	getVelocityEngine()
public Properties	getVelocityProperties()
public synchronized void	init(ServletContext context) initializes the VelocityManager.
protected void	initToolbox(ServletContext context) Initializes the ServletToolboxManager for this servlet's toolbox (if any).
public Properties	loadConfiguration(ServletContext context) load optional velocity properties using the following loading strategy relative to the servlet context path relative to the WEB-INF directory on the classpath Parameters: context - the current ServletContext.
protected VelocityEngine	newVelocityEngine(ServletContext context) Instantiates a new VelocityEngine. The following is the default Velocity configuration resource.loader = file, class file.resource.loader.path = real path of webapp class.resource.loader.description = Velocity Classpath Resource Loader class.resource.loader.class = org.apache.struts2.views.velocity.StrutsResourceLoader this default configuration can be overridden by specifying a struts.velocity.configfile property in the struts.properties file.
protected VelocityContext[]	prepareChainedContexts(HttpServletRequest servletRequest, HttpServletResponse servletResponse, Map extraContext) constructs contexts for chaining on this request.
public void	setChainedContexts(String contexts) allow users to specify via the struts.properties file a set of additional VelocityContexts to chain to the the StrutsVelocityContext.
public void	setContainer(Container container)
public void	setCustomConfigFile(String val)
public void	setObjectFactory(ObjectFactory fac)
public void	setToolBoxLocation(String toolboxLocation)
public void	setVelocityProperties(Properties velocityProperties)

Field Detail

PARENT
final public static String PARENT(Code)
	the parent JSP tag

STRUTS
final public static String STRUTS(Code)

TAG
final public static String TAG(Code)
	the current JSP tag

toolboxManager
protected ToolboxManager toolboxManager(Code)
	A reference to the toolbox manager.

Constructor Detail

VelocityManager
public VelocityManager()(Code)

Method Detail

createContext

public Context createContext(ValueStack stack, HttpServletRequest req, HttpServletResponse res)(Code)

This method is responsible for creating the standard VelocityContext used by all WW2 velocity views. The following context parameters are defined:

request - the current HttpServletRequest
response - the current HttpServletResponse
stack - the current ValueStack
ognl - an OgnlTool
struts - an instance of org.apache.struts2.util.StrutsUtil
action - the current Struts action

a new StrutsVelocityContext

getVelocityEngine
public VelocityEngine getVelocityEngine()(Code)
	a reference to the VelocityEngine used by all struts velocity thingies with the exception ofdirectly accessed *.vm pages

getVelocityProperties
public Properties getVelocityProperties()(Code)
	the velocityProperties

init
public synchronized void init(ServletContext context)(Code)
	initializes the VelocityManager. this should be called during the initialization process, say by ServletDispatcher. this may be called multiple times safely although calls beyond the first won't do anything Parameters: context - the current servlet context

initToolbox
protected void initToolbox(ServletContext context)(Code)
	Initializes the ServletToolboxManager for this servlet's toolbox (if any).

loadConfiguration
public Properties loadConfiguration(ServletContext context)(Code)
	load optional velocity properties using the following loading strategy relative to the servlet context path relative to the WEB-INF directory on the classpath Parameters: context - the current ServletContext. may not be null the optional properties if struts.velocity.configfile was specified, an empty Properties file otherwise

newVelocityEngine

protected VelocityEngine newVelocityEngine(ServletContext context)(Code)

Instantiates a new VelocityEngine.

The following is the default Velocity configuration

 resource.loader = file, class
 file.resource.loader.path = real path of webapp
 class.resource.loader.description = Velocity Classpath Resource Loader
 class.resource.loader.class = org.apache.struts2.views.velocity.StrutsResourceLoader

this default configuration can be overridden by specifying a struts.velocity.configfile property in the struts.properties file. the specified config file will be searched for in the following order:

relative to the servlet context path
relative to the WEB-INF directory
on the classpath

Parameters:
context - the current ServletContext. may not be null

prepareChainedContexts
protected VelocityContext[] prepareChainedContexts(HttpServletRequest servletRequest, HttpServletResponse servletResponse, Map extraContext)(Code)
	constructs contexts for chaining on this request. This method does not perform any initialization of the contexts. All that must be done in the context itself. Parameters: servletRequest - Parameters: servletResponse - Parameters: extraContext - an VelocityContext[] of contexts to chain

setChainedContexts
public void setChainedContexts(String contexts)(Code)
	allow users to specify via the struts.properties file a set of additional VelocityContexts to chain to the the StrutsVelocityContext. The intent is to allow these contexts to store helper objects that the ui developer may want access to. Examples of reasonable VelocityContexts would be an IoCVelocityContext, a SpringReferenceVelocityContext, and a ToolboxVelocityContext

setContainer
public void setContainer(Container container)(Code)

setCustomConfigFile
public void setCustomConfigFile(String val)(Code)

setObjectFactory
public void setObjectFactory(ObjectFactory fac)(Code)

setToolBoxLocation
public void setToolBoxLocation(String toolboxLocation)(Code)

setVelocityProperties
public void setVelocityProperties(Properties velocityProperties)(Code)
	Parameters: velocityProperties - the velocityProperties to set

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.