Uses of Interface freemarker.template.TemplateModel

Uses in package freemarker.ext.rhino

Classes implementing freemarker.template.TemplateModel
class	RhinoFunctionModel Experimental: no backward compatibility guarantees; any feedback is highly welcome!
class	RhinoScriptableModel Experimental: no backward compatibility guarantees; any feedback is highly welcome!

Methods with return type freemarker.template.TemplateModel
TemplateModel	RhinoScriptableModel.get(String key)
TemplateModel	RhinoScriptableModel.get(int index)
TemplateModel	RhinoWrapper.wrap(Object obj)

Uses in package freemarker.ext.xml

Classes implementing freemarker.template.TemplateModel
class	NodeListModel A data model adapter for three widespread XML document object model representations: W3C DOM, dom4j, and JDOM.

Methods with return type freemarker.template.TemplateModel
TemplateModel	NodeListModel.get(String key) Returns a new NodeListModel containing the nodes that result from applying an operator to this model's nodes.
TemplateModel	NodeListModel.get(int index) Selects a single node from this model's nodelist by its list index and returns a new NodeListModel containing that single node.

Uses in package freemarker.ext.jdom

Classes implementing freemarker.template.TemplateModel
class	NodeListModel Provides a template for wrapping JDOM objects.

Methods with return type freemarker.template.TemplateModel
TemplateModel	NodeListModel.get(String key) Provides node list traversal as well as special functions: filtering by name, filtering by node type, shallow-copying, and duplicate removal.
TemplateModel	NodeListModel.get(int i) Retrieves the i-th element of the node list.

Uses in package freemarker.ext.dom

Classes implementing freemarker.template.TemplateModel
class	NodeModel A base class for wrapping a W3C DOM Node as a FreeMarker template model.

Methods with return type freemarker.template.TemplateModel
TemplateModel	NodeModel.exec(List args)
TemplateModel	XPathSupport.executeQuery(Object context, String xpathQuery)
TemplateModel	NodeModel.get(String key)
TemplateModel	NodeModel.get(int i)

Uses in package freemarker.template.utility

Classes implementing freemarker.template.TemplateModel
class	CaptureOutput A transform that captures the output of a block of FTL code and stores that in a variable.
class	DOMNodeModel A convenient wrapper class for wrapping a Node in the W3C DOM API.
class	Execute Gives FreeMarker the the ability to execute external commands.
class	HtmlEscape Performs an HTML escape of a given template fragment.
class	JythonRuntime A crude first pass at an embeddable Jython interpreter
class	NormalizeNewlines Transformer that supports FreeMarker legacy behavior: all newlines appearing within the transformed area will be transformed into the platform's default newline.
class	ObjectConstructor An object that you can make available in a template to instantiate arbitrary beans-wrapped objects in a template.
class	StandardCompress A filter that compresses each sequence of consecutive whitespace to a single line break (if the sequence contains a line break) or a single space.
class	XmlEscape Performs an XML escaping of a given template fragment.

Methods with parameter type freemarker.template.TemplateModel
Object	DeepUnwrap.premissiveUnwrap(TemplateModel model) Same as `unwrap(TemplateModel)`, but it doesn't throw exception if it doesn't know how to unwrap the object, but returns it as is.
Object	DeepUnwrap.unwrap(TemplateModel model) Unwraps `TemplateModel`-s recursively.

Methods with return type freemarker.template.TemplateModel
TemplateModel	DOMNodeModel.get(String key)

Uses in package freemarker.ext.jython

Classes implementing freemarker.template.TemplateModel
class	JythonHashModel Model for Jython dictionaries (`org.python.core.PyDictionary` and `org.python.core.PyStringMap`).
class	JythonModel Generic model for arbitrary Jython objects.
class	JythonNumberModel Model for Jython numeric objects (`org.python.core.PyInteger`, `org.python.core.PyLong`, `org.python.core.PyFloat`).
class	JythonSequenceModel Model for Jython sequence objects (`org.python.core.PySequence` descendants).

Methods with parameter type freemarker.template.TemplateModel
PyObject	JythonWrapper.unwrap(TemplateModel model) Coerces a template model into a `PyObject`.

Methods with return type freemarker.template.TemplateModel
TemplateModel	JythonModel.get(String key) Calls `PyObject.__findattr__(java.lang.String)`, then if it returns null calls `PyObject.__finditem__(java.lang.String)`.
TemplateModel	JythonSequenceModel.get(int index) Returns `PyObject.__finditem__(int)`.
TemplateModel	JythonWrapper.wrap(Object obj) Wraps the passed Jython object into a FreeMarker template model.

Uses in package freemarker.core

Classes implementing freemarker.template.TemplateModel
class	CollectionAndSequence Add sequence capabilities to an existing collection, or vice versa.
class	Environment.Namespace
class	Macro An element representing a macro declaration.
class	StringArraySequence Sequence variable implementation that wraps a String[] with relatively low resource utilization.

