TemplatingFunctions (Magnolia Main Project (Parent) 5.5 API)

java.lang.Object
- info.magnolia.templating.functions.TemplatingFunctions

```
public class TemplatingFunctions
extends Object
```
An object exposing several methods useful for templates. It is exposed in templates as cmsfn.

Constructor Summary

Constructors
Constructor and Description
`TemplatingFunctions(javax.inject.Provider<AggregationState> aggregationStateProvider)` Deprecated. since 5.4 - use `TemplatingFunctions(Provider, info.magnolia.rendering.template.type.TemplateTypeHelper)` instead.
`TemplatingFunctions(javax.inject.Provider<AggregationState> aggregationStateProvider, TemplateTypeHelper templateTypeFunctions)` Deprecated. since 5.4.1 - use `TemplatingFunctions(Provider, TemplateTypeHelper, Provider)` instead.
`TemplatingFunctions(javax.inject.Provider<AggregationState> aggregationStateProvider, TemplateTypeHelper templateTypeFunctions, javax.inject.Provider<I18nContentSupport> i18nContentSupport)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`abbreviateString(String stringToAbbreviate, int length)` Shortens a `String` to provided length and adds suffix " `...`
`String`	`abbreviateString(String stringToAbbreviate, int length, String suffix)` Shortens a `String` to provided length and adds a custom suffix.
`List<ContentMap>`	`ancestors(ContentMap contentMap)` See `ancestors(Node)` for details.
`List<ContentMap>`	`ancestors(ContentMap contentMap, String nodeTypeName)` See `ancestors(Node, String)` for details.
`List<javax.jcr.Node>`	`ancestors(javax.jcr.Node content)` Return a list of ancestors of the provided node.
`List<javax.jcr.Node>`	`ancestors(javax.jcr.Node content, String nodeTypeName)` Return a list of ancestors of the provided node which have the provided nodeType.
`ContentMap`	`asContentMap(javax.jcr.Node content)` Return the equivalent contentMap for the provided node object.
`List<ContentMap>`	`asContentMapList(Collection<javax.jcr.Node> nodeList)` Returns a List of `ContentMap` objects for the provided collection of `Node` objects.
`protected List<ContentMap>`	`asContentMapList(Iterable<javax.jcr.Node> nodes)`
`javax.jcr.Node`	`asJCRNode(ContentMap contentMap)` Return the equivalent jcr node object for the provided contentMap.
`List<javax.jcr.Node>`	`asNodeList(Collection<ContentMap> contentMapList)` Returns a List of `Node` objects for the provided collection of `ContentMap` objects.
`protected List<javax.jcr.Node>`	`asNodeList(Iterable<javax.jcr.Node> nodes)`
`List<ContentMap>`	`children(ContentMap content)` Returns the child nodes of the provided contentMap - as a list of ContentMaps.
`List<ContentMap>`	`children(ContentMap content, String nodeTypeName)` Returns the child nodes of the the provided contentMap of a specific nodeType - as a list of ContentMaps.
`List<javax.jcr.Node>`	`children(javax.jcr.Node content)` Returns the child nodes of the provided node.
`List<javax.jcr.Node>`	`children(javax.jcr.Node content, String nodeTypeName)` Returns the child nodes of the provided node of a specific nodeType.
`javax.jcr.Node`	`content(String path)` Deprecated. since 5.3.3 use `contentByPath(String)` or `nodeByPath(String)` instead
`javax.jcr.Node`	`content(String repository, String path)` Deprecated. since 5.3.3 use `contentByPath(String, String)` or `nodeByPath(String, String)` instead
`ContentMap`	`contentById(String id)` Return the ContentMap by the given identifier from the website repository.
`ContentMap`	`contentById(String id, String workspace)` Return the ContentMap by the given identifier from the given repository.
`javax.jcr.Node`	`contentByIdentifier(String id)` Deprecated. since 5.3.3 use `contentById(String)` or {@link #nodeById(String) instead
`javax.jcr.Node`	`contentByIdentifier(String repository, String id)` Deprecated. since 5.3.3 use `contentById(String, String)` or `contentByPath(String, String)` instead
`ContentMap`	`contentByPath(String path)` Return the ContentMap for the given path from the website repository.
`ContentMap`	`contentByPath(String path, String workspace)` Return the ContentMap for the given path from the given repository.
`ContentMap`	`contentByReference(ContentMap content, String idPropertyName, String referencedWorkspace)` See `contentByReference(Node, String, String)` for details.
`javax.jcr.Node`	`contentByReference(javax.jcr.Node content, String idPropertyName, String referencedWorkspace)` Returns a `Node` object which is referenced by its id, stored in the @param propertyName.
`List<javax.jcr.Node>`	`contentListByTemplateId(javax.jcr.Node searchRoot, String templateId)` See `contentListByTemplateId(Node, String, int, String, String)` for details.
`List<javax.jcr.Node>`	`contentListByTemplateId(javax.jcr.Node searchRoot, String templateId, int maxResultSize, String andClause, String orderByClause)` Find content objects with the given template ID below a given search root.
`List<ContentMap>`	`contentListByTemplateIds(ContentMap searchRoot, Set<String> templateIds, int maxResultSize, String andClause, String orderByClause)` See `contentListByTemplateIds(Node, Set, int, String, String)` for details.
`List<javax.jcr.Node>`	`contentListByTemplateIds(javax.jcr.Node searchRoot, Set<String> templateIds, int maxResultSize, String andClause, String orderByClause)` Find content objects with one of the given template IDs below a given search root.
`List<ContentMap>`	`contentListByTemplateType(ContentMap siteRoot, String templateType, String templateSubtype)` See `contentListByTemplateType(Node, String, String, int, String, String)` for details.
`List<ContentMap>`	`contentListByTemplateType(ContentMap searchRoot, String templateType, String templateSubtype, int maxResultSize, String andClause, String orderByClause)` See `contentListByTemplateType(Node, String, String, int, String, String)` for details.
`List<javax.jcr.Node>`	`contentListByTemplateType(javax.jcr.Node siteRoot, String templateType, String templateSubtype)` See `contentListByTemplateType(Node, String, String, int, String, String)` for details.
`List<javax.jcr.Node>`	`contentListByTemplateType(javax.jcr.Node searchRoot, String templateType, String templateSubtype, int maxResultSize, String andClause, String orderByClause)` Find content objects with the given template type (and optionally subtype) below given search root.
`String`	`createHtmlAttribute(String name, String value)` Util method to create html attributes `name="value"`.
`ContentMap`	`decode(ContentMap content)` Removes escaping of HTML on properties.
`javax.jcr.Node`	`decode(javax.jcr.Node content)` Removes escaping of HTML on properties.
`ContentMap`	`encode(ContentMap content)` Adds escaping of HTML on properties as well as changing line breaks into <br/> tags.
`javax.jcr.Node`	`encode(javax.jcr.Node content)` Adds escaping of HTML on properties as well as changing line breaks into <br/> tags.
`String`	`externalLink(ContentMap content, String linkPropertyName)` Returns an external link prepended with `http://` in case the protocol is missing or an empty String if the link does not exist.
`String`	`externalLink(javax.jcr.Node content, String linkPropertyName)` Returns an external link prepended with `http://` in case the protocol is missing or an empty String if the link does not exist.
`String`	`externalLinkTitle(ContentMap content, String linkPropertyName, String linkTitlePropertyName)` Return a link title based on the @param linkTitlePropertyName.
`String`	`externalLinkTitle(javax.jcr.Node content, String linkPropertyName, String linkTitlePropertyName)` Return a link title based on the @param linkTitlePropertyName.
`String`	`fileExtension(String fileName)` Returns the file extension of a filename by returning the suffix after the last `.`
`String`	`getQueryStringAndFragment(String url)` Deprecated. since 5.3.8 - use {@link #queryStringAndFragment(String) instead.
`boolean`	`hasTemplateOfType(ContentMap page, String templateType)` See `hasTemplateOfType(Node, String)` for details.
`boolean`	`hasTemplateOfType(javax.jcr.Node pageNode, String templateType)` Checks whether the given page-`Node` has the specified `templateType`.
`ContentMap`	`inherit(ContentMap content)` See `inherit(Node)` for details.
`ContentMap`	`inherit(ContentMap content, String relPath)` See `inherit(Node, String)` for details.
`ContentMap`	`inherit(ContentMap content, String relPath, String nodeTypes, String nodeInheritance, String propertyInheritance)` See `inherit(Node, String, String, String, String)` for details.
`javax.jcr.Node`	`inherit(javax.jcr.Node content)` Wraps the provided node with an inheritance wrapper so that the node appears to contain the components and/or properties that exist in the equivalent nodes of the ancestors of the provided node's "anchor".
`javax.jcr.Node`	`inherit(javax.jcr.Node content, String relPath)` Wraps the provided node with an inheritance wrapper so that the node appears to contain the components and/or properties that exist in the equivalent nodes of the ancestors of the provided node's "anchor".
`javax.jcr.Node`	`inherit(javax.jcr.Node content, String relPath, String nodeTypes, String nodeInheritance, String propertyInheritance)` Wraps the provided node with an inheritance wrapper so that the node appears to contain the components and/or properties that exist in the equivalent nodes of the ancestors of the provided node's "anchor" (The anchor is the first parent of type mgnl:content - typically the page node of the provided node).
`List<ContentMap>`	`inheritList(ContentMap content, String relPath)` Returns the children of the wrapped-for-inheritance subnode obtained as in `inherit(Node, String)`.
`List<javax.jcr.Node>`	`inheritList(javax.jcr.Node content, String relPath)` Returns the children of the wrapped-for-inheritance subnode obtained as in `inherit(Node, String)`.
`javax.jcr.Property`	`inheritProperty(ContentMap content, String relPath)` See `inheritProperty(Node, String)` for details.
`javax.jcr.Property`	`inheritProperty(javax.jcr.Node content, String relPath)` Returns the inherited property of the node, subject to the standard rules of inheritance.
`boolean`	`isAuthorInstance()` Returns whether the request is from an author instance.
`boolean`	`isCurrentLocale(String language)` Checks if given language is current locale (set in `AggregationState`).
`boolean`	`isEditMode()` Returns whether the request is from the Page editor edit mode.
`boolean`	`isFromCurrentPage(ContentMap content)` See `isFromCurrentPage(Node)` for details.
`boolean`	`isFromCurrentPage(javax.jcr.Node content)` Returns whether the content is an actual child of the current page - i.e. that it was not inherited from another page (or node).
`boolean`	`isInherited(ContentMap content)` See `isInherited(Node)` for details.
`boolean`	`isInherited(javax.jcr.Node content)` Returns whether the content is inherited from another node.
`boolean`	`isPreviewMode()` Returns whether the request is from the Page editor preview mode.
`boolean`	`isPublicInstance()` Returns whether the request is from a public instance.
`String`	`language()` Get the language used currently.
`String`	`link(ContentMap contentMap)` See `link(Node)` for details.
`String`	`link(javax.jcr.Node content)` Returns a url for the provided node.
`String`	`link(javax.jcr.Property property)` Deprecated. since 4.5.4. There is no valid use case for this method.
`String`	`link(String workspace, String nodeIdentifier)` Returns a url for Node identified by nodeIdentifier in the specified workspace.
`String`	`linkPrefix(ContentMap content)` See `linkPrefix(Node)` for details.
`String`	`linkPrefix(javax.jcr.Node content)`
`Map<String,String>`	`localizedLinks()` Creates a link of current URI to given language.
`Map<String,String>`	`localizedLinks(javax.jcr.Node content)` Creates a map of localized links to the node for all supported languages.
`String`	`metaData(ContentMap content, String property)` See `metaData(Node, String)` for details.
`String`	`metaData(javax.jcr.Node content, String property)` Returns the string representation of a property from the metaData of the node or `null` if the node has no Magnolia metaData or if no matching property is found.
`javax.jcr.Node`	`nodeById(String id)` Return the Node by the given identifier from the website repository.
`javax.jcr.Node`	`nodeById(String id, String workspace)` Return the Node by the given identifier from the given repository.
`javax.jcr.Node`	`nodeByPath(String path)` Return the Node for the given path from the website repository.
`javax.jcr.Node`	`nodeByPath(String path, String workspace)` Return the Node for the given path from the given repository.
`ContentMap`	`page(ContentMap content)` Returns the page's `ContentMap` of the passed `ContentMap`.
`javax.jcr.Node`	`page(javax.jcr.Node content)` Returns the page `Node` of the passed node.
`ContentMap`	`parent(ContentMap contentMap)` See `parent(Node)` for details.
`ContentMap`	`parent(ContentMap contentMap, String nodeTypeName)` See `parent(Node, String)` for details.
`javax.jcr.Node`	`parent(javax.jcr.Node content)` Returns the direct parent of the node.
`javax.jcr.Node`	`parent(javax.jcr.Node content, String nodeTypeName)` Returns the closest ancestor of the provided node which is of the specified nodeType.
`ContentMap`	`parentWithTemplateType(ContentMap page, String templateType)` See `parentWithTemplateType(Node, String)`.
`javax.jcr.Node`	`parentWithTemplateType(javax.jcr.Node pageNode, String templateType)` Finds a parent `Node` of given `Node` with the specified `templateType`.
`String`	`queryStringAndFragment(String url)` Returns the querystring and fragment of a url, or an empty string if there are none.
`String`	`readableFileSize(long sizeBytes)` Returns a human friendly string for a file size.
`ContentMap`	`root(ContentMap contentMap)` See `root(Node)` for details.
`ContentMap`	`root(ContentMap contentMap, String nodeTypeName)` See `root(Node, String)` for details.
`javax.jcr.Node`	`root(javax.jcr.Node content)` Returns the root node of the workspace to which the provided node belongs.
`javax.jcr.Node`	`root(javax.jcr.Node content, String nodeTypeName)` Returns the oldest ancestor node of the provided node which has the specified nodeType.
`Collection<javax.jcr.Node>`	`search(String workspace, String statement, String language, String returnItemType)` Deprecated. since 5.4 - use `SearchTemplatingFunctions#searchContent(String, String, String, String, long, long)` from `info.magnolia.templating:magnolia-templating-essentials-models` instead.
`SiblingsHelper`	`siblings(ContentMap node)`
`SiblingsHelper`	`siblings(javax.jcr.Node node)` Returns an instance of SiblingsHelper for the given node.
`Collection<javax.jcr.Node>`	`simpleSearch(String workspace, String statement, String returnItemType, String startPath)` Deprecated. since 5.4 - use `SearchTemplatingFunctions#searchContent(String, String, String, String, long, long)` from `info.magnolia.templating:magnolia-templating-essentials-models` instead.
`ContentMap`	`siteRoot(ContentMap content)` See `siteRoot(Node)` for details..
`ContentMap`	`siteRoot(ContentMap content, String siteRootTemplateType)` See `siteRoot(Node, String)` for details.
`javax.jcr.Node`	`siteRoot(javax.jcr.Node content)` Returns the site's root of the `Node`.
`javax.jcr.Node`	`siteRoot(javax.jcr.Node content, String siteRootTemplateType)` Returns the site's root of the passed `Node`.
`String`	`templateSubtype(ContentMap page)` See `templateSubtype(Node)` for details.
`String`	`templateSubtype(javax.jcr.Node pageNode)` Returns the subtype of the template assigned to a node.
`String`	`templateType(ContentMap page)` See `templateType(Node)`.
`String`	`templateType(javax.jcr.Node pageNode)` Returns the type of the template assigned to a node.
`javax.jcr.Node`	`wrapForI18n(javax.jcr.Node content)` Wraps content into `I18nNodeWrapper` so properties are in visitor's language.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TemplatingFunctions
```
@Inject
public TemplatingFunctions(javax.inject.Provider<AggregationState> aggregationStateProvider,
                                   TemplateTypeHelper templateTypeFunctions,
                                   javax.inject.Provider<I18nContentSupport> i18nContentSupport)
```
  - TemplatingFunctions
```
@Deprecated
public TemplatingFunctions(javax.inject.Provider<AggregationState> aggregationStateProvider,
                                       TemplateTypeHelper templateTypeFunctions)
```
    Deprecated. since 5.4.1 - use TemplatingFunctions(Provider, TemplateTypeHelper, Provider) instead.
  - TemplatingFunctions
```
@Deprecated
public TemplatingFunctions(javax.inject.Provider<AggregationState> aggregationStateProvider)
```
    Deprecated. since 5.4 - use TemplatingFunctions(Provider, info.magnolia.rendering.template.type.TemplateTypeHelper) instead.
- Method Detail
  - asJCRNode
```
public javax.jcr.Node asJCRNode(ContentMap contentMap)
```
    Return the equivalent jcr node object for the provided contentMap. Useful for converting an object for use in methods that expect a node.
  - asContentMap
```
public ContentMap asContentMap(javax.jcr.Node content)
```
    Return the equivalent contentMap for the provided node object. Useful for converting a node for use in templates - or for methods that expect a contentMap.
  - children
```
public List<javax.jcr.Node> children(javax.jcr.Node content)
                              throws javax.jcr.RepositoryException
```
    Returns the child nodes of the provided node.
    
    Throws:
    
    javax.jcr.RepositoryException
  - children
```
public List<javax.jcr.Node> children(javax.jcr.Node content,
                                     String nodeTypeName)
                              throws javax.jcr.RepositoryException
```
    Returns the child nodes of the provided node of a specific nodeType.
    
    Throws:
    
    javax.jcr.RepositoryException
  - children
```
public List<ContentMap> children(ContentMap content)
                          throws javax.jcr.RepositoryException
```
    Returns the child nodes of the provided contentMap - as a list of ContentMaps.
    
    Throws:
    
    javax.jcr.RepositoryException
  - children
```
public List<ContentMap> children(ContentMap content,
                                 String nodeTypeName)
                          throws javax.jcr.RepositoryException
```
    Returns the child nodes of the the provided contentMap of a specific nodeType - as a list of ContentMaps.
    
    Throws:
    
    javax.jcr.RepositoryException
  - root
```
public ContentMap root(ContentMap contentMap)
                throws javax.jcr.RepositoryException
```
    See root(Node) for details.
    
    Throws:
    
    javax.jcr.RepositoryException
  - root
```
public ContentMap root(ContentMap contentMap,
                       String nodeTypeName)
                throws javax.jcr.RepositoryException
```
    See root(Node, String) for details.
    
    Throws:
    
    javax.jcr.RepositoryException
  - root
```
public javax.jcr.Node root(javax.jcr.Node content)
                    throws javax.jcr.RepositoryException
```
    Returns the root node of the workspace to which the provided node belongs.
    
    Throws:
    
    javax.jcr.RepositoryException
  - root
```
public javax.jcr.Node root(javax.jcr.Node content,
                           String nodeTypeName)
                    throws javax.jcr.RepositoryException
```
    Returns the *oldest* ancestor node of the provided node which has the specified nodeType.
    
    Throws:
    
    javax.jcr.RepositoryException
  - parent
```
public ContentMap parent(ContentMap contentMap)
                  throws javax.jcr.RepositoryException
```
    See parent(Node) for details.
    
    Throws:
    
    javax.jcr.RepositoryException
  - parent
```
public ContentMap parent(ContentMap contentMap,
                         String nodeTypeName)
                  throws javax.jcr.RepositoryException
```
    See parent(Node, String) for details.
    
    Throws:
    
    javax.jcr.RepositoryException
  - parent
```
public javax.jcr.Node parent(javax.jcr.Node content)
                      throws javax.jcr.RepositoryException
```
    Returns the direct parent of the node.
    
    Throws:
    
    javax.jcr.RepositoryException
  - parent
```
public javax.jcr.Node parent(javax.jcr.Node content,
                             String nodeTypeName)
                      throws javax.jcr.RepositoryException
```
    Returns the closest ancestor of the provided node which is of the specified nodeType. For example, can be used to find the parent page of component as in {page(Node).
    
    Throws:
    
    javax.jcr.RepositoryException
  - page
```
public ContentMap page(ContentMap content)
                throws javax.jcr.RepositoryException
```
    Returns the page's ContentMap of the passed ContentMap. If the passed ContentMap represents a page, the passed ContentMap will be returned. If the passed ContentMap has no parent page at all, null is returned.
    
    Parameters:
    
    content - The ContentMap to get the page's ContentMap from.
    
    Returns:
    
    The page ContentMap of the passed content ContentMap.
    
    Throws:
    
    javax.jcr.RepositoryException
  - page
```
public javax.jcr.Node page(javax.jcr.Node content)
                    throws javax.jcr.RepositoryException
```
    Returns the page Node of the passed node. If the passed Node is a page, the passed Node will be returned. If the passed Node has no parent page at all, null is returned.
    
    Parameters:
    
    content - The Node to get the page from.
    
    Returns:
    
    The page Node of the passed content Node.
    
    Throws:
    
    javax.jcr.RepositoryException
  - ancestors
```
public List<ContentMap> ancestors(ContentMap contentMap)
                           throws javax.jcr.RepositoryException
```
    See ancestors(Node) for details.
    
    Throws:
    
    javax.jcr.RepositoryException
  - ancestors
```
public List<ContentMap> ancestors(ContentMap contentMap,
                                  String nodeTypeName)
                           throws javax.jcr.RepositoryException
```
    See ancestors(Node, String) for details.
    
    Throws:
    
    javax.jcr.RepositoryException
  - ancestors
```
public List<javax.jcr.Node> ancestors(javax.jcr.Node content)
                               throws javax.jcr.RepositoryException
```
    Return a list of ancestors of the provided node. The list does not include the root node and is ordered from *oldest* to *youngest*.
    
    Throws:
    
    javax.jcr.RepositoryException
  - ancestors
```
public List<javax.jcr.Node> ancestors(javax.jcr.Node content,
                                      String nodeTypeName)
                               throws javax.jcr.RepositoryException
```
    Return a list of ancestors of the provided node which have the provided nodeType. The list does not include the root node and is ordered from *oldest* to *youngest*.
    
    Throws:
    
    javax.jcr.RepositoryException
  - inherit
```
public javax.jcr.Node inherit(javax.jcr.Node content)
                       throws javax.jcr.RepositoryException
```
    Wraps the provided node with an inheritance wrapper so that the node appears to contain the components and/or properties that exist in the equivalent nodes of the ancestors of the provided node's "anchor".
    (The anchor is the first parent of type mgnl:content - typically the page node of the area). The inheritance is subject to the inheritance configuration of the node. (See ConfiguredInheritance.) Note: This is the most commonly used signature of the 'inherit' methods, but the inherit methods are seldom necessary because areas already support inheritance natively through configuration.
    
    Throws:
    
    javax.jcr.RepositoryException
  - inherit
```
public javax.jcr.Node inherit(javax.jcr.Node content,
                              String relPath)
                       throws javax.jcr.RepositoryException
```
    Wraps the provided node with an inheritance wrapper so that the node appears to contain the components and/or properties that exist in the equivalent nodes of the ancestors of the provided node's "anchor".
    (The anchor is the first parent of type mgnl:content - typically the page node of the area). The inheritance is subject to the inheritance configuration of the node. (See ConfiguredInheritance.)
    
    Parameters:
    
    relPath - If not blank, the node will inherit the node specified by this relative path rather than the actual provided node. This could be used to grab a specific property from a subnode.
    
    Throws:
    
    javax.jcr.RepositoryException
  - inherit
```
public javax.jcr.Node inherit(javax.jcr.Node content,
                              String relPath,
                              String nodeTypes,
                              String nodeInheritance,
                              String propertyInheritance)
                       throws javax.jcr.RepositoryException
```
    Wraps the provided node with an inheritance wrapper so that the node appears to contain the components and/or properties that exist in the equivalent nodes of the ancestors of the provided node's "anchor" (The anchor is the first parent of type mgnl:content - typically the page node of the provided node).
    The inheritance is subject to the inheritance configuration of the node, but can be overridden with the parameters of this method.
    
    Note: The inherit methods are seldom necessary because areas already support inheritance natively through configuration.
    
    Node inheritance accepts:
    ConfiguredInheritance.COMPONENTS_ALL
    Inherit all components
    
    ConfiguredInheritance.COMPONENTS_FILTERED
    Inherit only components with property inheritable=true
    
    ConfiguredInheritance.COMPONENTS_NONE
    Do not inherit components
    
    Property inheritance accepts:
    ConfiguredInheritance.PROPERTIES_ALL
    Inherit all properties of ancestors, if multiple ancestors provide the same property the one from the nearest ancestor is used
    
    ConfiguredInheritance.PROPERTIES_NONE
    Do not inherit properties
    
    Parameters:
    
    relPath - If not blank, the node will inherit the node specified by this relative path rather than the actual provided node. This can be used to grab a specific property from a subnode.
    
    nodeTypes - If not blank, only ancestors of the anchor with one of the nodeTypes in this comma delimited string will be evaluated.
    
    nodeInheritance - Specify which child components of the ancestors to inherit.
    
    propertyInheritance - Specify which properties of the ancestors to inherit.
    
    Throws:
    
    javax.jcr.RepositoryException
    
    See Also:
    
    DefaultInheritanceContentDecorator, ConfiguredInheritance
  - inherit
```
public ContentMap inherit(ContentMap content)
                   throws javax.jcr.RepositoryException
```
    See inherit(Node) for details.
    
    Throws:
    
    javax.jcr.RepositoryException
  - inherit
```
public ContentMap inherit(ContentMap content,
                          String relPath)
                   throws javax.jcr.RepositoryException
```
    See inherit(Node, String) for details.
    
    Throws:
    
    javax.jcr.RepositoryException
  - inherit
```
public ContentMap inherit(ContentMap content,
                          String relPath,
                          String nodeTypes,
                          String nodeInheritance,
                          String propertyInheritance)
                   throws javax.jcr.RepositoryException
```
    See inherit(Node, String, String, String, String) for details.
    
    Throws:
    
    javax.jcr.RepositoryException
  - inheritProperty
```
public javax.jcr.Property inheritProperty(javax.jcr.Node content,
                                          String relPath)
                                   throws javax.jcr.RepositoryException
```
    Returns the inherited property of the node, subject to the standard rules of inheritance. (See ConfiguredInheritance.)
    
    Parameters:
    
    relPath - The path to the property. Can reference a property in the current (wrapped) node, or within subnodes via a slash syntax. (i.e. "myNode/mySubNode/myPropertyName")
    
    Throws:
    
    javax.jcr.RepositoryException
  - inheritProperty
```
public javax.jcr.Property inheritProperty(ContentMap content,
                                          String relPath)
                                   throws javax.jcr.RepositoryException
```
    See inheritProperty(Node, String) for details.
    
    Throws:
    
    javax.jcr.RepositoryException
  - inheritList
```
public List<javax.jcr.Node> inheritList(javax.jcr.Node content,
                                        String relPath)
                                 throws javax.jcr.RepositoryException
```
    Returns the children of the wrapped-for-inheritance subnode obtained as in inherit(Node, String).
    
    Throws:
    
    javax.jcr.RepositoryException
  - inheritList
```
public List<ContentMap> inheritList(ContentMap content,
                                    String relPath)
                             throws javax.jcr.RepositoryException
```
    Returns the children of the wrapped-for-inheritance subnode obtained as in inherit(Node, String).
    
    Throws:
    
    javax.jcr.RepositoryException
  - isInherited
```
public boolean isInherited(javax.jcr.Node content)
```
    Returns whether the content is inherited from another node.
  - isInherited
```
public boolean isInherited(ContentMap content)
```
    See isInherited(Node) for details.
  - isFromCurrentPage
```
public boolean isFromCurrentPage(javax.jcr.Node content)
```
    Returns whether the content is an actual child of the current page - i.e. that it was not inherited from another page (or node).
  - isFromCurrentPage
```
public boolean isFromCurrentPage(ContentMap content)
```
    See isFromCurrentPage(Node) for details.
  - link
```
public String link(String workspace,
                   String nodeIdentifier)
```
    Returns a url for Node identified by nodeIdentifier in the specified workspace. Suitable for use in an html anchor.
  - link
```
@Deprecated
public String link(javax.jcr.Property property)
```
    Deprecated. since 4.5.4. There is no valid use case for this method.
    
    There should be no real reason to use this method except to produce link to binary content stored in jcr:data property in which case one should call link(Node) while passing parent node as a parameter. In case you find other valid reason to use this method, please raise it in a forum discussion or create issue. Otherwise this method will be removed in the future.
  - link
```
public String link(javax.jcr.Node content)
```
    Returns a url for the provided node. Suitable for use in an html anchor.
  - link
```
public String link(ContentMap contentMap)
            throws javax.jcr.RepositoryException
```
    See link(Node) for details.
    
    Throws:
    
    javax.jcr.RepositoryException
  - linkPrefix
```
public String linkPrefix(javax.jcr.Node content)
```
  - linkPrefix
```
public String linkPrefix(ContentMap content)
```
    See linkPrefix(Node) for details.
  - getQueryStringAndFragment
```
@Deprecated
public String getQueryStringAndFragment(String url)
```
    Deprecated. since 5.3.8 - use {@link #queryStringAndFragment(String) instead.
    
    Returns the querystring and fragment of a url, or an empty string if there are none.
  - queryStringAndFragment
```
public String queryStringAndFragment(String url)
```
    Returns the querystring and fragment of a url, or an empty string if there are none.
  - language
```
public String language()
```
    Get the language used currently.
    
    Returns:
    
    The language as a String.
  - externalLink
```
public String externalLink(javax.jcr.Node content,
                           String linkPropertyName)
```
    Returns an external link prepended with http:// in case the protocol is missing or an empty String if the link does not exist.
    
    Parameters:
    
    content - The node where the link property is stored on.
    
    linkPropertyName - The property where the link value is stored in.
    
    Returns:
    
    The link prepended with http://
  - externalLink
```
public String externalLink(ContentMap content,
                           String linkPropertyName)
```
    Returns an external link prepended with http:// in case the protocol is missing or an empty String if the link does not exist.
    
    Parameters:
    
    content - The node's map representation where the link property is stored on.
    
    linkPropertyName - The property where the link value is stored in.
    
    Returns:
    
    The link prepended with http://
  - externalLinkTitle
```
public String externalLinkTitle(javax.jcr.Node content,
                                String linkPropertyName,
                                String linkTitlePropertyName)
```
    Return a link title based on the @param linkTitlePropertyName. When property @param linkTitlePropertyName is empty or null, the link itself is provided as the linkTitle (prepended with http://).
    
    Parameters:
    
    content - The node where the link property is stored on.
    
    linkPropertyName - The property where the link value is stored in.
    
    linkTitlePropertyName - The property where the link title value is stored
    
    Returns:
    
    The resolved link title value
  - externalLinkTitle
```
public String externalLinkTitle(ContentMap content,
                                String linkPropertyName,
                                String linkTitlePropertyName)
```
    Return a link title based on the @param linkTitlePropertyName. When property @param linkTitlePropertyName is empty or null, the link itself is provided as the linkTitle (prepended with http://).
    
    Parameters:
    
    content - The node where the link property is stored on.
    
    linkPropertyName - The property where the link value is stored in.
    
    linkTitlePropertyName - The property where the link title value is stored
    
    Returns:
    
    The resolved link title value
  - isEditMode
```
public boolean isEditMode()
```
    Returns whether the request is from the Page editor edit mode. Specifically whether the request is on the author instance and not from the page editor in preview mode. Useful for providing messages in the page to assist the editors.
  - isPreviewMode
```
public boolean isPreviewMode()
```
    Returns whether the request is from the Page editor preview mode.
  - isAuthorInstance
```
public boolean isAuthorInstance()
```
    Returns whether the request is from an author instance.
  - isPublicInstance
```
public boolean isPublicInstance()
```
    Returns whether the request is from a public instance.
  - createHtmlAttribute
```
public String createHtmlAttribute(String name,
                                  String value)
```
    Util method to create html attributes name="value". If the value is empty an empty string will be returned. This is mainly helpful to avoid empty attributes.
  - siblings
```
public SiblingsHelper siblings(javax.jcr.Node node)
                        throws javax.jcr.RepositoryException
```
    Returns an instance of SiblingsHelper for the given node.
    
    Throws:
    
    javax.jcr.RepositoryException
  - siblings
```
public SiblingsHelper siblings(ContentMap node)
                        throws javax.jcr.RepositoryException
```
    Throws:
    
    javax.jcr.RepositoryException
  - content
```
@Deprecated
public javax.jcr.Node content(String path)
```
    Deprecated. since 5.3.3 use contentByPath(String) or nodeByPath(String) instead
    
    Return the Node for the given path from the website repository.
  - content
```
@Deprecated
public javax.jcr.Node content(String repository,
                                          String path)
```
    Deprecated. since 5.3.3 use contentByPath(String, String) or nodeByPath(String, String) instead
    
    Return the Node for the given path from the given repository.
  - contentByIdentifier
```
@Deprecated
public javax.jcr.Node contentByIdentifier(String id)
```
    Deprecated. since 5.3.3 use contentById(String) or {@link #nodeById(String) instead
    
    Return the Node by the given identifier from the website repository.
  - contentByIdentifier
```
@Deprecated
public javax.jcr.Node contentByIdentifier(String repository,
                                                      String id)
```
    Deprecated. since 5.3.3 use contentById(String, String) or contentByPath(String, String) instead
    
    Return the Node by the given identifier from the given repository.
  - contentByPath
```
public ContentMap contentByPath(String path)
```
    Return the ContentMap for the given path from the website repository.
  - contentByPath
```
public ContentMap contentByPath(String path,
                                String workspace)
```
    Return the ContentMap for the given path from the given repository.
  - contentById
```
public ContentMap contentById(String id)
```
    Return the ContentMap by the given identifier from the website repository.
  - contentById
```
public ContentMap contentById(String id,
                              String workspace)
```
    Return the ContentMap by the given identifier from the given repository.
  - nodeByPath
```
public javax.jcr.Node nodeByPath(String path)
```
    Return the Node for the given path from the website repository.
  - nodeByPath
```
public javax.jcr.Node nodeByPath(String path,
                                 String workspace)
```
    Return the Node for the given path from the given repository.
  - nodeById
```
public javax.jcr.Node nodeById(String id)
```
    Return the Node by the given identifier from the website repository.
  - nodeById
```
public javax.jcr.Node nodeById(String id,
                               String workspace)
```
    Return the Node by the given identifier from the given repository.
  - contentByReference
```
public javax.jcr.Node contentByReference(javax.jcr.Node content,
                                         String idPropertyName,
                                         String referencedWorkspace)
                                  throws javax.jcr.RepositoryException
```
    Returns a Node object which is referenced by its id, stored in the @param propertyName.
    
    Parameters:
    
    content - The node with a property containing the referenced id value.
    
    idPropertyName - The name of the property which contains the id of the referenced Node.
    
    referencedWorkspace - The workspace in which the referenced Node exists.
    
    Returns:
    
    the referenced Node
    
    Throws:
    
    javax.jcr.RepositoryException
  - contentByReference
```
public ContentMap contentByReference(ContentMap content,
                                     String idPropertyName,
                                     String referencedWorkspace)
                              throws javax.jcr.RepositoryException
```
    See contentByReference(Node, String, String) for details.
    
    Throws:
    
    javax.jcr.RepositoryException
  - asContentMapList
```
public List<ContentMap> asContentMapList(Collection<javax.jcr.Node> nodeList)
```
    Returns a List of ContentMap objects for the provided collection of Node objects. Useful for working with a collection of Nodes in a template.
  - asNodeList
```
public List<javax.jcr.Node> asNodeList(Collection<ContentMap> contentMapList)
```
    Returns a List of Node objects for the provided collection of ContentMap objects. Useful for working with a collection of ContentMaps in java code.
  - asNodeList
```
protected List<javax.jcr.Node> asNodeList(Iterable<javax.jcr.Node> nodes)
```
  - asContentMapList
```
protected List<ContentMap> asContentMapList(Iterable<javax.jcr.Node> nodes)
```
  - decode
```
public ContentMap decode(ContentMap content)
```
    Removes escaping of HTML on properties.
  - decode
```
public javax.jcr.Node decode(javax.jcr.Node content)
```
    Removes escaping of HTML on properties.
  - encode
```
public ContentMap encode(ContentMap content)
```
    Adds escaping of HTML on properties as well as changing line breaks into <br/> tags.
  - encode
```
public javax.jcr.Node encode(javax.jcr.Node content)
```
    Adds escaping of HTML on properties as well as changing line breaks into <br/> tags.
  - wrapForI18n
```
public javax.jcr.Node wrapForI18n(javax.jcr.Node content)
```
    Wraps content into I18nNodeWrapper so properties are in visitor's language.
  - metaData
```
public String metaData(javax.jcr.Node content,
                       String property)
```
    Returns the string representation of a property from the metaData of the node or null if the node has no Magnolia metaData or if no matching property is found.
  - metaData
```
public String metaData(ContentMap content,
                       String property)
```
    See metaData(Node, String) for details.
  - search
```
@Deprecated
public Collection<javax.jcr.Node> search(String workspace,
                                                     String statement,
                                                     String language,
                                                     String returnItemType)
```
    Deprecated. since 5.4 - use SearchTemplatingFunctions#searchContent(String, String, String, String, long, long) from info.magnolia.templating:magnolia-templating-essentials-models instead.
    
    Executes query and returns result as Collection of Nodes.
    
    Parameters:
    
    statement - has to be in formal form for chosen language
  - simpleSearch
```
@Deprecated
public Collection<javax.jcr.Node> simpleSearch(String workspace,
                                                           String statement,
                                                           String returnItemType,
                                                           String startPath)
```
    Deprecated. since 5.4 - use SearchTemplatingFunctions#searchContent(String, String, String, String, long, long) from info.magnolia.templating:magnolia-templating-essentials-models instead.
    
    Executes simple SQL2 query and returns result as Collection of Nodes.
    
    Parameters:
    
    statement - should be set of labels target has to contain inserted as one string each separated by comma
    
    startPath - can be inserted, for results without limitation set it to slash
  - siteRoot
```
public javax.jcr.Node siteRoot(javax.jcr.Node content)
```
    Returns the site's root of the Node.
    The root Node is defined as the page Node having template type DefaultTemplateTypes.SITE_ROOT. If no ancestor page exists with type DefaultTemplateTypes.SITE_ROOT, the JCR workspace root is returned.
    
    Parameters:
    
    content - The node to determine its site root
    
    Returns:
    
    The site root Node of the passed content Node
  - siteRoot
```
public ContentMap siteRoot(ContentMap content)
```
    See siteRoot(Node) for details..
  - siteRoot
```
public ContentMap siteRoot(ContentMap content,
                           String siteRootTemplateType)
```
    See siteRoot(Node, String) for details.
  - siteRoot
```
public javax.jcr.Node siteRoot(javax.jcr.Node content,
                               String siteRootTemplateType)
```
    Returns the site's root of the passed Node.
    The root Node is defined as the page Node with the passed template type (see: DefaultTemplateTypes). If no ancestor page exists with provided type, the JCR workspace root is returned.
    
    Parameters:
    
    content - The node to determine its site root
    
    siteRootTemplateType - The template type value of the site root to detect.
    
    Returns:
    
    The site root Node of the passed content Node
  - templateType
```
public String templateType(javax.jcr.Node pageNode)
```
    Returns the type of the template assigned to a node.
    If the assigned template is not a TemplateDefinition it defaults to DefaultTemplateTypes.CONTENT and if there is no template assigned or the assigned template doesn't exists it returns the empty string.
  - templateType
```
public String templateType(ContentMap page)
```
    See templateType(Node).
  - templateSubtype
```
public String templateSubtype(javax.jcr.Node pageNode)
```
    Returns the subtype of the template assigned to a node.
    If the assigned template is not a TemplateDefinition it defaults to DefaultTemplateTypes.CONTENT and if there is no template assigned or the assigned template doesn't exists it returns the empty string.
  - templateSubtype
```
public String templateSubtype(ContentMap page)
```
    See templateSubtype(Node) for details.
  - hasTemplateOfType
```
public boolean hasTemplateOfType(javax.jcr.Node pageNode,
                                 String templateType)
```
    Checks whether the given page-Node has the specified templateType.
  - hasTemplateOfType
```
public boolean hasTemplateOfType(ContentMap page,
                                 String templateType)
```
    See hasTemplateOfType(Node, String) for details.
  - parentWithTemplateType
```
public javax.jcr.Node parentWithTemplateType(javax.jcr.Node pageNode,
                                             String templateType)
                                      throws javax.jcr.RepositoryException
```
    Finds a parent Node of given Node with the specified templateType.
    
    Throws:
    
    javax.jcr.RepositoryException
  - parentWithTemplateType
```
public ContentMap parentWithTemplateType(ContentMap page,
                                         String templateType)
                                  throws javax.jcr.RepositoryException
```
    See parentWithTemplateType(Node, String).
    
    Throws:
    
    javax.jcr.RepositoryException
  - contentListByTemplateType
```
public List<javax.jcr.Node> contentListByTemplateType(javax.jcr.Node searchRoot,
                                                      String templateType,
                                                      String templateSubtype,
                                                      int maxResultSize,
                                                      String andClause,
                                                      String orderByClause)
                                               throws javax.jcr.RepositoryException
```
    Find content objects with the given template type (and optionally subtype) below given search root.
    
    Parameters:
    
    searchRoot - the Node to use as root of the search
    
    templateType - the TemplateType to search for
    
    templateSubtype - the TemplateSubtype to search for (optional)
    
    maxResultSize - setting this can drastically improve query performance, if you are interested only in a fixed number of leading result objects
    
    andClause - an additional "AND" clause in SQL syntax, excluding the "AND" itself, e.g. "date IS NOT NULL"
    
    orderByClause - an "ORDER BY" clause in SQL syntax, excluding the "ORDER BY" itself, e.g. "date desc" or "date asc"
    
    Throws:
    
    javax.jcr.RepositoryException
  - contentListByTemplateType
```
public List<ContentMap> contentListByTemplateType(ContentMap searchRoot,
                                                  String templateType,
                                                  String templateSubtype,
                                                  int maxResultSize,
                                                  String andClause,
                                                  String orderByClause)
                                           throws javax.jcr.RepositoryException
```
    See contentListByTemplateType(Node, String, String, int, String, String) for details.
    
    Throws:
    
    javax.jcr.RepositoryException
  - contentListByTemplateType
```
public List<javax.jcr.Node> contentListByTemplateType(javax.jcr.Node siteRoot,
                                                      String templateType,
                                                      String templateSubtype)
                                               throws javax.jcr.RepositoryException
```
    See contentListByTemplateType(Node, String, String, int, String, String) for details.
    
    Throws:
    
    javax.jcr.RepositoryException
  - contentListByTemplateType
```
public List<ContentMap> contentListByTemplateType(ContentMap siteRoot,
                                                  String templateType,
                                                  String templateSubtype)
                                           throws javax.jcr.RepositoryException
```
    See contentListByTemplateType(Node, String, String, int, String, String) for details.
    
    Throws:
    
    javax.jcr.RepositoryException
  - contentListByTemplateIds
```
public List<javax.jcr.Node> contentListByTemplateIds(javax.jcr.Node searchRoot,
                                                     Set<String> templateIds,
                                                     int maxResultSize,
                                                     String andClause,
                                                     String orderByClause)
                                              throws javax.jcr.RepositoryException
```
    Find content objects with one of the given template IDs below a given search root.
    
    Parameters:
    
    searchRoot - the Node to use as root of the search
    
    templateIds - a Set of template IDs to search for
    
    maxResultSize - setting this can drastically improve query performance, if you are interested only in a fixed number of leading result objects
    
    andClause - an additional "AND" clause in SQL syntax, excluding the "AND" itself, e.g. "date IS NOT NULL"
    
    orderByClause - an "ORDER BY" clause in SQL syntax, excluding the "ORDER BY" itself, e.g. "date desc" or "date asc"
    
    Throws:
    
    javax.jcr.RepositoryException
  - contentListByTemplateIds
```
public List<ContentMap> contentListByTemplateIds(ContentMap searchRoot,
                                                 Set<String> templateIds,
                                                 int maxResultSize,
                                                 String andClause,
                                                 String orderByClause)
                                          throws javax.jcr.RepositoryException
```
    See contentListByTemplateIds(Node, Set, int, String, String) for details.
    
    Throws:
    
    javax.jcr.RepositoryException
  - contentListByTemplateId
```
public List<javax.jcr.Node> contentListByTemplateId(javax.jcr.Node searchRoot,
                                                    String templateId)
                                             throws javax.jcr.RepositoryException
```
    See contentListByTemplateId(Node, String, int, String, String) for details.
    
    Throws:
    
    javax.jcr.RepositoryException
  - contentListByTemplateId
```
public List<javax.jcr.Node> contentListByTemplateId(javax.jcr.Node searchRoot,
                                                    String templateId,
                                                    int maxResultSize,
                                                    String andClause,
                                                    String orderByClause)
                                             throws javax.jcr.RepositoryException
```
    Find content objects with the given template ID below a given search root.
    
    Parameters:
    
    searchRoot - the Node to use as root of the search
    
    templateId - a template ID to search for
    
    maxResultSize - setting this can drastically improve query performance, if you are interested only in a fixed number of leading result objects
    
    andClause - an additional "AND" clause in SQL syntax, excluding the "AND" itself, e.g. "date IS NOT NULL"
    
    orderByClause - an "ORDER BY" clause in SQL syntax, excluding the "ORDER BY" itself, e.g. "date desc" or "date asc"
    
    Throws:
    
    javax.jcr.RepositoryException
  - abbreviateString
```
public String abbreviateString(String stringToAbbreviate,
                               int length,
                               String suffix)
```
    Shortens a String to provided length and adds a custom suffix.
  - abbreviateString
```
public String abbreviateString(String stringToAbbreviate,
                               int length)
```
    Shortens a String to provided length and adds suffix " ...".
  - fileExtension
```
public String fileExtension(String fileName)
```
    Returns the file extension of a filename by returning the suffix after the last . (dot).
  - readableFileSize
```
public String readableFileSize(long sizeBytes)
```
    Returns a human friendly string for a file size.
    
    See Also:
    
    FileUtils.byteCountToDisplaySize(long)
  - isCurrentLocale
```
public boolean isCurrentLocale(String language)
```
    Checks if given language is current locale (set in AggregationState).
  - localizedLinks
```
public Map<String,String> localizedLinks()
                                  throws javax.jcr.RepositoryException
```
    Creates a link of current URI to given language.
    Note: This currently only works with links to pages in the website repository. It is not possible to generate localized links for URIs that point to another workspace or links that are forwarded.
    
    Throws:
    
    javax.jcr.RepositoryException
    
    See Also:
    
    Concept+-+Link+API+overhaul
  - localizedLinks
```
public Map<String,String> localizedLinks(javax.jcr.Node content)
                                  throws javax.jcr.RepositoryException
```
    Creates a map of localized links to the node for all supported languages. See localizedLinks() for details.
    
    Throws:
    
    javax.jcr.RepositoryException

Class TemplatingFunctions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TemplatingFunctions

TemplatingFunctions

TemplatingFunctions

Method Detail

asJCRNode

asContentMap

children

children

children

children

root

root

root

root

parent

parent

parent

parent

page

page

ancestors

ancestors

ancestors

ancestors

inherit

inherit

inherit

inherit

inherit

inherit

inheritProperty

inheritProperty

inheritList

inheritList

isInherited

isInherited

isFromCurrentPage

isFromCurrentPage

link

link

link

link

linkPrefix

linkPrefix

getQueryStringAndFragment

queryStringAndFragment

language

externalLink

externalLink

externalLinkTitle

externalLinkTitle

isEditMode

isPreviewMode

isAuthorInstance

isPublicInstance

createHtmlAttribute

siblings

siblings

content

content

contentByIdentifier

contentByIdentifier

contentByPath

contentByPath

contentById

contentById

nodeByPath

nodeByPath

nodeById

nodeById

contentByReference

contentByReference

asContentMapList

asNodeList

asNodeList