info.magnolia.templating.elements

Class ComponentElement

java.lang.Object

info.magnolia.templating.elements.AbstractTemplatingElement

info.magnolia.templating.elements.AbstractContentTemplatingElement

info.magnolia.templating.elements.ComponentElement

All Implemented Interfaces:

TemplatingElement

public class ComponentElement
extends AbstractContentTemplatingElement

Renders a piece of content.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CMS_COMPONENT_TAG

Constructor Summary

Constructors

Constructor and Description
ComponentElement(ServerConfiguration server, RenderingContext renderingContext, RenderingEngine renderingEngine, TemplateDefinitionAssignment templateDefinitionAssignment, I18nizer i18nizer, WebContext webContext) Deprecated. since 6.1. Use ComponentElement(info.magnolia.cms.beans.config.ServerConfiguration, info.magnolia.rendering.context.RenderingContext, info.magnolia.rendering.engine.RenderingEngine, info.magnolia.rendering.template.assignment.TemplateDefinitionAssignment, info.magnolia.context.WebContext, javax.inject.Provider) instead.
ComponentElement(ServerConfiguration server, RenderingContext renderingContext, RenderingEngine renderingEngine, TemplateDefinitionAssignment templateDefinitionAssignment, WebContext webContext, javax.inject.Provider<TemplatingModule> templatingModuleProvider)

Method Summary

Modifier and Type	Method and Description
void	begin(Appendable out)
void	end(Appendable out) Override this method if you need to "do something" once the component is rendered, i.e cleanup the context.
Map<String,Object>	getContextAttributes()
OperationPermissionDefinition	getPermissions()
boolean	isRenderEditbar()
protected boolean	renderComments() Override to set conditions for rendering of cms:comments.
void	setContextAttributes(Map<String,Object> contextAttributes)
protected void	setPageEditorAttributes(MarkupHelper helper, javax.jcr.Node node)
void	setRenderEditbar(boolean renderEditbar)

Methods inherited from class info.magnolia.templating.elements.AbstractContentTemplatingElement

getActivationStatus, getContent, getDialog, getEditable, getNodeIdentifier, getNodePath, getPassedContent, getPath, getTemplateDefinition, getWebContext, getWorkspace, isMessageKey, legacyTranslate, restoreAttributesInWebContext, setAttributesInWebContext, setContent, setDialog, setEditable, setNodeIdentifier, setPageEditorAttributes, setPath, setTemplateDefinition, setWorkspace

Methods inherited from class info.magnolia.templating.elements.AbstractTemplatingElement

currentContent, getDefinitionMessage, getInterfaceMessage, getRenderingContext, getServer, isAdmin

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CMS_COMPONENT_TAG

public static final String CMS_COMPONENT_TAG

See Also:

Constant Field Values

Constructor Detail

ComponentElement

@Inject
public ComponentElement(ServerConfiguration server,
                                RenderingContext renderingContext,
                                RenderingEngine renderingEngine,
                                TemplateDefinitionAssignment templateDefinitionAssignment,
                                WebContext webContext,
                                javax.inject.Provider<TemplatingModule> templatingModuleProvider)

ComponentElement

@Deprecated
public ComponentElement(ServerConfiguration server,
                                    RenderingContext renderingContext,
                                    RenderingEngine renderingEngine,
                                    TemplateDefinitionAssignment templateDefinitionAssignment,
                                    I18nizer i18nizer,
                                    WebContext webContext)

Deprecated. since 6.1. Use ComponentElement(info.magnolia.cms.beans.config.ServerConfiguration, info.magnolia.rendering.context.RenderingContext, info.magnolia.rendering.engine.RenderingEngine, info.magnolia.rendering.template.assignment.TemplateDefinitionAssignment, info.magnolia.context.WebContext, javax.inject.Provider) instead.

Method Detail

begin

public void begin(Appendable out)
           throws IOException,
                  RenderException

Specified by:

begin in interface TemplatingElement

Overrides:

begin in class AbstractTemplatingElement

Throws:

IOException

RenderException

setPageEditorAttributes

protected void setPageEditorAttributes(MarkupHelper helper,
                                       javax.jcr.Node node)
                                throws IOException,
                                       RenderException

Throws:

IOException

RenderException

end

public void end(Appendable out)
         throws IOException,
                RenderException

Description copied from class: AbstractTemplatingElement

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

Specified by:

end in interface TemplatingElement

Overrides:

end in class AbstractTemplatingElement

Throws:

IOException

RenderException

getContextAttributes

public Map<String,Object> getContextAttributes()

setContextAttributes

public void setContextAttributes(Map<String,Object> contextAttributes)

isRenderEditbar

public boolean isRenderEditbar()

setRenderEditbar

public void setRenderEditbar(boolean renderEditbar)

renderComments

protected boolean renderComments()

Description copied from class: AbstractContentTemplatingElement

Override to set conditions for rendering of cms:comments.

Overrides:

renderComments in class AbstractContentTemplatingElement

getPermissions

public OperationPermissionDefinition getPermissions()