A C D F G H I K L M N P R S V W

A

AbstractDelegatingTemplateLoader - Class in info.magnolia.freemarker.loaders

An abstract TemplateLoader that will attempt to initialize its delegate TemplateLoader and use a null object implementation until it succeeds.

AbstractDelegatingTemplateLoader() - Constructor for class info.magnolia.freemarker.loaders.AbstractDelegatingTemplateLoader

addDefaultData(Map<String, Object>, Locale, String) - Method in class info.magnolia.freemarker.FreemarkerHelper

addTaglibSupportData(Map<String, Object>, WebContext) - Method in class info.magnolia.freemarker.FreemarkerHelper

C

checkLocale(Locale) - Method in class info.magnolia.freemarker.FreemarkerHelper

Returns the passed Locale if non-null, otherwise attempts to get the Locale from the current context.

checkServletContextModel(ServletContext) - Method in class info.magnolia.freemarker.FreemarkerHelper

checkTaglibFactory(ServletContext) - Method in class info.magnolia.freemarker.FreemarkerHelper

closeTemplateSource(Object) - Method in class info.magnolia.freemarker.loaders.AbstractDelegatingTemplateLoader

closeTemplateSource(Object) - Method in class info.magnolia.freemarker.loaders.ResourceTemplateLoader

ContentMapModel - Class in info.magnolia.freemarker.models

A wrapper for Content nodes.

create(Object, ObjectWrapper) - Method in interface info.magnolia.freemarker.models.MagnoliaModelFactory

If possible, our models should instantiate models which implement AdapterTemplateModel, so they can be unwrapped easily.

createTemplateName(Class<?>, String) - Static method in class info.magnolia.freemarker.FreemarkerUtil

Deprecated.

Creates a template name based on the class name and adds the extension.

createTemplateName(Class<?>, String, String) - Static method in class info.magnolia.freemarker.FreemarkerUtil

Deprecated.

Same as FreemarkerUtil.createTemplateName(Class, String) but adds the classifier between the template name and the extension.

D

DoNothingServlet - Class in info.magnolia.freemarker

Dummy servlet used to satisfy all freemarker dependencies at runtime.

F

factoryFor() - Method in interface info.magnolia.freemarker.models.MagnoliaModelFactory

Returns the Class this ModelFactory is able to create Model instances for.

findTemplateSource(String) - Method in class info.magnolia.freemarker.loaders.AbstractDelegatingTemplateLoader

findTemplateSource(String) - Method in class info.magnolia.freemarker.loaders.ResourceTemplateLoader

FreemarkerConfig - Class in info.magnolia.freemarker

Observed bean holding Freemarker configuration.

FreemarkerConfig() - Constructor for class info.magnolia.freemarker.FreemarkerConfig

FreemarkerHelper - Class in info.magnolia.freemarker

A generic helper to render Content instances with Freemarker templates.

FreemarkerHelper(FreemarkerConfig, TranslationService, MagnoliaConfigurationProperties) - Constructor for class info.magnolia.freemarker.FreemarkerHelper

FreemarkerHelper(FreemarkerConfig, TranslationService) - Constructor for class info.magnolia.freemarker.FreemarkerHelper

Deprecated.

since 5.4.8. Please use FreemarkerHelper.FreemarkerHelper(FreemarkerConfig, TranslationService, MagnoliaConfigurationProperties) instead.

FreemarkerHelper(FreemarkerConfig) - Constructor for class info.magnolia.freemarker.FreemarkerHelper

Deprecated.

since 5.4.4. Use FreemarkerHelper.FreemarkerHelper(FreemarkerConfig, TranslationService, MagnoliaConfigurationProperties) instead.

FreemarkerServletContextWrapper - Class in info.magnolia.freemarker

Wraps the servlet context especially for freemarker taglib resolution.

FreemarkerServletContextWrapper(ServletContext) - Constructor for class info.magnolia.freemarker.FreemarkerServletContextWrapper

FreemarkerSupportModuleVersionHandler - Class in info.magnolia.freemarker.setup

ModuleVersionHandler for the Freemarker support module.

