Skip navigation links
A B C D E F G H I J K L M N O P R S T V W 

A

AbstractInjectionListener - Class in info.magnolia.rendering.listeners
Listener for text injection.
AbstractInjectionListener() - Constructor for class info.magnolia.rendering.listeners.AbstractInjectionListener
 
AbstractRenderer - Class in info.magnolia.rendering.renderer
Abstract renderer with support for typical functionality such as setting context attributes and executing a rendering model.
AbstractRenderer() - Constructor for class info.magnolia.rendering.renderer.AbstractRenderer
AbstractRenderer(RenderingEngine) - Constructor for class info.magnolia.rendering.renderer.AbstractRenderer
 
AbstractRenderingListener - Class in info.magnolia.rendering.listeners
Listener for RenderingEngine.
AbstractRenderingListener() - Constructor for class info.magnolia.rendering.listeners.AbstractRenderingListener
 
AbstractRenderingListener.RenderingListenerReturnCode - Enum in info.magnolia.rendering.listeners
Rendering listener return codes.
ACTION_RESULT_ATTRIBUTE_PREFIX - Static variable in class info.magnolia.rendering.model.ModelExecutionFilter
 
addArea(String, AreaDefinition) - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
addAvailableComponent(String, ComponentAvailability) - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
addContextAttribute(String, ContextAttributeConfiguration) - Method in class info.magnolia.rendering.renderer.AbstractRenderer
 
addKey(List<String>, String...) - Method in class info.magnolia.rendering.template.i18n.RenderableDefinitionKeyGenerator
Custom implementation till MAGNOLIA-6596 is fixed.
addListener(AbstractRenderingListener) - Method in class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
addListener(AbstractRenderingListener) - Method in interface info.magnolia.rendering.context.RenderingContext
 
addParameter(String, Object) - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
addRole(String) - Method in class info.magnolia.rendering.template.configured.ConfiguredComponentAvailability
 
addVariation(String, RenderableDefinition) - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
after(Node, RenderableDefinition, Map<String, Object>, OutputProvider) - Method in class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
after(Node, RenderableDefinition, Map<String, Object>, OutputProvider) - Method in class info.magnolia.rendering.context.AreaFilteringListener
Deprecated.
 
after(Node, RenderableDefinition, Map<String, Object>, OutputProvider) - Method in interface info.magnolia.rendering.context.RenderingContext
 
after(Node, RenderableDefinition, Map<String, Object>, OutputProvider) - Method in interface info.magnolia.rendering.context.RenderingListener
Deprecated.
 
after(Node, RenderableDefinition, Map<String, Object>, OutputProvider) - Method in class info.magnolia.rendering.listeners.AbstractInjectionListener
 
after(Node, RenderableDefinition, Map<String, Object>, OutputProvider) - Method in class info.magnolia.rendering.listeners.AbstractRenderingListener
 
after(Node, RenderableDefinition, Map<String, Object>, OutputProvider) - Method in class info.magnolia.rendering.listeners.AreaFilteringListener
 
AggregationStateBasedRenderingContext - Class in info.magnolia.rendering.context
RenderingContext implementation that uses AggregationState.
AggregationStateBasedRenderingContext(Provider<AggregationState>, RenderExceptionHandler) - Constructor for class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
AggregationStateBasedRenderingContext(AggregationState, RenderExceptionHandler) - Constructor for class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
AllComponentsAndResourcesInheritancePredicate() - Constructor for class info.magnolia.rendering.template.configured.ConfiguredInheritance.AllComponentsAndResourcesInheritancePredicate
Deprecated.
 
append(CharSequence) - Method in class info.magnolia.rendering.util.FilteringAppendableWrapper
 
append(char) - Method in class info.magnolia.rendering.util.FilteringAppendableWrapper
 
append(CharSequence, int, int) - Method in class info.magnolia.rendering.util.FilteringAppendableWrapper
 
AppendableOnlyOutputProvider - Class in info.magnolia.rendering.engine
Output provider wrapping only Appendable and not providing output stream.
AppendableOnlyOutputProvider(Appendable) - Constructor for class info.magnolia.rendering.engine.AppendableOnlyOutputProvider
 
AppendableWriter - Class in info.magnolia.rendering.util
Simple writer that outputs all the text to provided Appendable.
AppendableWriter(Appendable) - Constructor for class info.magnolia.rendering.util.AppendableWriter
 
AreaDefinition - Interface in info.magnolia.rendering.template
Definition for a Area.
AreaFilteringListener - Class in info.magnolia.rendering.context
Deprecated.
since 5.4, use AreaFilteringListener instead.
AreaFilteringListener(ResponseOutputProvider) - Constructor for class info.magnolia.rendering.context.AreaFilteringListener
Deprecated.
since 5.4, use AreaFilteringListener instead.
AreaFilteringListener - Class in info.magnolia.rendering.listeners
Area rendering listener for enabling/disabling output according to rendered content.
AreaFilteringListener(TemplateDefinitionAssignment) - Constructor for class info.magnolia.rendering.listeners.AreaFilteringListener
 
AUTO_POPULATE_PROPERTY - Static variable in class info.magnolia.rendering.renderer.registry.ConfiguredRendererManager
Deprecated.
since 5.4. Unused.
AutoGenerationConfiguration<V> - Interface in info.magnolia.rendering.template
AutoGeneration configuration.

B

baseClass() - Method in enum info.magnolia.rendering.DefinitionTypes
 
before(Node, RenderableDefinition, Map<String, Object>, OutputProvider) - Method in class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
before(Node, RenderableDefinition, Map<String, Object>, OutputProvider) - Method in class info.magnolia.rendering.context.AreaFilteringListener
Deprecated.
 
before(Node, RenderableDefinition, Map<String, Object>, OutputProvider) - Method in interface info.magnolia.rendering.context.RenderingContext
 
before(Node, RenderableDefinition, Map<String, Object>, OutputProvider) - Method in interface info.magnolia.rendering.context.RenderingListener
Deprecated.
 
before(Node, RenderableDefinition, Map<String, Object>, OutputProvider) - Method in class info.magnolia.rendering.listeners.AbstractInjectionListener
 
before(Node, RenderableDefinition, Map<String, Object>, OutputProvider) - Method in class info.magnolia.rendering.listeners.AbstractRenderingListener
 
before(Node, RenderableDefinition, Map<String, Object>, OutputProvider) - Method in class info.magnolia.rendering.listeners.AreaFilteringListener
 

C

ChannelVariationResolver - Class in info.magnolia.rendering.template.variation
Resolver that will use the channel set in the AggregationState.
ChannelVariationResolver() - Constructor for class info.magnolia.rendering.template.variation.ChannelVariationResolver
 
close() - Method in class info.magnolia.rendering.util.AppendableWriter
 
close() - Method in class info.magnolia.rendering.util.FilteringWriter
Deprecated.
 
CMS_ADD - Static variable in interface info.magnolia.rendering.template.AreaDefinition
 
CMS_EDIT - Static variable in interface info.magnolia.rendering.template.AreaDefinition
 
CMS_PLACEHOLDER - Static variable in interface info.magnolia.rendering.template.AreaDefinition
 
compare(Node, Node) - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance.NodeDepthComparator
 
COMPONENT_CLASS - Static variable in class info.magnolia.rendering.module.setup.InstallRendererContextAttributeTask
 
ComponentAvailability - Interface in info.magnolia.rendering.template
COMPONENTS_ALL - Static variable in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
COMPONENTS_FILTERED - Static variable in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
COMPONENTS_NONE - Static variable in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
ConfiguredAreaDefinition - Class in info.magnolia.rendering.template.configured
A AreaDefinition configured in the configuration workspace.
ConfiguredAreaDefinition() - Constructor for class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
ConfiguredAreaDefinition(TemplateAvailability) - Constructor for class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
ConfiguredAutoGeneration - Class in info.magnolia.rendering.template.configured
Implementation of AutoGenerationConfiguration.
ConfiguredAutoGeneration() - Constructor for class info.magnolia.rendering.template.configured.ConfiguredAutoGeneration
 
ConfiguredComponentAvailability - Class in info.magnolia.rendering.template.configured
A ComponentAvailability configured in the configuration workspace.
ConfiguredComponentAvailability() - Constructor for class info.magnolia.rendering.template.configured.ConfiguredComponentAvailability
 