Methods with parameter type freemarker.template.TemplateModel
void	Environment.setGlobalVariable(String name, TemplateModel model) Sets a variable that is visible globally.
void	Environment.setLocalVariable(String name, TemplateModel model) Sets a local variable (one effective only during a macro invocation).
void	Environment.setVariable(String name, TemplateModel model) Sets a variable in the current namespace.

Methods with return type freemarker.template.TemplateModel
TemplateModel	CollectionAndSequence.get(int i) Retrieves the i-th template model in this sequence.
TemplateModel	StringArraySequence.get(int index)
TemplateModel	Expression.getAsTemplateModel(Environment env)
TemplateModel	Environment.getGlobalVariable(String name) Returns the globally visible variable of the given name (or null).
TemplateModel	Environment.getLocalVariable(String name) Returns the loop or macro local variable corresponding to this variable name.
TemplateModel	LocalContext.getLocalVariable(String name)
TemplateModel	Environment.getVariable(String name) Returns the variable that is visible in this context.

Uses in package freemarker.ext.servlet

Classes implementing freemarker.template.TemplateModel
class	AllHttpScopesHashModel An extension of SimpleHash that looks up keys in the hash, then in the request, session, and servlet context scopes.
class	HttpRequestHashModel TemplateHashModel wrapper for a HttpServletRequest attributes.
class	HttpRequestParametersHashModel TemplateHashModel wrapper for a HttpServletRequest parameters.
class	HttpSessionHashModel TemplateHashModel wrapper for a HttpSession attributes.
class	ServletContextHashModel TemplateHashModel wrapper for a ServletContext attributes.

Methods with parameter type freemarker.template.TemplateModel
void	FreemarkerServlet.postTemplateProcess(HttpServletRequest request, HttpServletResponse response, Template template, TemplateModel data) Called after the execution returns from template.process().
boolean	FreemarkerServlet.preTemplateProcess(HttpServletRequest request, HttpServletResponse response, Template template, TemplateModel data) Called before the execution is passed to template.process().
void	AllHttpScopesHashModel.putUnlistedModel(String key, TemplateModel model) Stores a model in the hash so that it doesn't show up in `keys()` and `values()` methods.

Methods with return type freemarker.template.TemplateModel
TemplateModel	FreemarkerServlet.createModel(ObjectWrapper wrapper, ServletContext servletContext, HttpServletRequest request, HttpServletResponse response)
TemplateModel	AllHttpScopesHashModel.get(String key)
TemplateModel	HttpRequestHashModel.get(String key)
TemplateModel	HttpRequestParametersHashModel.get(String key)
TemplateModel	HttpSessionHashModel.get(String key)
TemplateModel	ServletContextHashModel.get(String key) Gets a `TemplateModel` from the hash.

Uses in package freemarker.template

Classes implementing freemarker.template.TemplateModel
class	LocalizedString An abstract base class for scalars that vary by locale.
class	ResourceBundleLocalizedString A concrete implementation of `LocalizedString` that gets a localized string from a `java.util.ResourceBundle`
class	SimpleCollection A simple implementation of `TemplateCollectionModel`.
class	SimpleDate A simple implementation of the `TemplateDateModel` interface.
class	SimpleHash A simple implementation of the `TemplateHashModelEx` interface, using an underlying `Map` or `SortedMap`.
class	SimpleList This is a trivial subclass that exists for backward compatibility with the SimpleList from FreeMarker Classic.
class	SimpleNumber A simple implementation of the `TemplateNumberModel` interface.
class	SimpleScalar A simple implementation of the `TemplateScalarModel` interface, using a `String`.
class	SimpleSequence A convenient implementation of a list.
class	TemplateModelListSequence Sequence that wraps a `java.util.List` of already wrapped objects directly, with minimal resource usage.

Fields of type freemarker.template.TemplateModel
TemplateModel	TemplateScalarModel.EMPTY_STRING A constant value to use as the empty string.
TemplateModel	TemplateModel.NOTHING A general-purpose object to represent nothing.

Methods with parameter type freemarker.template.TemplateModel
void	Configuration.setSharedVariable(String name, TemplateModel tm) Adds a shared variable to the configuration.