FreemarkerSupportModuleVersionHandler() - Constructor for class info.magnolia.freemarker.setup.FreemarkerSupportModuleVersionHandler

FreemarkerUtil - Class in info.magnolia.freemarker

Deprecated.

since 5.4 - just use FreemarkerHelper.

FreemarkerUtil() - Constructor for class info.magnolia.freemarker.FreemarkerUtil

Deprecated.

G

get(String) - Method in class info.magnolia.freemarker.MessagesWrapper

We still use the deprecated method TranslationService.translate(info.magnolia.i18nsystem.LocaleProvider, String, String[]) due to compatibility with obsolete i18nBasename, the method TranslationService.translate(info.magnolia.i18nsystem.LocaleProvider, String[]) calls this method internally anyway.

get(String, List) - Method in class info.magnolia.freemarker.MessagesWrapper

get(String, String) - Method in class info.magnolia.freemarker.MessagesWrapper

Deprecated.

since 5.4.4. Use MessagesWrapper.get(String) instead.

get(String, List, String) - Method in class info.magnolia.freemarker.MessagesWrapper

Deprecated.

since 5.4.4. Use MessagesWrapper.get(String, java.util.List) instead.

get(String, Messages) - Method in class info.magnolia.freemarker.MessagesWrapper

Deprecated.

since 5.4.4. Use MessagesWrapper.get(String) instead.

get(String, List, Messages) - Method in class info.magnolia.freemarker.MessagesWrapper

Deprecated.

since 5.4.4. Use MessagesWrapper.get(String, java.util.List) instead.

get(String) - Method in class info.magnolia.freemarker.models.ContentMapModel

getAdaptedObject(Class) - Method in class info.magnolia.freemarker.models.ContentMapModel

getAsString() - Method in class info.magnolia.freemarker.models.ContentMapModel

getBasePath() - Method in class info.magnolia.freemarker.loaders.LazyFileTemplateLoader

getBasicInstallTasks(InstallContext) - Method in class info.magnolia.freemarker.setup.FreemarkerSupportModuleVersionHandler

getChildNodes() - Method in class info.magnolia.freemarker.models.ContentMapModel

This returns all children, except nodes or jcr: types and mgnl:metaData.

getConfiguration() - Method in class info.magnolia.freemarker.FreemarkerHelper

getDelegate() - Method in class info.magnolia.freemarker.loaders.AbstractDelegatingTemplateLoader

First attempts to initialize a new delegate if needed.

getInstance() - Static method in class info.magnolia.freemarker.FreemarkerHelper

Deprecated.

since 4.5, use IoC !

getJCRNode() - Method in class info.magnolia.freemarker.models.ContentMapModel

getLastModified(Object) - Method in class info.magnolia.freemarker.loaders.AbstractDelegatingTemplateLoader

getLastModified(Object) - Method in class info.magnolia.freemarker.loaders.ResourceTemplateLoader

getModelFactories() - Method in class info.magnolia.freemarker.FreemarkerConfig

getModelFactory(Class) - Method in class info.magnolia.freemarker.models.MagnoliaObjectWrapper

Checks the ModelFactory instances registered in FreemarkerConfig, then the default ones.

getNodeName() - Method in class info.magnolia.freemarker.models.ContentMapModel

getNodeNamespace() - Method in class info.magnolia.freemarker.models.ContentMapModel

getNodeType() - Method in class info.magnolia.freemarker.models.ContentMapModel

getObjectWrapper() - Method in class info.magnolia.freemarker.FreemarkerConfig

getParentNode() - Method in class info.magnolia.freemarker.models.ContentMapModel

getReader(Object, String) - Method in class info.magnolia.freemarker.loaders.AbstractDelegatingTemplateLoader

getReader(Object, String) - Method in class info.magnolia.freemarker.loaders.ResourceTemplateLoader

getResource(String) - Method in class info.magnolia.freemarker.FreemarkerServletContextWrapper

getResourceAsStream(String) - Method in class info.magnolia.freemarker.FreemarkerServletContextWrapper

getResourcePaths(String) - Method in class info.magnolia.freemarker.FreemarkerServletContextWrapper

getSharedVariables() - Method in class info.magnolia.freemarker.FreemarkerConfig

