Java Doc for ExpressoTool.java in » J2EE » Expresso » com » jcorporate » expresso » ext » 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 » J2EE » Expresso » com.jcorporate.expresso.ext.velocity

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

com.jcorporate.expresso.ext.velocity .ExpressoTool

ExpressoTool

public class ExpressoTool (Code)

A generic object that allows Velocity pages to be written more user friendly.
author:
David Lloyd
author:

author:

author:
   $Log: ExpressoTool.java,v $
author:
   Revision 1.5 2004/11/18 02:03:29 lhamel
author:
   cosmetic reformat
author:
   Revision 1.4 2004/11/17 20:48:16 lhamel
author:
   cosmetic reformat
author:

author:
   Revision 1.3 2004/09/29 07:05:01 mtraum
author:
   added license to source files
author:

author:
   Revision 1.2 2004/09/22 05:11:55 mtraum
author:
   organize imports
author:

author:
Revision 1.1 2004/05/29 16:51:31 dlloyd
author:
Initial checkin of velocity support

Method Summary
public com.jcorporate.expresso.core.misc.ConfigManager	getConfigManager() Get the ConfigManager singleton.
public Object	getElement(ControllerResponse response, String path) Find a `ControllerElement` in the response identified by a path. This path is somewhat similar to the paths used in the taglibs.
public Object	getElementFrom(ControllerResponse response, ControllerElement from, String path) Find a `ControllerElement` in the response identified by a path. This path is somewhat similar to the paths used in the taglibs.
public List	getSchemaList(String dataContext) Returns the list of installed schemas.
public String	getSetupValue(String dataContext, String key) Get a value from the setup table.
public String	getString(ControllerResponse response, String code, List args) Return a string in the messages bundles.

Method Detail

getConfigManager
public com.jcorporate.expresso.core.misc.ConfigManager getConfigManager()(Code)
	Get the ConfigManager singleton. The ConfigManager singleton.

getElement

public Object getElement(ControllerResponse response, String path) throws ControllerException(Code)

Find a ControllerElement in the response identified by a path.

This path is somewhat similar to the paths used in the taglibs. The differences

are that a leading '/' means start from the controller response and a '@' means

to return the string which is the attribute by the name that follows. Also, if

the path item name cannot be found and the name starts with one of 'BLOCK:',

'OUTPUT:', 'INPUT:', or 'TRANSITION:', then the prefix is removed and the search

is made again limited to the type of object specified.

An example use in Velocity:

#exp_element( $myelement "lists/groups/tests" )

returns the element named 'tests'

#exp_element( $myelement "lists/BLOCK:groups/tests" )

returns the same element named 'tests' as above but useful if

an object named groups exists in transitions (for example).

#exp_element( $myelement "lists/groups/@style" )

returns the string for attribute 'style' in 'groups'

Parameters:
response - The controllerResponse request attribute.
Parameters:
path - The path to the element or attribute to be returned. The found object or null.

getElementFrom

public Object getElementFrom(ControllerResponse response, ControllerElement from, String path) throws ControllerException(Code)

Find a ControllerElement in the response identified by a path.

This path is somewhat similar to the paths used in the taglibs. The differences

are that a leading '/' means start from the controller response and a '@' means

to return the string which is the attribute by the name that follows. Also, if

the path item name cannot be found and the name starts with one of 'BLOCK:',

'OUTPUT:', 'INPUT:', or 'TRANSITION:', then the prefix is removed and the search

is made again limited to the type of object specified. If the from parameter is null

or the path starts with a '/' then this function behaves the same as

getElement(response, path).

An example use in Velocity:

#exp_elementFrom( $myelement $fromElement "lists/groups/tests" )

returns the element named 'tests'

#exp_element( $myelement $fromElement "lists/BLOCK:groups/tests" )

returns the same element named 'tests' as above but useful if

an object named groups exists in transitions (for example).

#exp_element( $myelement $fromElement "lists/groups/@style" )

returns the string for attribute 'style' in 'groups'

Parameters:
  response - The controllerResponse request attribute.
Parameters:
  path - The path to the element or attribute to be returned.
Parameters:
  from - The ControllerElement to start the search from. The found object or null.

getSchemaList
public List getSchemaList(String dataContext) throws DBException(Code)
	Returns the list of installed schemas. This would commonly be used to support the current expresso tradition of listin the installed components in the left menu. Parameters: dataContext - The data context for SchemaList (typically 'default'). The SchemaList.

getSetupValue
public String getSetupValue(String dataContext, String key) throws DBException(Code)
	Get a value from the setup table. A simple wrapper for Setup.getValue(dataContext, key). Parameters: dataContext - The data context for the setup table. Parameters: key - The key whose value is to be retrieved. The found value or null See Also: com.jcorporate.expresso.services.dbobj.Setup

getString
public String getString(ControllerResponse response, String code, List args) throws ControllerException(Code)
	Return a string in the messages bundles. The current schema stack is seached for the correct translation. This is a wrapper for Messages.getString(stack,locale,code,args). Parameters: response - The controllerResponse request attribute that contains the schema stack. Parameters: code - The string code being searched for. Parameters: args - Any replacement arguments; can be null. The code translation if found, otherwise the code itself.

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.