Methods with return type freemarker.template.TemplateModel
TemplateModel	SimpleHash.get(String key)
TemplateModel	TemplateHashModel.get(String key) Gets a `TemplateModel` from the hash.
TemplateModel	SimpleSequence.get(int i)
TemplateModel	TemplateModelListSequence.get(int index) Retrieves the i-th template model in this sequence.
TemplateModel	TemplateSequenceModel.get(int index) Retrieves the i-th template model in this sequence.
TemplateModel	Configuration.getSharedVariable(String name) Gets a shared variable.
TemplateModel	TemplateModelAdapter.getTemplateModel()
TemplateModel	DefaultObjectWrapper.handleUnknownType(Object obj) Called if an unknown type is passed in.
TemplateModel	SimpleObjectWrapper.handleUnknownType(Object obj) Called if a type other than the simple ones we know about is passed in.
TemplateModel	TemplateModelIterator.next() Returns the next model.
TemplateModel	DefaultObjectWrapper.wrap(Object obj)
TemplateModel	ObjectWrapper.wrap(Object obj)
TemplateModel	WrappingTemplateModel.wrap(Object obj) Wraps the passed object into a template model using this object's object wrapper.
TemplateModel	DefaultObjectWrapper.wrapDomNode(Object obj)

Uses in package freemarker.ext.jsp

Classes implementing freemarker.template.TemplateModel
class	TaglibFactory A hash model associated with a servlet context that can load JSP tag libraries associated with that servlet context.

Methods with return type freemarker.template.TemplateModel
TemplateModel	TaglibFactory.get(String uri) Retrieves a JSP tag library identified by an URI.

Uses in package freemarker.ext.util

Methods with return type freemarker.template.TemplateModel
TemplateModel	ModelFactory.create(Object object, ObjectWrapper wrapper) Create a wrapping model for the specified object that belongs to the specified wrapper.
TemplateModel	ModelCache.getInstance(Object object, ModelFactory factory)

Uses in package freemarker.ext.beans

Classes implementing freemarker.template.TemplateModel
class	ArrayModel A class that will wrap an arbitrary array into `TemplateCollectionModel` and `TemplateSequenceModel` interfaces.
class	BeanModel A class that will wrap an arbitrary object into `TemplateHashModel` interface allowing calls to arbitrary property getters and invocation of accessible methods on the object from a template using the `object.foo` to access properties and `object.bar(arg1, arg2)` to invoke methods on it.
class	BooleanModel A class that will wrap instances of `java.lang.Boolean` into a `TemplateBooleanModel`.
class	CollectionModel A special case of `BeanModel` that can wrap Java collections and that implements the `TemplateCollectionModel` in order to be usable in a `<foreach>` block.
class	DateModel Wraps arbitrary subclass of `java.util.Date` into a reflective model.
class	EnumerationModel A class that adds `TemplateModelIterator` functionality to the `Enumeration` interface implementers.
class	IteratorModel A class that adds `TemplateModelIterator` functionality to the `Iterator` interface implementers.
class	MapModel A special case of `BeanModel` that adds implementation for `TemplateMethodModelEx` on map objects that is a shortcut for the `Map.get()` method.
class	NumberModel Wraps arbitrary subclass of `java.lang.Number` into a reflective model.
class	ResourceBundleModel A hash model that wraps a resource bundle.
class	SimpleMapModel Model used by `BeansWrapper` when `simpleMapWrapper` mode is enabled.
class	StringModel Subclass of `BeanModel` that exposes the return value of the `java.lang.Object.toString()` method through the `TemplateScalarModel` interface.

Methods with parameter type freemarker.template.TemplateModel
void	BeansWrapper.setNullModel(TemplateModel nullModel) Sets the null model.
Object	BeanModel.unwrap(TemplateModel model)
Object	BeansWrapper.unwrap(TemplateModel model) Attempts to unwrap a model into underlying object.
Object	BeansWrapper.unwrap(TemplateModel model, Class hint)

Methods with return type freemarker.template.TemplateModel
TemplateModel	BeansWrapper.create(Object object, Object factory)
TemplateModel	BeanModel.get(String key) Uses Beans introspection to locate a property or method with name matching the key name.
TemplateModel	SimpleMapModel.get(String key)
TemplateModel	ArrayModel.get(int index)
TemplateModel	CollectionModel.get(int index) Retrieves the i-th object from the collection, wrapped as a TemplateModel.
TemplateModel	BeansWrapper.getInstance(Object object, ModelFactory factory)
TemplateModel	HashAdapter.getTemplateModel()
TemplateModel	BeanModel.invokeGenericGet(Map keyMap, Class clazz, String key)
TemplateModel	MapModel.invokeGenericGet(Map keyMap, Class clazz, String key) Overridden to invoke the generic get method by casting to Map instead of through reflection - should yield better performance.
TemplateModel	ResourceBundleModel.invokeGenericGet(Map keyMap, Class clazz, String key) Overridden to invoke the getObject method of the resource bundle.
TemplateModel	EnumerationModel.next() Calls underlying `Enumeration.nextElement()` and wraps the result.
TemplateModel	IteratorModel.next() Calls underlying `Iterator.next()` and wraps the result.
TemplateModel	BeanModel.wrap(Object obj)
TemplateModel	BeansWrapper.wrap(Object object) Wraps the object with a template model that is most specific for the object's class.