getTemplateExceptionHandler() - Method in class info.magnolia.freemarker.FreemarkerConfig

getTemplateLoader() - Method in class info.magnolia.freemarker.FreemarkerConfig

getTemplateLoaders() - Method in class info.magnolia.freemarker.FreemarkerConfig

getWithDefault(String, String) - Method in class info.magnolia.freemarker.MessagesWrapper

Deprecated.

since 5.4.4. Use MessagesWrapper.get(String, java.util.List) instead.

getWithDefault(String, String, String) - Method in class info.magnolia.freemarker.MessagesWrapper

Deprecated.

since 5.4.4. Use MessagesWrapper.get(String, java.util.List) instead.

getWithDefault(String, List, String) - Method in class info.magnolia.freemarker.MessagesWrapper

Deprecated.

since 5.4.4. Use MessagesWrapper.get(String, java.util.List) instead.

getWithDefault(String, List, String, String) - Method in class info.magnolia.freemarker.MessagesWrapper

Deprecated.

since 5.4.4. Use MessagesWrapper.get(String, java.util.List) instead.

getWithDefault(String, String, Messages) - Method in class info.magnolia.freemarker.MessagesWrapper

Deprecated.

since 5.4.4. Use MessagesWrapper.get(String, java.util.List) instead.

getWithDefault(String, List, String, Messages) - Method in class info.magnolia.freemarker.MessagesWrapper

Deprecated.

since 5.4.4. Use MessagesWrapper.get(String, java.util.List) instead.

H

handleTemplateException(TemplateException, Environment, Writer) - Method in class info.magnolia.freemarker.ModeDependentTemplateExceptionHandler

I

inEditMode(TemplateException, Environment, Writer) - Method in class info.magnolia.freemarker.ModeDependentTemplateExceptionHandler

info.magnolia.freemarker - package info.magnolia.freemarker

info.magnolia.freemarker.loaders - package info.magnolia.freemarker.loaders

info.magnolia.freemarker.models - package info.magnolia.freemarker.models

info.magnolia.freemarker.setup - package info.magnolia.freemarker.setup

inPublicMode(TemplateException, Environment, Writer) - Method in class info.magnolia.freemarker.ModeDependentTemplateExceptionHandler

isAllowLinking() - Method in class info.magnolia.freemarker.loaders.LazyFileTemplateLoader

isEmpty() - Method in class info.magnolia.freemarker.models.ContentMapModel

isEscapeHtml() - Method in class info.magnolia.freemarker.FreemarkerHelper

K

keys() - Method in class info.magnolia.freemarker.models.ContentMapModel

L

LazyFileTemplateLoader - Class in info.magnolia.freemarker.loaders

A TemplateLoader wrapping freemarker's FileTemplateLoader, initializing it lazily, thus allowing setting its parameters with content2bean.

LazyFileTemplateLoader() - Constructor for class info.magnolia.freemarker.loaders.LazyFileTemplateLoader

LazyWebappTemplateLoader - Class in info.magnolia.freemarker.loaders

Wrapper for Freemarker WebappTemplateLoader to allow configuration of the loader via content2bean with lazy initialization at runtime (as soon as a ServletContext is available).

LazyWebappTemplateLoader() - Constructor for class info.magnolia.freemarker.loaders.LazyWebappTemplateLoader

M

MagnoliaModelFactory - Interface in info.magnolia.freemarker.models

A specialization of Freemarker's ModelFactory, which knows which class its handling.

MagnoliaObjectWrapper - Class in info.magnolia.freemarker.models

A FreeMarker ObjectWrapper that knows about Magnolia specific objects.

MagnoliaObjectWrapper(FreemarkerConfig) - Constructor for class info.magnolia.freemarker.models.MagnoliaObjectWrapper

MessagesWrapper - Class in info.magnolia.freemarker