ConfiguredInheritance - Class in info.magnolia.rendering.template.configured
Defines behavior for inheritance.
ConfiguredInheritance() - Constructor for class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
ConfiguredInheritance.AllComponentsAndResourcesInheritancePredicate - Class in info.magnolia.rendering.template.configured
Deprecated.
since 5.3.5. Use InheritancePredicate instead.
ConfiguredInheritance.FilteredComponentInheritancePredicate - Class in info.magnolia.rendering.template.configured
Deprecated.
since 5.3.5. Use FilteredInheritancePredicate instead.
ConfiguredInheritance.InheritNothingInheritancePredicate - Class in info.magnolia.rendering.template.configured
Predicate for component inheritance that includes no components.
ConfiguredInheritance.NodeDepthComparator - Class in info.magnolia.rendering.template.configured
Comparator for ordering nodes by depth placing nodes deeper in the hierarchy after those further up and ordering nodes on the same level by the order they appear as siblings.
ConfiguredRenderableDefinition - Class in info.magnolia.rendering.template.configured
A RenderableDefinition configured in the configuration workspace.
ConfiguredRenderableDefinition() - Constructor for class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
ConfiguredRendererManager - Class in info.magnolia.rendering.renderer.registry
Deprecated.
since 5.4, replaced by RegistryBasedObservingManager, within JcrConfigurationSource
ConfiguredRendererManager() - Constructor for class info.magnolia.rendering.renderer.registry.ConfiguredRendererManager
Deprecated.
 
ConfiguredRendererProvider - Class in info.magnolia.rendering.renderer.registry
Deprecated.
since 5.4 use DefinitionProvider and configuration sources.
ConfiguredRendererProvider(String, Node) - Constructor for class info.magnolia.rendering.renderer.registry.ConfiguredRendererProvider
Deprecated.
 
ConfiguredTemplateAvailability - Class in info.magnolia.rendering.template.configured
Deprecated.
since 5.4 - use DefaultTemplateAvailability instead.
ConfiguredTemplateAvailability() - Constructor for class info.magnolia.rendering.template.configured.ConfiguredTemplateAvailability
Deprecated.
 
ConfiguredTemplateDefinition - Class in info.magnolia.rendering.template.configured
A TemplateDefinition configured in the configuration workspace.
ConfiguredTemplateDefinition() - Constructor for class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
ConfiguredTemplateDefinition(TemplateAvailability) - Constructor for class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
ConfiguredTemplateDefinitionManager - Class in info.magnolia.rendering.template.registry
Deprecated.
since 5.4, replaced by RegistryBasedObservingManager, within JcrConfigurationSource
ConfiguredTemplateDefinitionManager() - Constructor for class info.magnolia.rendering.template.registry.ConfiguredTemplateDefinitionManager
Deprecated.
 
ConfiguredTemplateDefinitionProvider - Class in info.magnolia.rendering.template.registry
Deprecated.
since 5.4 use DefinitionProvider and configuration sources.
ConfiguredTemplateDefinitionProvider(String, Node) - Constructor for class info.magnolia.rendering.template.registry.ConfiguredTemplateDefinitionProvider
Deprecated.
 
content - Variable in class info.magnolia.rendering.model.RenderingModelImpl
 
CONTENT - Static variable in class info.magnolia.rendering.template.type.DefaultTemplateTypes
 
CONTENT_STRUCTURE_FLAT - Static variable in interface info.magnolia.rendering.template.AreaDefinition
 
CONTENT_STRUCTURE_NODE - Static variable in interface info.magnolia.rendering.template.AreaDefinition
 
contentMap - Variable in class info.magnolia.rendering.model.RenderingModelImpl
 
CONTEXT_ATTRIBUTES - Static variable in class info.magnolia.rendering.module.setup.InstallRendererContextAttributeTask
 
ContextAttributeConfiguration - Class in info.magnolia.rendering.renderer
Configuration of a context attribute.
ContextAttributeConfiguration() - Constructor for class info.magnolia.rendering.renderer.ContextAttributeConfiguration
 
copy() - Method in class info.magnolia.rendering.listeners.AbstractInjectionListener
 
copy() - Method in class info.magnolia.rendering.listeners.AbstractRenderingListener
The instance of each AbstractRenderingListener needs to be copied per request.
copy() - Method in class info.magnolia.rendering.listeners.AreaFilteringListener
 
CopyGenerator - Class in info.magnolia.rendering.generator
An implementation of Generator which will create nodes and properties verbatim as found in AutoGenerationConfiguration.getContent().
CopyGenerator(Node) - Constructor for class info.magnolia.rendering.generator.CopyGenerator
 

D

DEFAULT_MODEL_EXECUTION_ATTRIBUTE_NAME - Static variable in class info.magnolia.rendering.model.ModelExecutionFilter
 
DEFAULT_TYPE - Static variable in interface info.magnolia.rendering.template.AreaDefinition
 
DefaultRenderableVariationResolver - Class in info.magnolia.rendering.template.variation
Resolver that will combine channel and extension variation resolver.
DefaultRenderableVariationResolver() - Constructor for class info.magnolia.rendering.template.variation.DefaultRenderableVariationResolver
 
DefaultRenderingEngine - Class in info.magnolia.rendering.engine
Default implementation of RenderingEngine.
DefaultRenderingEngine() - Constructor for class info.magnolia.rendering.engine.DefaultRenderingEngine
Used to create an observed proxy object.
DefaultRenderingEngine(RendererRegistry, TemplateDefinitionAssignment, RenderableVariationResolver, Provider<RenderingContext>) - Constructor for class info.magnolia.rendering.engine.DefaultRenderingEngine
 
DefaultTemplateAvailability - Class in info.magnolia.rendering.template.configured
DefaultTemplateAvailability() - Constructor for class info.magnolia.rendering.template.configured.DefaultTemplateAvailability
 
DefaultTemplateTypes - Class in info.magnolia.rendering.template.type
Default template types.
DefaultTemplateTypes() - Constructor for class info.magnolia.rendering.template.type.DefaultTemplateTypes
 
definition - Variable in class info.magnolia.rendering.model.RenderingModelImpl
 
DefinitionTypes - Enum in info.magnolia.rendering
Enum of the DefinitionTypes we know in the rendering module.
doExecute(InstallContext) - Method in class info.magnolia.rendering.module.setup.InstallRendererContextAttributeTask
 
