Package | Description |
---|---|
freemarker.core |
The seldom used or advanced parts of the fundamental FreeMarker API, compared to
freemarker.template . |
freemarker.ext.beans |
The
default object wrapper of FreeMarker uses
this to expose Java Beans and POJO-s to templates, but it can also be used in itself as a
better alternative ObjectWrapper . |
freemarker.ext.jython |
Exposes Jython objects to templates.
|
freemarker.ext.rhino |
Exposes Rhino (ECMAScript) objects to templates.
|
freemarker.ext.servlet |
Servlet for legacy "Model 2" frameworks that allows using FreeMarker
templates instead of JSP as the MVC View
(see in the Manual).
|
freemarker.ext.util |
Various classes used by
freemarker.ext but might be useful outside it too. |
freemarker.template |
The fundamental, most commonly used API-s of FreeMarker;
start with
Configuration (also see
Getting Stared in the Manual.) |
Modifier and Type | Method and Description |
---|---|
ObjectWrapper |
Configurable.getObjectWrapper()
The getter pair of
Configurable.setObjectWrapper(ObjectWrapper) . |
Modifier and Type | Method and Description |
---|---|
void |
Configurable.setObjectWrapper(ObjectWrapper objectWrapper)
Sets the object wrapper used to wrap objects to
TemplateModel -s. |
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.. |
ObjectWrapper |
HttpRequestHashModel.getObjectWrapper() |
protected ObjectWrapper |
FreemarkerServlet.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 exposes the object methods and JavaBeans properties as hash elements, and has
custom handling for Java Map -s, ResourceBundle -s, etc. |
static ObjectWrapper |
ObjectWrapper.DEFAULT_WRAPPER
The default object wrapper implementation, focusing on backward compatibility and out-of-the box extra features.
|
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 dataModel,
java.io.Writer out,
ObjectWrapper wrapper)
Creates a
Environment object, using this template, the data-model provided as
parameter. |
void |
Template.process(java.lang.Object dataModel,
java.io.Writer out,
ObjectWrapper wrapper)
Like
Template.process(Object, Writer) , but overrides the Configurable.getObjectWrapper() . |
void |
Template.process(java.lang.Object dataModel,
java.io.Writer out,
ObjectWrapper wrapper,
TemplateNodeModel rootNode)
Like
Template.process(Object, Writer) , but also sets a (XML-)node to be recursively processed by the template. |
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.
|