Package | Description |
---|---|
freemarker.core |
This package contains FreeMarker's core parsing/rendering functionality;
most casual users do not need to be aware of the classes in this package,
and can restrict their attention to the
freemarker.template
package. |
freemarker.ext.beans |
Provides model implementations that allow access to arbitrary Java objects.
|
freemarker.ext.jython |
Provides model implementations that allow access to arbitrary
Jython objects.
|
freemarker.ext.rhino |
Rhino (ECMAScript) support
|
freemarker.ext.servlet |
Provides a generic purpose servlet that generates dynamic response using
FreeMarker.
|
freemarker.ext.util | |
freemarker.template |
This package contains the core API's that most users will use.
|
Modifier and Type | Method and Description |
---|---|
ObjectWrapper |
Configurable.getObjectWrapper()
Retrieves the object wrapper used to wrap objects to template models.
|
Modifier and Type | Method and Description |
---|---|
void |
Configurable.setObjectWrapper(ObjectWrapper objectWrapper)
Sets the object wrapper used to wrap objects to template models.
|
Modifier and Type | Class and Description |
---|---|
class |
BeansWrapper
Utility class that provides generic services to reflection classes.
|
Modifier and Type | Method and Description |
---|---|
ObjectWrapper |
BeansWrapper.getOuterIdentity()
By default returns this.
|
Modifier and Type | Method and Description |
---|---|
void |
BeansWrapper.setOuterIdentity(ObjectWrapper outerIdentity)
When wrapping an object, the BeansWrapper commonly needs to wrap
"sub-objects", for example each element in a wrapped collection.
|
Modifier and Type | Class and Description |
---|---|
class |
JythonWrapper
An object wrapper that wraps Jython objects into FreeMarker template models
and vice versa.
|
Modifier and Type | Class and Description |
---|---|
class |
RhinoWrapper |
Modifier and Type | Method and Description |
---|---|
protected ObjectWrapper |
FreemarkerServlet.createObjectWrapper()
This method is called from
FreemarkerServlet.init() to create the
FreeMarker object wrapper object that this servlet will use
for adapting request, session, and servlet context attributes into
template models.. |
protected ObjectWrapper |
FreemarkerServlet.getObjectWrapper() |
ObjectWrapper |
HttpRequestHashModel.getObjectWrapper() |
Modifier and Type | Method and Description |
---|---|
protected TemplateModel |
FreemarkerServlet.createModel(ObjectWrapper wrapper,
javax.servlet.ServletContext servletContext,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
Constructor and Description |
---|
AllHttpScopesHashModel(ObjectWrapper wrapper,
javax.servlet.ServletContext context,
javax.servlet.http.HttpServletRequest request)
Creates a new instance of AllHttpScopesHashModel for handling a single
HTTP servlet request.
|
HttpRequestHashModel(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ObjectWrapper wrapper) |
HttpRequestHashModel(javax.servlet.http.HttpServletRequest request,
ObjectWrapper wrapper) |
HttpSessionHashModel(FreemarkerServlet servlet,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
ObjectWrapper wrapper)
Use this constructor when the session isn't already created.
|
HttpSessionHashModel(javax.servlet.http.HttpSession session,
ObjectWrapper wrapper)
Use this constructor when the session already exists.
|
ServletContextHashModel(javax.servlet.GenericServlet servlet,
ObjectWrapper wrapper) |
ServletContextHashModel(javax.servlet.ServletContext servletctx,
ObjectWrapper wrapper)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
TemplateModel |
ModelFactory.create(java.lang.Object object,
ObjectWrapper wrapper)
Create a wrapping model for the specified object that belongs to
the specified wrapper.
|
Modifier and Type | Class and Description |
---|---|
class |
DefaultObjectWrapper
The default implementation of the ObjectWrapper
interface.
|
class |
SimpleObjectWrapper
The default implementation of the ObjectWrapper
interface.
|
Modifier and Type | Field and Description |
---|---|
static ObjectWrapper |
ObjectWrapper.BEANS_WRAPPER
An ObjectWrapper that works similarly to
SIMPLE_WRAPPER , but
exposes the objects methods and JavaBeans properties as hash elements
and custom handling for Java Maps, ResourceBundles, etc. |
static ObjectWrapper |
ObjectWrapper.DEFAULT_WRAPPER
The default object wrapper implementation.
|
static ObjectWrapper |
ObjectWrapper.SIMPLE_WRAPPER
Object wrapper that uses SimpleXXX wrappers only.
|
Modifier and Type | Method and Description |
---|---|
static ObjectWrapper |
WrappingTemplateModel.getDefaultObjectWrapper()
Returns the default object wrapper that is used when a wrapping template
model is constructed without being passed an explicit object wrapper.
|
ObjectWrapper |
WrappingTemplateModel.getObjectWrapper()
Returns the object wrapper instance used by this wrapping template model.
|
Modifier and Type | Method and Description |
---|---|
Environment |
Template.createProcessingEnvironment(java.lang.Object rootMap,
java.io.Writer out,
ObjectWrapper wrapper)
Creates a
Environment object,
using this template, the data model provided as the root map object, and
the supplied object wrapper to convert map elements to template models. |
void |
Template.process(java.lang.Object rootMap,
java.io.Writer out,
ObjectWrapper wrapper)
Processes the template, using data from the root map object, and outputs
the resulting text to the supplied writer, using the supplied
object wrapper to convert map elements to template models.
|
void |
Template.process(java.lang.Object rootMap,
java.io.Writer out,
ObjectWrapper wrapper,
TemplateNodeModel rootNode)
Processes the template, using data from the root map object, and outputs
the resulting text to the supplied writer, using the supplied
object wrapper to convert map elements to template models.
|
static void |
WrappingTemplateModel.setDefaultObjectWrapper(ObjectWrapper objectWrapper)
Sets the default object wrapper that is used when a wrapping template
model is constructed without being passed an explicit object wrapper.
|
void |
WrappingTemplateModel.setObjectWrapper(ObjectWrapper objectWrapper) |
Constructor and Description |
---|
SimpleCollection(java.util.Collection collection,
ObjectWrapper wrapper) |
SimpleCollection(java.util.Iterator iterator,
ObjectWrapper wrapper) |
SimpleHash(java.util.Map map,
ObjectWrapper wrapper)
Creates a new simple hash with the copy of the underlying map and
either the default wrapper set in
WrappingTemplateModel.setDefaultObjectWrapper(ObjectWrapper) , or
the JavaBeans wrapper . |
SimpleHash(ObjectWrapper wrapper)
Creates an empty simple hash using the specified object wrapper.
|
SimpleSequence(java.util.Collection collection,
ObjectWrapper wrapper)
Constructs a simple sequence that will contain the elements
from the specified
Collection and will use the specified object
wrapper. |
SimpleSequence(ObjectWrapper wrapper)
Constructs an empty simple sequence using the specified object wrapper.
|
WrappingTemplateModel(ObjectWrapper objectWrapper)
Protected constructor that creates a new wrapping template model using
the specified object wrapper.
|