A B C D E F G I L M N O P R S T U W _

A

AbstractContentTemplatingElement - Class in info.magnolia.templating.elements

Abstract base class for elements that operate on a specified piece of content.

AbstractContentTemplatingElement(ServerConfiguration, RenderingContext) - Constructor for class info.magnolia.templating.elements.AbstractContentTemplatingElement

AbstractDirective<C extends TemplatingElement> - Class in info.magnolia.templating.freemarker

A base class for freemarker directives used in Magnolia.

AbstractDirective() - Constructor for class info.magnolia.templating.freemarker.AbstractDirective

AbstractTemplatingElement - Class in info.magnolia.templating.elements

Common super class for templating elements, provides utility methods and defaults.

AbstractTemplatingElement(ServerConfiguration, RenderingContext) - Constructor for class info.magnolia.templating.elements.AbstractTemplatingElement

ancestors(ContentMap) - Method in class info.magnolia.templating.functions.TemplatingFunctions

ancestors(ContentMap, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

ancestors(Node) - Method in class info.magnolia.templating.functions.TemplatingFunctions

ancestors(Node, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

append(CharSequence) - Method in class info.magnolia.templating.elements.MarkupHelper

append(CharSequence, int, int) - Method in class info.magnolia.templating.elements.MarkupHelper

append(char) - Method in class info.magnolia.templating.elements.MarkupHelper

AreaDirective - Class in info.magnolia.templating.freemarker

A freemarker directive for rendering an area.

AreaDirective() - Constructor for class info.magnolia.templating.freemarker.AreaDirective

AreaElement - Class in info.magnolia.templating.elements

Renders an area and outputs a marker that instructs the page editor to place a bar at this location.

AreaElement(ServerConfiguration, RenderingContext, RenderingEngine) - Constructor for class info.magnolia.templating.elements.AreaElement

asContentMap(Node) - Method in class info.magnolia.templating.functions.TemplatingFunctions

asContentMapList(Collection<Node>) - Method in class info.magnolia.templating.functions.TemplatingFunctions

asContentMapList(Iterable<Node>) - Method in class info.magnolia.templating.functions.TemplatingFunctions

asJCRNode(ContentMap) - Method in class info.magnolia.templating.functions.TemplatingFunctions

asNodeList(Collection<ContentMap>) - Method in class info.magnolia.templating.functions.TemplatingFunctions

asNodeList(Iterable<Node>) - Method in class info.magnolia.templating.functions.TemplatingFunctions

attribute(String, String) - Method in class info.magnolia.templating.elements.MarkupHelper

ATTRIBUTE_COMPONENT - Static variable in class info.magnolia.templating.elements.AreaElement

ATTRIBUTE_COMPONENTS - Static variable in class info.magnolia.templating.elements.AreaElement

B

begin(Appendable) - Method in class info.magnolia.templating.elements.AbstractTemplatingElement

begin(Appendable) - Method in class info.magnolia.templating.elements.AreaElement

begin(Appendable) - Method in class info.magnolia.templating.elements.ComponentElement

begin(Appendable) - Method in class info.magnolia.templating.elements.InitElement

begin(Appendable) - Method in interface info.magnolia.templating.elements.TemplatingElement

bool(Map<String, TemplateModel>, String, Boolean) - Method in class info.magnolia.templating.freemarker.AbstractDirective

buildAdHocAreaDefinition() - Method in class info.magnolia.templating.elements.AreaElement

C

checkBody(TemplateDirectiveBody, boolean) - Method in class info.magnolia.templating.freemarker.AbstractDirective

Utility method for directives who need to ensure they're used with or without a body.

children(Node) - Method in class info.magnolia.templating.functions.TemplatingFunctions

children(Node, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

children(ContentMap) - Method in class info.magnolia.templating.functions.TemplatingFunctions

children(ContentMap, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

closeComment(String) - Method in class info.magnolia.templating.elements.MarkupHelper

closeTag(String) - Method in class info.magnolia.templating.elements.MarkupHelper

CMS_AREA - Static variable in class info.magnolia.templating.elements.AreaElement

ComponentDirective - Class in info.magnolia.templating.freemarker

A freemarker directive for rendering an arbitrary piece of content.

ComponentDirective() - Constructor for class info.magnolia.templating.freemarker.ComponentDirective

ComponentElement - Class in info.magnolia.templating.elements

Renders a piece of content.

ComponentElement(ServerConfiguration, RenderingContext, RenderingEngine, TemplateDefinitionAssignment) - Constructor for class info.magnolia.templating.elements.ComponentElement

content(Map<String, TemplateModel>, String, Content) - Method in class info.magnolia.templating.freemarker.AbstractDirective

Deprecated.

content(String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Return the Node for the Given Path from the website repository.

content(String, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Return the Node for the Given Path from the given repository.

CONTENT_ATTRIBUTE - Static variable in class info.magnolia.templating.freemarker.AbstractDirective

contentByIdentifier(String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Return the Node by the given identifier from the website repository.

contentByIdentifier(String, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Return the Node by the given identifier from the given repository.

create(Object, ObjectWrapper) - Method in class info.magnolia.templating.freemarker.RenderableDefinitionModel.Factory

createHtmlAttribute(String, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Util method to create html attributes name="value".

createTemplatingElement() - Method in class info.magnolia.templating.freemarker.AbstractDirective

currentContent() - Method in class info.magnolia.templating.elements.AbstractTemplatingElement

Returns the "current content" from the aggregation state.

D

decode(ContentMap) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Removes escaping of HTML on properties.

decode(Node) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Removes escaping of HTML on properties.

DefaultInheritanceContentDecorator - Class in info.magnolia.templating.inheritance

Provides an inheritance model that can be customized with configuration on the nodes.

DefaultInheritanceContentDecorator(Node, InheritanceConfiguration) - Constructor for class info.magnolia.templating.inheritance.DefaultInheritanceContentDecorator

Directives - Class in info.magnolia.templating.freemarker

A map with freemarker directives specific to Magnolia.

Directives() - Constructor for class info.magnolia.templating.freemarker.Directives

doBody(Environment, TemplateDirectiveBody) - Method in class info.magnolia.templating.freemarker.AbstractDirective

E

encode(Node) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Adds escaping of HTML on properties as well as changing line breaks into <br/> tags.

end(Appendable) - Method in class info.magnolia.templating.elements.AbstractTemplatingElement

Override this method if you need to "do something" once the component is rendered, i.e cleanup the context.

end(Appendable) - Method in class info.magnolia.templating.elements.AreaElement

end(Appendable) - Method in class info.magnolia.templating.elements.ComponentElement

end(Appendable) - Method in class info.magnolia.templating.elements.InitElement

end(Appendable) - Method in interface info.magnolia.templating.elements.TemplatingElement

endContent(Node) - Method in class info.magnolia.templating.elements.MarkupHelper

execute(Environment, Map, TemplateModel[], TemplateDirectiveBody) - Method in class info.magnolia.templating.freemarker.AbstractDirective

externalLink(Node, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Returns an external link prepended with http:// in case the protocol is missing or an empty String if the link does not exist.

externalLink(ContentMap, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Returns an external link prepended with http:// in case the protocol is missing or an empty String if the link does not exist.

externalLinkTitle(Node, String, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Return a link title based on the @param linkTitlePropertyName.

externalLinkTitle(ContentMap, String, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Return a link title based on the @param linkTitlePropertyName.

F

factoryFor() - Method in class info.magnolia.templating.freemarker.RenderableDefinitionModel.Factory

findFirstAnchor() - Method in class info.magnolia.templating.inheritance.DefaultInheritanceContentDecorator

G

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

Fall back on the parameters' hash model if no bean property has been found.

getArea() - Method in class info.magnolia.templating.elements.AreaElement

getAvailableComponents() - Method in class info.magnolia.templating.elements.AreaElement

getContent() - Method in class info.magnolia.templating.elements.AbstractContentTemplatingElement

getContextAttributes() - Method in class info.magnolia.templating.elements.AreaElement

getContextAttributes() - Method in class info.magnolia.templating.elements.ComponentElement

getDefinitionMessage(RenderableDefinition, String) - Method in class info.magnolia.templating.elements.AbstractTemplatingElement

getDescription() - Method in class info.magnolia.templating.elements.AreaElement

getDialog() - Method in class info.magnolia.templating.elements.AreaElement

getEditable() - Method in class info.magnolia.templating.elements.AreaElement

getEditable() - Method in class info.magnolia.templating.elements.ComponentElement

getExtraInstallTasks(InstallContext) - Method in class info.magnolia.templating.module.setup.TemplatingModuleVersionHandler

getInterfaceMessage(String) - Method in class info.magnolia.templating.elements.AbstractTemplatingElement

getLabel() - Method in class info.magnolia.templating.elements.AreaElement

getName() - Method in class info.magnolia.templating.elements.AreaElement

getNodeId(Node) - Method in class info.magnolia.templating.elements.MarkupHelper

getNodeIdentifier() - Method in class info.magnolia.templating.elements.AbstractContentTemplatingElement

getNodePath(Node) - Method in class info.magnolia.templating.elements.AbstractContentTemplatingElement

getNodeType(Node) - Method in class info.magnolia.templating.elements.MarkupHelper

getPassedContent() - Method in class info.magnolia.templating.elements.AbstractContentTemplatingElement

Returns the content passed to the element (content or workspace/path attribute) or null if nothing was passed.

getPath() - Method in class info.magnolia.templating.elements.AbstractContentTemplatingElement

getRenderingContext() - Method in class info.magnolia.templating.elements.AbstractTemplatingElement

getServer() - Method in class info.magnolia.templating.elements.AbstractTemplatingElement

getTemplatingElementClass() - Method in class info.magnolia.templating.freemarker.AbstractDirective

getType() - Method in class info.magnolia.templating.elements.AreaElement

getWorkspace() - Method in class info.magnolia.templating.elements.AbstractContentTemplatingElement

I

info.magnolia.templating.elements - package info.magnolia.templating.elements

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

info.magnolia.templating.functions - package info.magnolia.templating.functions

info.magnolia.templating.inheritance - package info.magnolia.templating.inheritance

info.magnolia.templating.module.setup - package info.magnolia.templating.module.setup

info.magnolia.templating.renderers - package info.magnolia.templating.renderers

inherit(Node) - Method in class info.magnolia.templating.functions.TemplatingFunctions

inherit(Node, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

inherit(ContentMap) - Method in class info.magnolia.templating.functions.TemplatingFunctions

inherit(ContentMap, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

inheritList(Node, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

inheritList(ContentMap, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

inheritProperty(Node, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

inheritProperty(ContentMap, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

inheritsNodes(Node) - Method in class info.magnolia.templating.inheritance.DefaultInheritanceContentDecorator

inheritsProperties(Node) - Method in class info.magnolia.templating.inheritance.DefaultInheritanceContentDecorator

initContentElement(Map<String, TemplateModel>, AbstractContentTemplatingElement) - Method in class info.magnolia.templating.freemarker.AbstractDirective

Init attributes common to all AbstractContentTemplatingElement.

InitDirective - Class in info.magnolia.templating.freemarker

A freemarker directive for adding Magnolia specific javascripts and css.

InitDirective() - Constructor for class info.magnolia.templating.freemarker.InitDirective

InitElement - Class in info.magnolia.templating.elements

Embeds js and css needed while authoring pages.

InitElement(ServerConfiguration, RenderingContext) - Constructor for class info.magnolia.templating.elements.InitElement

isAdmin() - Method in class info.magnolia.templating.elements.AbstractTemplatingElement

isAnchor(Node) - Method in class info.magnolia.templating.inheritance.DefaultInheritanceContentDecorator

True if this node is an anchor.

isAuthorInstance() - Method in class info.magnolia.templating.functions.TemplatingFunctions

isEditMode() - Method in class info.magnolia.templating.functions.TemplatingFunctions

isFromCurrentPage(Node) - Method in class info.magnolia.templating.functions.TemplatingFunctions

isFromCurrentPage(ContentMap) - Method in class info.magnolia.templating.functions.TemplatingFunctions

isInherit() - Method in class info.magnolia.templating.elements.AreaElement

isInherited(Node) - Method in class info.magnolia.templating.functions.TemplatingFunctions

isInherited(ContentMap) - Method in class info.magnolia.templating.functions.TemplatingFunctions

isPreviewMode() - Method in class info.magnolia.templating.functions.TemplatingFunctions

isPublicInstance() - Method in class info.magnolia.templating.functions.TemplatingFunctions

isRenderEditbar() - Method in class info.magnolia.templating.elements.ComponentElement

isSourceChildInherited(Node) - Method in class info.magnolia.templating.inheritance.DefaultInheritanceContentDecorator

L

language() - Method in class info.magnolia.templating.functions.TemplatingFunctions

Get the language used currently.

link(String, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Create link for the Node identified by nodeIdentifier in the specified workspace.

link(Property) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Deprecated. since 4.5.4. There is no valid use case for this method.

link(Node) - Method in class info.magnolia.templating.functions.TemplatingFunctions

link(ContentMap) - Method in class info.magnolia.templating.functions.TemplatingFunctions

M

mandatoryBool(Map<String, TemplateModel>, String) - Method in class info.magnolia.templating.freemarker.AbstractDirective

mandatoryContent(Map<String, TemplateModel>, String) - Method in class info.magnolia.templating.freemarker.AbstractDirective

Deprecated.

mandatoryObject(Map<String, TemplateModel>, String) - Method in class info.magnolia.templating.freemarker.AbstractDirective

mandatoryString(Map<String, TemplateModel>, String) - Method in class info.magnolia.templating.freemarker.AbstractDirective

mandatoryStringList(Map<String, TemplateModel>, String) - Method in class info.magnolia.templating.freemarker.AbstractDirective

MarkupHelper - Class in info.magnolia.templating.elements

Helper class for building markup in templating elements.

MarkupHelper(Appendable) - Constructor for class info.magnolia.templating.elements.MarkupHelper

metaData(Node, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

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(ContentMap, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

N

newContext() - Method in class info.magnolia.templating.renderers.PlainTextTemplateRenderer

node(Map<String, TemplateModel>, String, Node) - Method in class info.magnolia.templating.freemarker.AbstractDirective

O

object(Map<String, TemplateModel>, String) - Method in class info.magnolia.templating.freemarker.AbstractDirective

onRender(Node, RenderableDefinition, RenderingContext, Map<String, Object>, String) - Method in class info.magnolia.templating.renderers.PlainTextTemplateRenderer

openComment(String) - Method in class info.magnolia.templating.elements.MarkupHelper

openTag(String) - Method in class info.magnolia.templating.elements.MarkupHelper

P

page(ContentMap) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Returns the page's ContentMap of the passed ContentMap.

page(Node) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Returns the page Node of the passed node.

PAGE_EDITOR_CSS - Static variable in class info.magnolia.templating.elements.InitElement

PAGE_EDITOR_JS_SOURCE - Static variable in class info.magnolia.templating.elements.InitElement

parent(ContentMap) - Method in class info.magnolia.templating.functions.TemplatingFunctions

parent(ContentMap, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

parent(Node) - Method in class info.magnolia.templating.functions.TemplatingFunctions

parent(Node, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

PATH_ATTRIBUTE - Static variable in class info.magnolia.templating.freemarker.AbstractDirective

PlainTextTemplateRenderer - Class in info.magnolia.templating.renderers

Template renderer for plain text.

PlainTextTemplateRenderer() - Constructor for class info.magnolia.templating.renderers.PlainTextTemplateRenderer

prepareTemplatingElement(C, Environment, Map<String, TemplateModel>, TemplateModel[], TemplateDirectiveBody) - Method in class info.magnolia.templating.freemarker.AbstractDirective

Implementations of this method should prepare the TemplatingElement with the known parameters.

prepareTemplatingElement(AreaElement, Environment, Map<String, TemplateModel>, TemplateModel[], TemplateDirectiveBody) - Method in class info.magnolia.templating.freemarker.AreaDirective

prepareTemplatingElement(ComponentElement, Environment, Map<String, TemplateModel>, TemplateModel[], TemplateDirectiveBody) - Method in class info.magnolia.templating.freemarker.ComponentDirective

prepareTemplatingElement(InitElement, Environment, Map<String, TemplateModel>, TemplateModel[], TemplateDirectiveBody) - Method in class info.magnolia.templating.freemarker.InitDirective

prepareTemplatingElement(ComponentElement, Environment, Map<String, TemplateModel>, TemplateModel[], TemplateDirectiveBody) - Method in class info.magnolia.templating.freemarker.ReadOnlyComponentDirective

R

ReadOnlyComponentDirective - Class in info.magnolia.templating.freemarker

A freemarker directive for rendering an arbitrary piece of content (read only).

ReadOnlyComponentDirective() - Constructor for class info.magnolia.templating.freemarker.ReadOnlyComponentDirective

ReadOnlyDirectives - Class in info.magnolia.templating.freemarker

A map with freemarker directives with read only components specific to Magnolia.

ReadOnlyDirectives() - Constructor for class info.magnolia.templating.freemarker.ReadOnlyDirectives

RenderableDefinitionModel - Class in info.magnolia.templating.freemarker

Make parameters directly available (as if they were properties of the definition itself).

RenderableDefinitionModel.Factory - Class in info.magnolia.templating.freemarker

A factory for the enclosing type.

RenderableDefinitionModel.Factory() - Constructor for class info.magnolia.templating.freemarker.RenderableDefinitionModel.Factory

resolveAreaDefinition() - Method in class info.magnolia.templating.elements.AreaElement

resolveAvailableComponents() - Method in class info.magnolia.templating.elements.AreaElement

resolveTemplateDefinition() - Method in class info.magnolia.templating.elements.AreaElement

resolveTemplateScript(Node, RenderableDefinition, RenderingModel<?>, String) - Method in class info.magnolia.templating.renderers.PlainTextTemplateRenderer

restoreAttributesInWebContext(Map<String, Object>, int) - Method in class info.magnolia.templating.elements.AbstractContentTemplatingElement

Restores the original values of attributes in web context under the specified scope.

root(ContentMap) - Method in class info.magnolia.templating.functions.TemplatingFunctions

root(ContentMap, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

root(Node) - Method in class info.magnolia.templating.functions.TemplatingFunctions

root(Node, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

S

search(String, String, String, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Executes query and returns result as Collection of Nodes.

setArea(AreaDefinition) - Method in class info.magnolia.templating.elements.AreaElement

setAttributesInWebContext(Map<String, Object>, int) - Method in class info.magnolia.templating.elements.AbstractContentTemplatingElement

Sets attributes in web context under the specified scope.

setAvailableComponents(String) - Method in class info.magnolia.templating.elements.AreaElement

setContent(Node) - Method in class info.magnolia.templating.elements.AbstractContentTemplatingElement

setContextAttributes(Map<String, Object>) - Method in class info.magnolia.templating.elements.AreaElement

setContextAttributes(Map<String, Object>) - Method in class info.magnolia.templating.elements.ComponentElement

setDescription(String) - Method in class info.magnolia.templating.elements.AreaElement

setDialog(String) - Method in class info.magnolia.templating.elements.AreaElement

setDialog(String) - Method in class info.magnolia.templating.elements.ComponentElement

setDialog(String) - Method in class info.magnolia.templating.elements.InitElement

setEditable(Boolean) - Method in class info.magnolia.templating.elements.AreaElement

setEditable(Boolean) - Method in class info.magnolia.templating.elements.ComponentElement

setInherit(boolean) - Method in class info.magnolia.templating.elements.AreaElement

setLabel(String) - Method in class info.magnolia.templating.elements.AreaElement

setName(String) - Method in class info.magnolia.templating.elements.AreaElement

setNodeIdentifier(String) - Method in class info.magnolia.templating.elements.AbstractContentTemplatingElement

setPath(String) - Method in class info.magnolia.templating.elements.AbstractContentTemplatingElement

setRenderEditbar(boolean) - Method in class info.magnolia.templating.elements.ComponentElement

setType(String) - Method in class info.magnolia.templating.elements.AreaElement

setWorkspace(String) - Method in class info.magnolia.templating.elements.AbstractContentTemplatingElement

siblings(Node) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Returns an instance of SiblingsHelper for the given node.

siblings(ContentMap) - Method in class info.magnolia.templating.functions.TemplatingFunctions

simpleSearch(String, String, String, String) - Method in class info.magnolia.templating.functions.TemplatingFunctions

Executes simple SQL2 query and returns result as Collection of Nodes.

sortInheritedNodes(NodeIterator, List<NodeIterator>) - Method in class info.magnolia.templating.inheritance.DefaultInheritanceContentDecorator

startContent(Node) - Method in class info.magnolia.templating.elements.MarkupHelper

string(Map<String, TemplateModel>, String, String) - Method in class info.magnolia.templating.freemarker.AbstractDirective

T

TemplatingElement - Interface in info.magnolia.templating.elements

Templating elements implement basic building blocks for template scripts.

TemplatingFunctions - Class in info.magnolia.templating.functions

An object exposing several methods useful for templates.

TemplatingFunctions(Provider<AggregationState>) - Constructor for class info.magnolia.templating.functions.TemplatingFunctions

TemplatingModuleVersionHandler - Class in info.magnolia.templating.module.setup

Module's version handler.

TemplatingModuleVersionHandler() - Constructor for class info.magnolia.templating.module.setup.TemplatingModuleVersionHandler

tryToCreateAreaNode(Node) - Method in class info.magnolia.templating.elements.AreaElement

U

UUID_ATTRIBUTE - Static variable in class info.magnolia.templating.freemarker.AbstractDirective

W

WORKSPACE_ATTRIBUTE - Static variable in class info.magnolia.templating.freemarker.AbstractDirective

_

_param(Map<String, TemplateModel>, String, Class<MT>, boolean) - Method in class info.magnolia.templating.freemarker.AbstractDirective

A B C D E F G I L M N O P R S T U W _