info.magnolia.templating.elements

Class AreaElement

java.lang.Object

info.magnolia.templating.elements.AbstractTemplatingElement

info.magnolia.templating.elements.AbstractContentTemplatingElement

info.magnolia.templating.elements.AreaElement

All Implemented Interfaces:

TemplatingElement

public class AreaElement
extends AbstractContentTemplatingElement

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_COMPONENT
static String	ATTRIBUTE_COMPONENTS

Constructor Summary

Constructors

Constructor and Description
AreaElement(info.magnolia.cms.beans.config.ServerConfiguration server, info.magnolia.rendering.context.RenderingContext renderingContext, info.magnolia.rendering.engine.RenderingEngine renderingEngine, info.magnolia.rendering.template.variation.RenderableVariationResolver variationResolver, info.magnolia.i18nsystem.I18nizer i18nizer) Deprecated. since 6.1, use AreaElement(info.magnolia.cms.beans.config.ServerConfiguration, info.magnolia.rendering.context.RenderingContext, info.magnolia.rendering.engine.RenderingEngine, info.magnolia.rendering.template.variation.RenderableVariationResolver, javax.inject.Provider, info.magnolia.context.WebContext) instead.
AreaElement(info.magnolia.cms.beans.config.ServerConfiguration server, info.magnolia.rendering.context.RenderingContext renderingContext, info.magnolia.rendering.engine.RenderingEngine renderingEngine, info.magnolia.rendering.template.variation.RenderableVariationResolver variationResolver, javax.inject.Provider<TemplatingModule> templatingModuleProvider, info.magnolia.context.WebContext webContext)

Method Summary

Modifier and Type	Method and Description
void	begin(Appendable out)
protected void	buildAdHocAreaDefinition()
void	end(Appendable out) Override this method if you need to "do something" once the component is rendered, i.e cleanup the context.
info.magnolia.rendering.template.AreaDefinition	getArea()
info.magnolia.rendering.template.AreaDefinition	getAreaDefinition()
String	getAvailableComponents()
Map<String,Object>	getContextAttributes()
Boolean	getCreateAreaNode()
String	getDescription()
String	getDialog()
String	getLabel()
Integer	getMaxComponents()
String	getName()
Boolean	getOptional()
String	getType()
boolean	isInherit()
protected boolean	renderComments() Override to set conditions for rendering of cms:comments.
protected info.magnolia.rendering.template.AreaDefinition	resolveAreaDefinition()
protected String	resolveAvailableComponents() Deprecated. since 6.1. Use AvailableComponents instead.
protected info.magnolia.rendering.template.TemplateDefinition	resolveTemplateDefinition()
void	setArea(info.magnolia.rendering.template.AreaDefinition area)
void	setAvailableComponents(String availableComponents)
void	setContextAttributes(Map<String,Object> contextAttributes)
void	setCreateAreaNode(Boolean createAreaNode)
void	setDescription(String description)
void	setDialog(String dialog)
void	setInherit(boolean inherit)
void	setLabel(String label)
void	setMaxComponents(Integer maxComponents)
void	setName(String name)
void	setType(String type)
protected javax.jcr.Node	tryToCreateAreaNode(javax.jcr.Node parentNode)

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

getActivationStatus, getContent, getEditable, getNodeIdentifier, getNodePath, getPassedContent, getPath, getTemplateDefinition, getWebContext, getWorkspace, isMessageKey, legacyTranslate, restoreAttributesInWebContext, setAttributesInWebContext, setContent, 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

ATTRIBUTE_COMPONENT

public static final String ATTRIBUTE_COMPONENT

See Also:

Constant Field Values

ATTRIBUTE_COMPONENTS

public static final String ATTRIBUTE_COMPONENTS

See Also:

Constant Field Values

Constructor Detail

AreaElement

@Inject
public AreaElement(info.magnolia.cms.beans.config.ServerConfiguration server,
                           info.magnolia.rendering.context.RenderingContext renderingContext,
                           info.magnolia.rendering.engine.RenderingEngine renderingEngine,
                           info.magnolia.rendering.template.variation.RenderableVariationResolver variationResolver,
                           javax.inject.Provider<TemplatingModule> templatingModuleProvider,
                           info.magnolia.context.WebContext webContext)

AreaElement

@Deprecated
public AreaElement(info.magnolia.cms.beans.config.ServerConfiguration server,
                               info.magnolia.rendering.context.RenderingContext renderingContext,
                               info.magnolia.rendering.engine.RenderingEngine renderingEngine,
                               info.magnolia.rendering.template.variation.RenderableVariationResolver variationResolver,
                               info.magnolia.i18nsystem.I18nizer i18nizer)

Deprecated. since 6.1, use AreaElement(info.magnolia.cms.beans.config.ServerConfiguration, info.magnolia.rendering.context.RenderingContext, info.magnolia.rendering.engine.RenderingEngine, info.magnolia.rendering.template.variation.RenderableVariationResolver, javax.inject.Provider, info.magnolia.context.WebContext) instead.

Method Detail

begin

public void begin(Appendable out)
           throws IOException,
                  info.magnolia.rendering.engine.RenderException

Specified by:

begin in interface TemplatingElement

Overrides:

begin in class AbstractTemplatingElement

Throws:

IOException

info.magnolia.rendering.engine.RenderException

buildAdHocAreaDefinition

protected void buildAdHocAreaDefinition()

end

public void end(Appendable out)
         throws info.magnolia.rendering.engine.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:

info.magnolia.rendering.engine.RenderException

tryToCreateAreaNode

protected javax.jcr.Node tryToCreateAreaNode(javax.jcr.Node parentNode)
                                      throws info.magnolia.rendering.engine.RenderException

Throws:

info.magnolia.rendering.engine.RenderException

resolveAreaDefinition

protected info.magnolia.rendering.template.AreaDefinition resolveAreaDefinition()

resolveTemplateDefinition

protected info.magnolia.rendering.template.TemplateDefinition resolveTemplateDefinition()
                                                                                 throws info.magnolia.rendering.engine.RenderException

Throws:

info.magnolia.rendering.engine.RenderException

resolveAvailableComponents

@Deprecated
protected String resolveAvailableComponents()

Deprecated. since 6.1. Use AvailableComponents instead.

getName

public String getName()

setName

public void setName(String name)

getArea

public info.magnolia.rendering.template.AreaDefinition getArea()

setArea

public void setArea(info.magnolia.rendering.template.AreaDefinition area)

getAvailableComponents

public String getAvailableComponents()

setAvailableComponents

public void setAvailableComponents(String availableComponents)

getType

public String getType()

setType

public void setType(String type)

getDialog

public String getDialog()

Overrides:

getDialog in class AbstractContentTemplatingElement

setDialog

public void setDialog(String dialog)

Overrides:

setDialog in class AbstractContentTemplatingElement

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

isInherit

public boolean isInherit()

setInherit

public void setInherit(boolean inherit)

getContextAttributes

public Map<String,Object> getContextAttributes()

setContextAttributes

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

getMaxComponents

public Integer getMaxComponents()

setMaxComponents

public void setMaxComponents(Integer maxComponents)

getCreateAreaNode

public Boolean getCreateAreaNode()

setCreateAreaNode

public void setCreateAreaNode(Boolean createAreaNode)

getAreaDefinition

public info.magnolia.rendering.template.AreaDefinition getAreaDefinition()

getOptional

public Boolean getOptional()

renderComments

protected boolean renderComments()

Description copied from class: AbstractContentTemplatingElement

Override to set conditions for rendering of cms:comments.

Overrides:

renderComments in class AbstractContentTemplatingElement