doFilter(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class info.magnolia.rendering.engine.RenderingFilter
 
doFilter(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class info.magnolia.rendering.model.ModelExecutionFilter
 

E

EarlyExecutionAware<RD extends RenderableDefinition> - Interface in info.magnolia.rendering.model
Implemented by models that want to handle early execution in a separate callback.
EMPTY_CONTEXT - Static variable in class info.magnolia.rendering.engine.DefaultRenderingEngine
 
evaluateTyped(Node) - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance.AllComponentsAndResourcesInheritancePredicate
Deprecated.
 
evaluateTyped(Node) - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance.FilteredComponentInheritancePredicate
Deprecated.
 
evaluateTyped(Node) - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance.InheritNothingInheritancePredicate
 
evaluateTyped(Node) - Method in class info.magnolia.rendering.template.configured.FilteredInheritancePredicate
 
evaluateTyped(Node) - Method in class info.magnolia.rendering.template.configured.InheritancePredicate
 
execute() - Method in interface info.magnolia.rendering.model.RenderingModel
Called after all properties were set.
execute() - Method in class info.magnolia.rendering.model.RenderingModelImpl
 
executeEarly() - Method in interface info.magnolia.rendering.model.EarlyExecutionAware
Called after all properties were set.
ExtensionVariationResolver - Class in info.magnolia.rendering.template.variation
Variation resolver that will use a variation with the same name as the extension.
ExtensionVariationResolver() - Constructor for class info.magnolia.rendering.template.variation.ExtensionVariationResolver
 

F

FEATURE - Static variable in class info.magnolia.rendering.template.type.DefaultTemplateTypes
 
FilteredComponentInheritancePredicate() - Constructor for class info.magnolia.rendering.template.configured.ConfiguredInheritance.FilteredComponentInheritancePredicate
Deprecated.
 
FilteredInheritancePredicate - Class in info.magnolia.rendering.template.configured
A class extending AbstractPredicate used in ConfiguredInheritance.
FilteredInheritancePredicate() - Constructor for class info.magnolia.rendering.template.configured.FilteredInheritancePredicate
 
FilteringAppendableWrapper - Class in info.magnolia.rendering.util
Wrapper for Appendable that appends all the text to wrapped Appendable only if writeEnabled=true.
FilteringAppendableWrapper() - Constructor for class info.magnolia.rendering.util.FilteringAppendableWrapper
 
FilteringResponseOutputProvider - Class in info.magnolia.rendering.engine
Filtering implementation of OutputProvider.
FilteringResponseOutputProvider(HttpServletResponse) - Constructor for class info.magnolia.rendering.engine.FilteringResponseOutputProvider
 
FilteringWriter - Class in info.magnolia.rendering.util
Deprecated.
since 5.4. Use FilteringAppendableWrapper instead.
FilteringWriter(Appendable) - Constructor for class info.magnolia.rendering.util.FilteringWriter
Deprecated.
 
findParentWithTemplateType(Node, String) - Method in class info.magnolia.rendering.template.type.TemplateTypeHelper
Finds a parent Node of given Node with the specified templateType.
flush() - Method in class info.magnolia.rendering.util.AppendableWriter
 
flush() - Method in class info.magnolia.rendering.util.FilteringWriter
Deprecated.
 
FragmentDefinition - Interface in info.magnolia.rendering.template.fragment
Definition for dynamic page fragment.
FreemarkerRenderer - Class in info.magnolia.rendering.renderer
Uses FreeMarker to render the content.
FreemarkerRenderer() - Constructor for class info.magnolia.rendering.renderer.FreemarkerRenderer
FreemarkerRenderer(FreemarkerHelper, RenderingEngine) - Constructor for class info.magnolia.rendering.renderer.FreemarkerRenderer
 
fromNode(Node) - Method in class info.magnolia.rendering.template.registry.ConfiguredTemplateDefinitionProvider
Deprecated.
 
FUNCTIONAL - Static variable in class info.magnolia.rendering.template.type.DefaultTemplateTypes
 

G

generate(AutoGenerationConfiguration) - Method in class info.magnolia.rendering.generator.CopyGenerator
 
generate(C) - Method in interface info.magnolia.rendering.generator.Generator
 
Generator<C extends AutoGenerationConfiguration> - Interface in info.magnolia.rendering.generator
A generator to be implemented in order to create nodes based on the passed in configuration.
getAfter() - Method in class info.magnolia.rendering.listeners.AbstractInjectionListener
 
getAggregationStateSafely() - Static method in class info.magnolia.rendering.model.ModelExecutionFilter
 
getAggregationStateSafely() - Method in class info.magnolia.rendering.renderer.AbstractRenderer
This gets the aggregation state without throwing an exception if the current context is not a WebContext.
getAggregationStateSafely() - Method in class info.magnolia.rendering.template.variation.DefaultRenderableVariationResolver
This gets the aggregation state without throwing an exception if the current context is not a WebContext.
getAggregationStateSafely() - Method in class info.magnolia.rendering.template.variation.ExtensionVariationResolver
This gets the aggregation state without throwing an exception if the current context is not a WebContext.
getAncestorDefinition(int) - Method in class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
getAncestorDefinition(int) - Method in interface info.magnolia.rendering.context.RenderingContext
 
getAppendable() - Method in class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
getAppendable() - Method in interface info.magnolia.rendering.context.RenderingContext
 
getAppendable() - Method in class info.magnolia.rendering.engine.AppendableOnlyOutputProvider
 
getAppendable() - Method in class info.magnolia.rendering.engine.FilteringResponseOutputProvider
 
getAppendable() - Method in interface info.magnolia.rendering.engine.OutputProvider
 
getAppendable() - Method in class info.magnolia.rendering.engine.ResponseOutputProvider
 
getAreas() - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
getAreas() - Method in interface info.magnolia.rendering.template.TemplateDefinition
 
getArguments() - Method in class info.magnolia.rendering.listeners.AbstractInjectionListener
 
getAssignedTemplate(Node) - Method in class info.magnolia.rendering.template.assignment.MetaDataBasedTemplateDefinitionAssignment
 
getAssignedTemplate(Node) - Method in interface info.magnolia.rendering.template.assignment.TemplateDefinitionAssignment
Returns the id of the template assigned to a node or null if none has been assigned.
getAssignedTemplateDefinition(Node) - Method in class info.magnolia.rendering.template.assignment.MetaDataBasedTemplateDefinitionAssignment
 
getAssignedTemplateDefinition(Node) - Method in interface info.magnolia.rendering.template.assignment.TemplateDefinitionAssignment
 
getAutoGeneration() - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
getAutoGeneration() - Method in interface info.magnolia.rendering.template.RenderableDefinition
 
getAutoPopulateFromRequest() - Method in class info.magnolia.rendering.engine.DefaultRenderingEngine
 
getAutoPopulateFromRequest() - Method in interface info.magnolia.rendering.engine.RenderingEngine
 
getAutoPopulateFromRequest() - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
getAutoPopulateFromRequest() - Method in interface info.magnolia.rendering.template.RenderableDefinition
 
getAvailableComponents() - Method in interface info.magnolia.rendering.template.AreaDefinition
 
getAvailableComponents() - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
getAvailableTemplates(Node) - Method in class info.magnolia.rendering.template.assignment.MetaDataBasedTemplateDefinitionAssignment
 
getAvailableTemplates(Node) - Method in interface info.magnolia.rendering.template.assignment.TemplateDefinitionAssignment
 
getBefore() - Method in class info.magnolia.rendering.listeners.AbstractInjectionListener
 
getComponentClass() - Method in class info.magnolia.rendering.renderer.ContextAttributeConfiguration
 
getComponentComparator() - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
getComponentComparator() - Method in interface info.magnolia.rendering.template.InheritanceConfiguration
 
getComponentPredicate() - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
getComponentPredicate() - Method in interface info.magnolia.rendering.template.InheritanceConfiguration
 
getComponents() - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
getContent(String) - Method in class info.magnolia.rendering.model.ModelExecutionFilter
Returns the content node for the supplied node identifier.
getContent() - Method in interface info.magnolia.rendering.model.RenderingModel
Map representation of the content node tied to this model.
getContent() - Method in class info.magnolia.rendering.model.RenderingModelImpl
 
getContent() - Method in interface info.magnolia.rendering.template.AutoGenerationConfiguration
 
getContent() - Method in class info.magnolia.rendering.template.configured.ConfiguredAutoGeneration
 
getContentListByTemplateIds(Node, Set<String>, int, String, String) - Method in class info.magnolia.rendering.template.type.TemplateTypeHelper
Find content objects with one of the given templates below a given search root.
getContentListByTemplateType(Node, String, String, int, String, String) - Method in class info.magnolia.rendering.template.type.TemplateTypeHelper
Find content objects with one of the given template (sub) types below given search root.
getContentStructure() - Method in interface info.magnolia.rendering.template.AreaDefinition
 
getContentStructure() - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
getContentType(RenderableDefinition) - Method in class info.magnolia.rendering.renderer.AbstractRenderer
It's currently not possible to determine the content type of the renderer from the RenderableDefinition.
getContentType() - Method in class info.magnolia.rendering.renderer.AbstractRenderer
 
getContextAttributes() - Method in class info.magnolia.rendering.renderer.AbstractRenderer
 
getCreateAreaNode() - Method in interface info.magnolia.rendering.template.AreaDefinition
 
getCreateAreaNode() - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
getCurrentContent() - Method in class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
getCurrentContent() - Method in interface info.magnolia.rendering.context.RenderingContext
 
getDef() - Method in class info.magnolia.rendering.model.RenderingModelImpl
Shortname for templates: model.def.
getDefaultTemplate(Node) - Method in class info.magnolia.rendering.template.assignment.MetaDataBasedTemplateDefinitionAssignment
Get the Template that could be used for the provided content as a default.
getDefaultTemplate(Node) - Method in interface info.magnolia.rendering.template.assignment.TemplateDefinitionAssignment
 
getDefinition() - Method in interface info.magnolia.rendering.model.RenderingModel
The renderable (template, area or component) tied to this model.
getDefinition() - Method in class info.magnolia.rendering.model.RenderingModelImpl
 
getDeletable() - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
getDeletable() - Method in interface info.magnolia.rendering.template.TemplateDefinition
 
getDescription() - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
getDescription() - Method in interface info.magnolia.rendering.template.RenderableDefinition
 
getDialog() - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
getDialog() - Method in interface info.magnolia.rendering.template.TemplateDefinition
 
getEditable() - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
getEditable() - Method in interface info.magnolia.rendering.template.TemplateDefinition
 
getEnabled() - Method in interface info.magnolia.rendering.template.AreaDefinition
 
getEnabled() - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
getEnabled() - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
getFmHelper() - Method in class info.magnolia.rendering.renderer.FreemarkerRenderer
 
getFragmentDefinition() - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
getFragmentDefinition() - Method in interface info.magnolia.rendering.template.RenderableDefinition
 
getGeneratorClass() - Method in interface info.magnolia.rendering.template.AutoGenerationConfiguration
 
getGeneratorClass() - Method in class info.magnolia.rendering.template.configured.ConfiguredAutoGeneration
 
getI18nBasename() - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
Deprecated.
since 5.4.4. I18nBasename is deprecated and will be removed in a future version.
getI18nBasename() - Method in interface info.magnolia.rendering.template.RenderableDefinition
Deprecated.
since 5.4.4. I18nBasename is deprecated and will be removed in a future version.
getId() - Method in interface info.magnolia.rendering.template.ComponentAvailability
 
getId() - Method in class info.magnolia.rendering.template.configured.ConfiguredComponentAvailability
 
getId() - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
getId() - Method in class info.magnolia.rendering.template.registry.ConfiguredTemplateDefinitionProvider
Deprecated.
 
getId() - Method in interface info.magnolia.rendering.template.registry.TemplateDefinitionProvider
Deprecated.
 
getId() - Method in interface info.magnolia.rendering.template.RenderableDefinition
 
getIdentifierOfNodeToExecute() - Method in class info.magnolia.rendering.model.ModelExecutionFilter
 
getInheritance() - Method in interface info.magnolia.rendering.template.AreaDefinition
 
getInheritance() - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
getListeners() - Method in class info.magnolia.rendering.engine.DefaultRenderingEngine
 
getListeners() - Method in class info.magnolia.rendering.renderer.registry.RendererRegistry
Deprecated.
since 5.4. Listeners are now instantiated under (/server/rendering/engine/listeners)
getMainContent() - Method in class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
getMainContent() - Method in interface info.magnolia.rendering.context.RenderingContext
 
getMainContentSafely(Node) - Method in class info.magnolia.rendering.renderer.AbstractRenderer
Gets the current main content or returns null if aggregation state is not set.
getMaxComponents() - Method in interface info.magnolia.rendering.template.AreaDefinition
 
getMaxComponents() - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
getModelClass() - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
getModelClass() - Method in interface info.magnolia.rendering.template.RenderableDefinition
 
getMoveable() - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
getMoveable() - Method in interface info.magnolia.rendering.template.TemplateDefinition
 
getName() - Method in class info.magnolia.rendering.renderer.ContextAttributeConfiguration
 
getName() - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
getName() - Method in interface info.magnolia.rendering.template.RenderableDefinition
 
getNode() - Method in interface info.magnolia.rendering.model.RenderingModel
The content node tied to this model.
getNode() - Method in class info.magnolia.rendering.model.RenderingModelImpl
 
getNodeTypes() - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
getOptional() - Method in interface info.magnolia.rendering.template.AreaDefinition
If an area is optional it has first to be created explicitly (i.e. via a create button).
getOptional() - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
getOutputProvider() - Method in class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
getOutputProvider() - Method in interface info.magnolia.rendering.context.RenderingContext
 
getOutputStream() - Method in class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
getOutputStream() - Method in interface info.magnolia.rendering.context.RenderingContext
 
getOutputStream() - Method in class info.magnolia.rendering.engine.AppendableOnlyOutputProvider
 
getOutputStream() - Method in class info.magnolia.rendering.engine.FilteringResponseOutputProvider
Filtering not supported for OutputStream.
getOutputStream() - Method in interface info.magnolia.rendering.engine.OutputProvider
 
getOutputStream() - Method in class info.magnolia.rendering.engine.ResponseOutputProvider
 
getParameters() - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
getParameters() - Method in interface info.magnolia.rendering.template.RenderableDefinition
An arbitrary list of parameters.
getParent() - Method in interface info.magnolia.rendering.model.RenderingModel
The model of the parent component or template.
getParent() - Method in class info.magnolia.rendering.model.RenderingModelImpl
 
getParentAreaDefinition() - Method in class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
getParentAreaDefinition() - Method in interface info.magnolia.rendering.context.RenderingContext
 
getPermissions() - Method in interface info.magnolia.rendering.template.ComponentAvailability
 
getPermissions() - Method in class info.magnolia.rendering.template.configured.ConfiguredComponentAvailability
 
getRenderableDefinition() - Method in class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
getRenderableDefinition() - Method in interface info.magnolia.rendering.context.RenderingContext
 
getRenderableDefinitionFor(Node) - Method in class info.magnolia.rendering.engine.DefaultRenderingEngine
 
getRenderEmptyAreas() - Method in class info.magnolia.rendering.engine.DefaultRenderingEngine
 
getRenderEmptyAreas() - Method in interface info.magnolia.rendering.engine.RenderingEngine
 
getRenderer() - Method in class info.magnolia.rendering.renderer.registry.ConfiguredRendererProvider
Deprecated.
 
getRenderer() - Method in interface info.magnolia.rendering.renderer.registry.RendererProvider
Deprecated.
 
getRenderer(String) - Method in class info.magnolia.rendering.renderer.registry.RendererRegistry
 
getRendererFor(RenderableDefinition) - Method in class info.magnolia.rendering.engine.DefaultRenderingEngine
 
getRenderingContext() - Method in class info.magnolia.rendering.engine.DefaultRenderingEngine
 
getRenderingContext() - Method in interface info.magnolia.rendering.engine.RenderingEngine
Returns the current RenderingContext.
getRenderingModelBasedRenderer(RenderableDefinition) - Method in class info.magnolia.rendering.model.ModelExecutionFilter
Returns the Renderer for the supplied renderable if it supports RenderingModel.
getRenderType() - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
getRenderType() - Method in interface info.magnolia.rendering.template.RenderableDefinition
 
getRoles() - Method in interface info.magnolia.rendering.template.ComponentAvailability
 
getRoles() - Method in class info.magnolia.rendering.template.configured.ConfiguredComponentAvailability
 
getRoot() - Method in interface info.magnolia.rendering.model.RenderingModel
The top root model of the rendering process.
getRoot() - Method in class info.magnolia.rendering.model.RenderingModelImpl
 
getShouldProcess() - Method in class info.magnolia.rendering.listeners.AbstractRenderingListener
 
getSubtype() - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
getSubtype() - Method in interface info.magnolia.rendering.template.TemplateDefinition
Specifies the template subtype, such as specific features, e.g.
getTemplateAvailability() - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
getTemplateAvailability() - Method in interface info.magnolia.rendering.template.TemplateDefinition
 
getTemplateDefinition(Node) - Method in class info.magnolia.rendering.model.ModelExecutionFilter
Returns the TemplateDefinition for the supplied content.
getTemplateDefinition() - Method in class info.magnolia.rendering.template.registry.ConfiguredTemplateDefinitionProvider
Deprecated.
 
getTemplateDefinition() - Method in interface info.magnolia.rendering.template.registry.TemplateDefinitionProvider
Deprecated.
 
getTemplateDefinition(String) - Method in class info.magnolia.rendering.template.registry.TemplateDefinitionRegistry
Deprecated.
since 5.4 use AbstractRegistry.getProvider(String)
getTemplateDefinitions() - Method in class info.magnolia.rendering.template.registry.TemplateDefinitionRegistry
Deprecated.
since 5.4 use AbstractRegistry.getAllDefinitions()
getTemplateScript() - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
getTemplateScript() - Method in interface info.magnolia.rendering.template.RenderableDefinition
 
getTemplateSubtypeOrDefault(Node) - Method in class info.magnolia.rendering.template.type.TemplateTypeHelper
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.
getTemplateTypeOrDefault(Node) - Method in class info.magnolia.rendering.template.type.TemplateTypeHelper
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.
getTitle() - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
getTitle() - Method in interface info.magnolia.rendering.template.RenderableDefinition
 
getType() - Method in class info.magnolia.rendering.renderer.registry.ConfiguredRendererProvider
Deprecated.
 
getType() - Method in interface info.magnolia.rendering.renderer.registry.RendererProvider
Deprecated.
 
getType() - Method in interface info.magnolia.rendering.template.AreaDefinition
getType() - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
getType() - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
getType(RenderableDefinition) - Method in class info.magnolia.rendering.template.i18n.RenderableDefinitionKeyGenerator
 
getType() - Method in interface info.magnolia.rendering.template.TemplateDefinition
Specifies the template type, e.g.
getVariations() - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
getVariations() - Method in interface info.magnolia.rendering.template.RenderableDefinition
 
getVisible() - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
getVisible() - Method in interface info.magnolia.rendering.template.TemplateDefinition
 
getWrappedAppendable() - Method in class info.magnolia.rendering.util.FilteringAppendableWrapper
 
getWritable() - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
getWritable() - Method in interface info.magnolia.rendering.template.TemplateDefinition
 

H

handleException(RenderException) - Method in class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
handleException(RenderException) - Method in interface info.magnolia.rendering.context.RenderingContext
 
handleException(RenderException, RenderingContext) - Method in class info.magnolia.rendering.engine.ModeDependentRenderExceptionHandler
 
handleException(RenderException, Appendable) - Method in class info.magnolia.rendering.engine.ModeDependentRenderExceptionHandler
 
handleException(RenderException, RenderingContext) - Method in interface info.magnolia.rendering.engine.RenderExceptionHandler
Handles exception and provides informations from RenderingContext.
handleException(RenderException, Appendable) - Method in interface info.magnolia.rendering.engine.RenderExceptionHandler
Handles exception and can print informations to passed output.
handleExecutionResult(RenderingModel, String, TemplateDefinition, HttpServletRequest, HttpServletResponse) - Method in class info.magnolia.rendering.model.ModelExecutionFilter
 
handleResourceRequest(AggregationState, HttpServletRequest, HttpServletResponse) - Method in class info.magnolia.rendering.engine.RenderingFilter
Get the requested resource and copy it to the ServletOutputStream, bit by bit.
handleTemplateRequest(AggregationState, HttpServletRequest, HttpServletResponse) - Method in class info.magnolia.rendering.engine.RenderingFilter
 
hasReadAccess(Node) - Method in class info.magnolia.rendering.template.assignment.MetaDataBasedTemplateDefinitionAssignment
 
hasTemplateOfType(Node, String) - Method in class info.magnolia.rendering.template.type.TemplateTypeHelper
Checks whether the given page-Node has the specified templateType.
HOME - Static variable in class info.magnolia.rendering.template.type.DefaultTemplateTypes
 

I

inEditMode(String, RenderException, PrintWriter) - Method in class info.magnolia.rendering.engine.ModeDependentRenderExceptionHandler
 
info.magnolia.rendering - package info.magnolia.rendering
 
info.magnolia.rendering.context - package info.magnolia.rendering.context
 
info.magnolia.rendering.engine - package info.magnolia.rendering.engine
 
info.magnolia.rendering.generator - package info.magnolia.rendering.generator
 
info.magnolia.rendering.listeners - package info.magnolia.rendering.listeners
 
info.magnolia.rendering.model - package info.magnolia.rendering.model
 
info.magnolia.rendering.module - package info.magnolia.rendering.module
 
info.magnolia.rendering.module.setup - package info.magnolia.rendering.module.setup
 
info.magnolia.rendering.renderer - package info.magnolia.rendering.renderer
 
info.magnolia.rendering.renderer.registry - package info.magnolia.rendering.renderer.registry
 
info.magnolia.rendering.template - package info.magnolia.rendering.template
 
info.magnolia.rendering.template.assignment - package info.magnolia.rendering.template.assignment
 
info.magnolia.rendering.template.configured - package info.magnolia.rendering.template.configured
 
info.magnolia.rendering.template.fragment - package info.magnolia.rendering.template.fragment
 
info.magnolia.rendering.template.i18n - package info.magnolia.rendering.template.i18n
 
info.magnolia.rendering.template.registry - package info.magnolia.rendering.template.registry
 
info.magnolia.rendering.template.type - package info.magnolia.rendering.template.type
 
info.magnolia.rendering.template.variation - package info.magnolia.rendering.template.variation
 
info.magnolia.rendering.util - package info.magnolia.rendering.util
 
InheritanceConfiguration - Interface in info.magnolia.rendering.template
Configuration for inheritance, allows for configuring inheritance for properties separately from inheritance of components.
InheritancePredicate - Class in info.magnolia.rendering.template.configured
A class extending AbstractPredicate used in ConfiguredInheritance.
InheritancePredicate() - Constructor for class info.magnolia.rendering.template.configured.InheritancePredicate
 
INHERITED_PROPERTY_NAME - Static variable in class info.magnolia.rendering.template.configured.ConfiguredInheritance.FilteredComponentInheritancePredicate
Deprecated.
 
InheritNothingInheritancePredicate() - Constructor for class info.magnolia.rendering.template.configured.ConfiguredInheritance.InheritNothingInheritancePredicate
 
init(OutputProvider, HttpServletResponse) - Method in class info.magnolia.rendering.listeners.AbstractRenderingListener
 
init(OutputProvider, HttpServletResponse) - Method in class info.magnolia.rendering.listeners.AreaFilteringListener
 
initListeners(OutputProvider, HttpServletResponse) - Method in class info.magnolia.rendering.engine.DefaultRenderingEngine
 
initListeners(OutputProvider, HttpServletResponse) - Method in interface info.magnolia.rendering.engine.RenderingEngine
Inits listeners.
inPublicMode(String, RenderException, PrintWriter) - Method in class info.magnolia.rendering.engine.ModeDependentRenderExceptionHandler
 
InstallRendererContextAttributeTask - Class in info.magnolia.rendering.module.setup
Task for installing context attributes to renderers.
InstallRendererContextAttributeTask(String, String, String, String) - Constructor for class info.magnolia.rendering.module.setup.InstallRendererContextAttributeTask
 
isAvailable(Node, TemplateDefinition) - Method in class info.magnolia.rendering.template.assignment.MetaDataBasedTemplateDefinitionAssignment
 
isAvailable(Node, TemplateDefinition) - Method in class info.magnolia.rendering.template.configured.DefaultTemplateAvailability
 
isAvailable(Node, TemplateDefinition) - Method in interface info.magnolia.rendering.template.TemplateAvailability
 
isCheckAreaExistence() - Method in class info.magnolia.rendering.listeners.AreaFilteringListener
 
isDynamic() - Method in interface info.magnolia.rendering.template.fragment.FragmentDefinition
 
isEnabled() - Method in class info.magnolia.rendering.listeners.AbstractRenderingListener
 
isEnabled() - Method in interface info.magnolia.rendering.template.AreaDefinition
Deprecated.
since 5.0 - use AreaDefinition.getEnabled() instead.
isEnabled() - Method in interface info.magnolia.rendering.template.ComponentAvailability
 
isEnabled() - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
isEnabled() - Method in class info.magnolia.rendering.template.configured.ConfiguredComponentAvailability
 
isEnabled() - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
isEnabled() - Method in interface info.magnolia.rendering.template.InheritanceConfiguration
 
isInheritsComponents() - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
isInheritsComponents() - Method in interface info.magnolia.rendering.template.InheritanceConfiguration
 
isInheritsProperties() - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
isInheritsProperties() - Method in interface info.magnolia.rendering.template.InheritanceConfiguration
 
isOptional() - Method in interface info.magnolia.rendering.template.AreaDefinition
Deprecated.
since 4.5.9 - use AreaDefinition.getOptional() instead.
isOptional() - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
isSkipRendering() - Method in class info.magnolia.rendering.listeners.AbstractInjectionListener
 
isTemplateAvailable(Node, TemplateDefinition) - Method in class info.magnolia.rendering.template.assignment.MetaDataBasedTemplateDefinitionAssignment
 
isTerminateChain() - Method in class info.magnolia.rendering.engine.RenderingFilter
 
isVisible(Node, HttpServletRequest, HttpServletResponse, AggregationState) - Method in class info.magnolia.rendering.engine.RenderingFilter
 
isVisible(TemplateDefinition) - Method in class info.magnolia.rendering.template.assignment.MetaDataBasedTemplateDefinitionAssignment
 
isWriteEnabled() - Method in class info.magnolia.rendering.util.FilteringAppendableWrapper
 

J

JspRenderer - Class in info.magnolia.rendering.renderer
Renders templates by dispatching to the servlet container.
JspRenderer() - Constructor for class info.magnolia.rendering.renderer.JspRenderer
Deprecated.
JspRenderer(RenderingEngine) - Constructor for class info.magnolia.rendering.renderer.JspRenderer
 

K

keysFor(List<String>, RenderableDefinition, AnnotatedElement) - Method in class info.magnolia.rendering.template.i18n.RenderableDefinitionKeyGenerator
 

L

LISTENERS_NODE_NAME - Static variable in class info.magnolia.rendering.renderer.registry.ConfiguredRendererManager
Deprecated.
since 5.4, listeners are now registered under config:server/rendering/listeners.

M

MetaDataBasedTemplateDefinitionAssignment - Class in info.magnolia.rendering.template.assignment
Uses the template id stored in the node's meta data.
MetaDataBasedTemplateDefinitionAssignment(TemplateDefinitionRegistry) - Constructor for class info.magnolia.rendering.template.assignment.MetaDataBasedTemplateDefinitionAssignment
 
MetaDataBasedTemplateDefinitionAssignment(TemplateDefinitionRegistry, SimpleTranslator) - Constructor for class info.magnolia.rendering.template.assignment.MetaDataBasedTemplateDefinitionAssignment
MGNL_AREA_PARAMETER - Static variable in class info.magnolia.rendering.listeners.AreaFilteringListener
 
MGNL_AREA_PATH_SEPARATOR - Static variable in class info.magnolia.rendering.listeners.AreaFilteringListener
 
MigrateRenderingListenersTask - Class in info.magnolia.rendering.module.setup
Migrates configuration under modules/rendering/renderers/listeners/ to server/rendering/engine/listeners/.
MigrateRenderingListenersTask() - Constructor for class info.magnolia.rendering.module.setup.MigrateRenderingListenersTask
 
ModeDependentRenderExceptionHandler - Class in info.magnolia.rendering.engine
Exception handler providing different output based on the configuration of the current instance.
ModeDependentRenderExceptionHandler(ServerConfiguration, Provider<AggregationState>) - Constructor for class info.magnolia.rendering.engine.ModeDependentRenderExceptionHandler
 
MODEL_ATTRIBUTE - Static variable in class info.magnolia.rendering.renderer.AbstractRenderer
 
MODEL_ATTRIBUTE_PREFIX - Static variable in class info.magnolia.rendering.model.ModelExecutionFilter
 
ModelExecutionFilter - Class in info.magnolia.rendering.model
Filter that executes the model for a renderable before template rendering.
ModelExecutionFilter(RendererRegistry, TemplateDefinitionAssignment) - Constructor for class info.magnolia.rendering.model.ModelExecutionFilter
 
ModelExecutionFilter() - Constructor for class info.magnolia.rendering.model.ModelExecutionFilter
MODULES_ROOT_DIR - Static variable in class info.magnolia.rendering.module.setup.InstallRendererContextAttributeTask
 

N

NEW_RENDERING_LISTENERS_LOCATION - Static variable in class info.magnolia.rendering.module.setup.MigrateRenderingListenersTask
 
newContext() - Method in class info.magnolia.rendering.renderer.AbstractRenderer
Create a new context object which is a map.
newContext() - Method in class info.magnolia.rendering.renderer.FreemarkerRenderer
 
newContext() - Method in class info.magnolia.rendering.renderer.JspRenderer
We expose nodes as Map instances in JSPs.
newMetadataBuilder() - Method in class info.magnolia.rendering.renderer.registry.RendererRegistry
 
newMetadataBuilder() - Method in class info.magnolia.rendering.template.registry.TemplateDefinitionRegistry
 
newModel(Node, RenderableDefinition, RenderingModel<?>) - Method in class info.magnolia.rendering.renderer.AbstractRenderer
Instantiates the model based on the class defined by the RenderableDefinition.getModelClass() property.
newModel(Class<T>, Node, RenderableDefinition, RenderingModel<?>) - Method in class info.magnolia.rendering.renderer.AbstractRenderer
 
newModel(Node, RenderableDefinition, RenderingModel<?>) - Method in interface info.magnolia.rendering.renderer.RenderingModelBasedRenderer
 
NODE_TYPE - Static variable in interface info.magnolia.rendering.template.AutoGenerationConfiguration
 
NodeDepthComparator() - Constructor for class info.magnolia.rendering.template.configured.ConfiguredInheritance.NodeDepthComparator
 
NoopVariationResolver - Class in info.magnolia.rendering.template.variation
Variation resolver that ignores any variations, effectively turning the feature off.
NoopVariationResolver() - Constructor for class info.magnolia.rendering.template.variation.NoopVariationResolver
 

O

OLD_RENDERING_LISTENERS_LOCATION - Static variable in class info.magnolia.rendering.module.setup.MigrateRenderingListenersTask
 
onRegister(DefinitionProvider<TemplateDefinition>) - Method in class info.magnolia.rendering.template.registry.TemplateDefinitionRegistry
 
onRender(Node, RenderableDefinition, RenderingContext, Map<String, Object>, String) - Method in class info.magnolia.rendering.renderer.AbstractRenderer
Finally execute the rendering.
onRender(Node, RenderableDefinition, RenderingContext, Map<String, Object>, String) - Method in class info.magnolia.rendering.renderer.FreemarkerRenderer
 
onRender(Node, RenderableDefinition, RenderingContext, Map<String, Object>, String) - Method in class info.magnolia.rendering.renderer.JspRenderer
 
OutputProvider - Interface in info.magnolia.rendering.engine
Output provider interface.

P

parameters - Variable in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
parentModel - Variable in class info.magnolia.rendering.model.RenderingModelImpl
 
pop() - Method in class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
pop() - Method in interface info.magnolia.rendering.context.RenderingContext
 
processBeforeInjection(String, Node, RenderableDefinition) - Method in class info.magnolia.rendering.listeners.AbstractInjectionListener
 
PROPERTIES_ALL - Static variable in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
PROPERTIES_NONE - Static variable in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
push(Node, RenderableDefinition) - Method in class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
push(Node, RenderableDefinition, OutputProvider) - Method in class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
push(Node, RenderableDefinition) - Method in interface info.magnolia.rendering.context.RenderingContext
Pushes the content and renderableDefinition to be used for rendering.
push(Node, RenderableDefinition, OutputProvider) - Method in interface info.magnolia.rendering.context.RenderingContext
Pushes the content and renderableDefinition to be used for rendering.

R

register(RendererProvider) - Method in class info.magnolia.rendering.renderer.registry.RendererRegistry
Deprecated.
since 5.4
register(TemplateDefinitionProvider) - Method in class info.magnolia.rendering.template.registry.TemplateDefinitionRegistry
Deprecated.
since 5.4
registerListener(String) - Method in class info.magnolia.rendering.renderer.registry.RendererRegistry
Deprecated.
since 5.4. Listeners are now instantiated under (/server/rendering/engine/listeners)
reload(List) - Method in class info.magnolia.rendering.renderer.registry.ConfiguredRendererManager
Deprecated.
 
render(Node, OutputProvider) - Method in class info.magnolia.rendering.engine.DefaultRenderingEngine
 
render(Node, Map<String, Object>, OutputProvider) - Method in class info.magnolia.rendering.engine.DefaultRenderingEngine
 
render(Node, RenderableDefinition, Map<String, Object>, OutputProvider) - Method in class info.magnolia.rendering.engine.DefaultRenderingEngine
 
render(Node, OutputProvider) - Method in interface info.magnolia.rendering.engine.RenderingEngine
Renders the content with its assigned template.
render(Node, Map<String, Object>, OutputProvider) - Method in interface info.magnolia.rendering.engine.RenderingEngine
Renders the content with its assigned template and exposes the given context objects to the template script.
render(Node, RenderableDefinition, Map<String, Object>, OutputProvider) - Method in interface info.magnolia.rendering.engine.RenderingEngine
Uses a specific RenderableDefinition to render the content and exposes the given context objects to the template script.
render(Node, String, HttpServletResponse) - Method in class info.magnolia.rendering.engine.RenderingFilter
 
render(RenderingContext, Map<String, Object>) - Method in class info.magnolia.rendering.renderer.AbstractRenderer
 
render(RenderingContext, Map<String, Object>) - Method in interface info.magnolia.rendering.renderer.Renderer
Called by RenderingEngine after it has setup the RenderingContext.
RENDER_EMPTY_AREAS_PROPERTY - Static variable in class info.magnolia.rendering.renderer.registry.ConfiguredRendererManager
Deprecated.
since 5.4. Unused.
RENDER_ERROR_MESSAGE_BEGIN - Static variable in class info.magnolia.rendering.engine.ModeDependentRenderExceptionHandler
 
RENDER_ERROR_MESSAGE_END - Static variable in class info.magnolia.rendering.engine.ModeDependentRenderExceptionHandler
 
RenderableDefinition - Interface in info.magnolia.rendering.template
Base interface for all renderables.
RenderableDefinitionKeyGenerator - Class in info.magnolia.rendering.template.i18n
I18nKeyGenerator for RenderableDefinition.
RenderableDefinitionKeyGenerator() - Constructor for class info.magnolia.rendering.template.i18n.RenderableDefinitionKeyGenerator
 
RenderableVariationResolver - Interface in info.magnolia.rendering.template.variation
Resolves a variation for a renderable definition that is about to be rendered.
Renderer - Interface in info.magnolia.rendering.renderer
Responsible for rendering a renderable.
RendererProvider - Interface in info.magnolia.rendering.renderer.registry
Deprecated.
since 5.4 use DefinitionProvider.
RendererRegistry - Class in info.magnolia.rendering.renderer.registry
Central registry of all renderers.
RendererRegistry(ModuleRegistry) - Constructor for class info.magnolia.rendering.renderer.registry.RendererRegistry
 
RendererRegistry() - Constructor for class info.magnolia.rendering.renderer.registry.RendererRegistry
Deprecated.
RENDERERS_NODE - Static variable in class info.magnolia.rendering.module.setup.InstallRendererContextAttributeTask
 
RenderException - Exception in info.magnolia.rendering.engine
A generic exception used by subclasses of AbstractRenderer.
RenderException(String) - Constructor for exception info.magnolia.rendering.engine.RenderException
 
RenderException(Throwable) - Constructor for exception info.magnolia.rendering.engine.RenderException
 
RenderException(String, Throwable) - Constructor for exception info.magnolia.rendering.engine.RenderException
 
RenderExceptionHandler - Interface in info.magnolia.rendering.engine
Handler for RenderException.
RenderingContext - Interface in info.magnolia.rendering.context
Provides all information needed in the rendering process.
RenderingEngine - Interface in info.magnolia.rendering.engine
The RenderingEngine is the main entry point for rendering content.
RenderingFilter - Class in info.magnolia.rendering.engine
Filter responsible for rendering the current aggregation state, by delegating to the appropriate TemplateRenderer or by serving binary content.
RenderingFilter(RenderingEngine, TemplateDefinitionRegistry) - Constructor for class info.magnolia.rendering.engine.RenderingFilter
 
RenderingListener - Interface in info.magnolia.rendering.context
Deprecated.
since 5.4. Use AbstractRenderingListener instead.
RenderingModel<RD extends RenderableDefinition> - Interface in info.magnolia.rendering.model
A RenderingModel is used during rendering, it is analogous to the model part of the MVC pattern.
RenderingModelBasedRenderer - Interface in info.magnolia.rendering.renderer
Implemented by renderers that uses RenderingModel.
RenderingModelImpl<RD extends RenderableDefinition> - Class in info.magnolia.rendering.model
The default concrete rendering definition used for templates and components.
RenderingModelImpl(Node, RD, RenderingModel<?>) - Constructor for class info.magnolia.rendering.model.RenderingModelImpl
 
RenderingModule - Class in info.magnolia.rendering.module
Registers configuration sources for TemplateDefinitionRegistry and RendererRegistry.
RenderingModule(ConfigurationSourceFactory, TemplateDefinitionRegistry, RendererRegistry) - Constructor for class info.magnolia.rendering.module.RenderingModule
 
RenderingModuleVersionHandler - Class in info.magnolia.rendering.module.setup
Rendering VersionHandler.
RenderingModuleVersionHandler() - Constructor for class info.magnolia.rendering.module.setup.RenderingModuleVersionHandler
 
resolveTemplateScript(Node, RenderableDefinition, RenderingModel<?>, String) - Method in class info.magnolia.rendering.renderer.AbstractRenderer
Hook-method to be overriden when required.
resolveVariation(RenderableDefinition) - Method in class info.magnolia.rendering.template.variation.ChannelVariationResolver
 
resolveVariation(RenderableDefinition) - Method in class info.magnolia.rendering.template.variation.DefaultRenderableVariationResolver
 
resolveVariation(RenderableDefinition) - Method in class info.magnolia.rendering.template.variation.ExtensionVariationResolver
 
resolveVariation(RenderableDefinition) - Method in class info.magnolia.rendering.template.variation.NoopVariationResolver
 
resolveVariation(RenderableDefinition) - Method in interface info.magnolia.rendering.template.variation.RenderableVariationResolver
Returns the variation to use or null.
ResponseOutputProvider - Class in info.magnolia.rendering.engine
Output provider wrapping response.
ResponseOutputProvider(HttpServletResponse) - Constructor for class info.magnolia.rendering.engine.ResponseOutputProvider
 
restoreContext(Map<String, Object>, Map<String, Object>) - Method in class info.magnolia.rendering.renderer.AbstractRenderer
 

S

saveAttribute(Map<String, Object>, Map<String, Object>, String) - Method in class info.magnolia.rendering.renderer.AbstractRenderer
 
saveContextState(Map<String, Object>) - Method in class info.magnolia.rendering.renderer.AbstractRenderer
 
SECTION - Static variable in class info.magnolia.rendering.template.type.DefaultTemplateTypes
 
setAfter(String) - Method in class info.magnolia.rendering.listeners.AbstractInjectionListener
 
setAreas(Map<String, AreaDefinition>) - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
setArguments(Collection<String>) - Method in class info.magnolia.rendering.listeners.AbstractInjectionListener
 
setAttributeName(String) - Method in class info.magnolia.rendering.model.ModelExecutionFilter
 
setAutoGeneration(AutoGenerationConfiguration) - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
setAutoPopulateFromRequest(Boolean) - Method in class info.magnolia.rendering.engine.DefaultRenderingEngine
 
setAutoPopulateFromRequest(Boolean) - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
setAvailableComponents(Map<String, ComponentAvailability>) - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
setBefore(String) - Method in class info.magnolia.rendering.listeners.AbstractInjectionListener
 
setCheckAreaExistence(boolean) - Method in class info.magnolia.rendering.listeners.AreaFilteringListener
 
setComponentClass(Class) - Method in class info.magnolia.rendering.renderer.ContextAttributeConfiguration
 
setComponents(String) - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
setContent(Map<String, Map<?, ?>>) - Method in class info.magnolia.rendering.template.configured.ConfiguredAutoGeneration
 
setContentStructure(String) - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
setContentType(String) - Method in class info.magnolia.rendering.renderer.AbstractRenderer
 
setContextAttribute(Map<String, Object>, String, Object) - Method in class info.magnolia.rendering.renderer.AbstractRenderer
 
setContextAttributes(Map<String, ContextAttributeConfiguration>) - Method in class info.magnolia.rendering.renderer.AbstractRenderer
 
setCreateAreaNode(Boolean) - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
setDeletable(Boolean) - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
setDescription(String) - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
setDialog(String) - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
setEditable(Boolean) - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
setEnabled(boolean) - Method in class info.magnolia.rendering.listeners.AbstractRenderingListener
 
setEnabled(Boolean) - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
setEnabled(boolean) - Method in class info.magnolia.rendering.template.configured.ConfiguredComponentAvailability
 
setEnabled(Boolean) - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
setFragmentDefinition(FragmentDefinition) - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
setGeneratorClass(Class<Generator<AutoGenerationConfiguration>>) - Method in class info.magnolia.rendering.template.configured.ConfiguredAutoGeneration
 
setI18nBasename(String) - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
Deprecated.
since 5.4.4. I18nBasename is deprecated and will be removed in a future version.
setId(String) - Method in class info.magnolia.rendering.template.configured.ConfiguredComponentAvailability
 
setId(String) - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
setId(String) - Method in interface info.magnolia.rendering.template.RenderableDefinition
 
setInheritance(InheritanceConfiguration) - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
setListeners(List<AbstractRenderingListener>) - Method in class info.magnolia.rendering.context.AggregationStateBasedRenderingContext
 
setListeners(List<AbstractRenderingListener>) - Method in interface info.magnolia.rendering.context.RenderingContext
 
setListeners(LinkedList<AbstractRenderingListener>) - Method in class info.magnolia.rendering.engine.DefaultRenderingEngine
 
setMaxComponents(Integer) - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
setModelClass(Class) - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
setMoveable(Boolean) - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
setName(String) - Method in class info.magnolia.rendering.renderer.ContextAttributeConfiguration
 
setName(String) - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
setNodeComparatorClass(Class<? extends Comparator<Node>>) - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
setNodeTypes(List<String>) - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
setNodeTypes(List<String>) - Method in class info.magnolia.rendering.template.configured.InheritancePredicate
 
setOptional(Boolean) - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
setParameters(Map<String, Object>) - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
setParent(RenderingModel) - Method in interface info.magnolia.rendering.model.EarlyExecutionAware
Called before rendering of the component.
setPermissions(OperationPermissionDefinition) - Method in class info.magnolia.rendering.template.configured.ConfiguredComponentAvailability
 
setPredicateClass(Class<? extends AbstractPredicate<Node>>) - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
setProperties(String) - Method in class info.magnolia.rendering.template.configured.ConfiguredInheritance
 
setRenderEmptyAreas(Boolean) - Method in class info.magnolia.rendering.engine.DefaultRenderingEngine
 
setRenderType(String) - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
setRoles(Collection<String>) - Method in class info.magnolia.rendering.template.configured.ConfiguredComponentAvailability
 
setShouldProcess(VoterSet<HttpServletResponse>) - Method in class info.magnolia.rendering.listeners.AbstractRenderingListener
 
setSkipRendering(boolean) - Method in class info.magnolia.rendering.listeners.AbstractInjectionListener
 
setSubtype(String) - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
setTemplateAvailability(TemplateAvailability) - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
setTemplateScript(String) - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
setTerminateChain(boolean) - Method in class info.magnolia.rendering.engine.RenderingFilter
 
setTitle(String) - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
setType(String) - Method in class info.magnolia.rendering.template.configured.ConfiguredAreaDefinition
 
setType(String) - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
setupContext(Map<String, Object>, Node, RenderableDefinition, RenderingModel<?>, Object) - Method in class info.magnolia.rendering.renderer.AbstractRenderer
 
setVariations(Map<String, RenderableDefinition>) - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
setVisible(Boolean) - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
setWrappedAppendable(Appendable) - Method in class info.magnolia.rendering.util.FilteringAppendableWrapper
 
setWritable(Boolean) - Method in class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition
 
setWriteEnabled(boolean) - Method in class info.magnolia.rendering.engine.FilteringResponseOutputProvider
 
setWriteEnabled(boolean) - Method in class info.magnolia.rendering.util.FilteringAppendableWrapper
 
setWriteEnabled(boolean) - Method in class info.magnolia.rendering.util.FilteringWriter
Deprecated.
 
shouldInclude(Node, RenderableDefinition) - Method in class info.magnolia.rendering.listeners.AbstractInjectionListener
 
shouldProcess(HttpServletResponse) - Method in class info.magnolia.rendering.listeners.AbstractRenderingListener
 
SITE_ROOT - Static variable in class info.magnolia.rendering.template.type.DefaultTemplateTypes
 
SKIP_RENDERING - Static variable in interface info.magnolia.rendering.model.RenderingModel
A constant used in some special cases where rendering must be skipped, i.e. a redirect template.
start(ModuleLifecycleContext) - Method in class info.magnolia.rendering.module.RenderingModule
 
start() - Method in class info.magnolia.rendering.renderer.registry.ConfiguredRendererManager
Deprecated.
 
start() - Method in class info.magnolia.rendering.template.registry.ConfiguredTemplateDefinitionManager
Deprecated.
 
stop(ModuleLifecycleContext) - Method in class info.magnolia.rendering.module.RenderingModule
 

T

TEMPLATE_ID - Static variable in interface info.magnolia.rendering.template.AutoGenerationConfiguration
 
TemplateAvailability - Interface in info.magnolia.rendering.template
Strategy interface for controlling where a template can be used.
TemplateDefinition - Interface in info.magnolia.rendering.template
A RenderableDefinition which supports editing in the page editor and can define their areas.
TemplateDefinitionAssignment - Interface in info.magnolia.rendering.template.assignment
Knows which template to use for the rendering of the content.
TemplateDefinitionProvider - Interface in info.magnolia.rendering.template.registry
Deprecated.
since 5.4 use DefinitionProvider.
TemplateDefinitionRegistry - Class in info.magnolia.rendering.template.registry
The central registry of all TemplateDefinitions.
TemplateDefinitionRegistry(ModuleRegistry) - Constructor for class info.magnolia.rendering.template.registry.TemplateDefinitionRegistry
 
TemplateDefinitionRegistry() - Constructor for class info.magnolia.rendering.template.registry.TemplateDefinitionRegistry
TemplateTypeHelper - Class in info.magnolia.rendering.template.type
Helper functions for DefaultTemplateTypes, i.e. template types set for a TemplateDefinition (see: TemplateDefinition.getType() and TemplateDefinition.getSubtype()).
TemplateTypeHelper(TemplateDefinitionRegistry) - Constructor for class info.magnolia.rendering.template.type.TemplateTypeHelper
 
toString() - Method in class info.magnolia.rendering.renderer.registry.ConfiguredRendererProvider
Deprecated.
 
toString() - Method in class info.magnolia.rendering.template.configured.ConfiguredAutoGeneration
 
toString() - Method in class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition
 
toString() - Method in class info.magnolia.rendering.template.registry.ConfiguredTemplateDefinitionProvider
Deprecated.
 
type() - Method in class info.magnolia.rendering.renderer.registry.RendererRegistry
 
type() - Method in class info.magnolia.rendering.template.registry.TemplateDefinitionRegistry
 
TYPE_LIST - Static variable in interface info.magnolia.rendering.template.AreaDefinition
 
TYPE_NO_COMPONENT - Static variable in interface info.magnolia.rendering.template.AreaDefinition
 
TYPE_SINGLE - Static variable in interface info.magnolia.rendering.template.AreaDefinition
 

V

valueOf(String) - Static method in enum info.magnolia.rendering.DefinitionTypes
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum info.magnolia.rendering.listeners.AbstractRenderingListener.RenderingListenerReturnCode
Returns the enum constant of this type with the specified name.
values() - Static method in enum info.magnolia.rendering.DefinitionTypes
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum info.magnolia.rendering.listeners.AbstractRenderingListener.RenderingListenerReturnCode
Returns an array containing the constants of this enum type, in the order they are declared.

W

wrapNodeForModel(Node) - Method in class info.magnolia.rendering.renderer.AbstractRenderer
Wraps the current content node before passing it to the model.
wrapNodeForTemplate(Node) - Method in class info.magnolia.rendering.renderer.AbstractRenderer
Wraps the current content node for exposing it to the template script as a context attribute.
write(char[], int, int) - Method in class info.magnolia.rendering.util.AppendableWriter
 
write(char[], int, int) - Method in class info.magnolia.rendering.util.FilteringWriter
Deprecated.
 
A B C D E F G H I J K L M N O P R S T V W 
Skip navigation links

Copyright © 2003–2017 Magnolia International Ltd.. All rights reserved.