Utility class that has methods which allow passing multiple parameters from a freemarker template to a message string using the square bracket syntax (e.g.

ModeDependentTemplateExceptionHandler - Class in info.magnolia.freemarker

Exception handler providing different output based on the configuration of the current instance.

ModeDependentTemplateExceptionHandler() - Constructor for class info.magnolia.freemarker.ModeDependentTemplateExceptionHandler

N

newDelegate() - Method in class info.magnolia.freemarker.loaders.AbstractDelegatingTemplateLoader

Implementations should return null if it is too early to instantiate the delegate.

newDelegate() - Method in class info.magnolia.freemarker.loaders.LazyFileTemplateLoader

newDelegate() - Method in class info.magnolia.freemarker.loaders.LazyWebappTemplateLoader

newObjectWrapper() - Method in class info.magnolia.freemarker.FreemarkerConfig

P

prepareRendering(Locale, String, Object) - Method in class info.magnolia.freemarker.FreemarkerHelper

Call checkLocale() before calling this method, to ensure it is not null.

process(Object) - Static method in class info.magnolia.freemarker.FreemarkerUtil

Deprecated.

Uses the class of the object to create the templates name, passes the object under the name 'this' and returns the result in a String.

process(Object, Writer) - Static method in class info.magnolia.freemarker.FreemarkerUtil

Deprecated.

process(Object, String, String) - Static method in class info.magnolia.freemarker.FreemarkerUtil

Deprecated.

Same as FreemarkerUtil.process(Object) but adds the classifier and the extension to the template name.

process(Object, String, String, Writer) - Static method in class info.magnolia.freemarker.FreemarkerUtil

Deprecated.

process(Class<?>, Object) - Static method in class info.magnolia.freemarker.FreemarkerUtil

Deprecated.

Uses the class to create the templates name and passes the object under the name 'this'.

process(Class<?>, Object, Writer) - Static method in class info.magnolia.freemarker.FreemarkerUtil

Deprecated.

process(String, Map<String, Object>) - Static method in class info.magnolia.freemarker.FreemarkerUtil

Deprecated.

Process this template with the passed data and returns the result in a String.

process(String, Map<String, Object>, Writer) - Static method in class info.magnolia.freemarker.FreemarkerUtil

Deprecated.

Process the template with the data and writes the result to the writer.

R

render(String, Object, Writer) - Method in class info.magnolia.freemarker.FreemarkerHelper

render(String, Locale, String, Object, Writer) - Method in class info.magnolia.freemarker.FreemarkerHelper

Renders the given template, using the given root object (can be a map, or any other type of object handled by MagnoliaContentWrapper) to the given Writer.

render(Reader, Object, Writer) - Method in class info.magnolia.freemarker.FreemarkerHelper

Renders the template read by the given Reader instance.

render(Reader, Locale, String, Object, Writer) - Method in class info.magnolia.freemarker.FreemarkerHelper

ResourceTemplateLoader - Class in info.magnolia.freemarker.loaders

A FreeMarker TemplateLoader which loads templates using the ResourceOrigin API.

ResourceTemplateLoader(ResourceOrigin) - Constructor for class info.magnolia.freemarker.loaders.ResourceTemplateLoader

S

service(ServletRequest, ServletResponse) - Method in class info.magnolia.freemarker.DoNothingServlet

setAllowLinking(boolean) - Method in class info.magnolia.freemarker.loaders.LazyFileTemplateLoader

setBasePath(String) - Method in class info.magnolia.freemarker.loaders.LazyFileTemplateLoader

setEscapeHtml(boolean) - Method in class info.magnolia.freemarker.FreemarkerHelper

setModelFactories(List<MagnoliaModelFactory>) - Method in class info.magnolia.freemarker.FreemarkerConfig

setSharedVariables(Map<String, Object>) - Method in class info.magnolia.freemarker.FreemarkerConfig

setTemplateExceptionHandler(TemplateExceptionHandler) - Method in class info.magnolia.freemarker.FreemarkerConfig

setTemplateLoaders(List<TemplateLoader>) - Method in class info.magnolia.freemarker.FreemarkerConfig

size() - Method in class info.magnolia.freemarker.models.ContentMapModel

V

values() - Method in class info.magnolia.freemarker.models.ContentMapModel

W

wrap(Object) - Method in class info.magnolia.freemarker.models.MagnoliaObjectWrapper

A C D F G H I K L M N P R S V W