info.magnolia.rendering.template.configured

Class ConfiguredAreaDefinition

java.lang.Object

info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition

info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition

info.magnolia.rendering.template.configured.ConfiguredAreaDefinition

All Implemented Interfaces:

NamedDefinition, AreaDefinition, RenderableDefinition, TemplateDefinition, Cloneable

public class ConfiguredAreaDefinition
extends ConfiguredTemplateDefinition
implements AreaDefinition

A AreaDefinition configured in the configuration workspace.

Field Summary

Fields inherited from class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition

parameters

Fields inherited from interface info.magnolia.rendering.template.AreaDefinition

CMS_ADD, CMS_EDIT, CMS_PLACEHOLDER, CONTENT_STRUCTURE_FLAT, CONTENT_STRUCTURE_NODE, DEFAULT_TYPE, TYPE_LIST, TYPE_NO_COMPONENT, TYPE_SINGLE

Constructor Summary

Constructors

Constructor and Description
ConfiguredAreaDefinition() Deprecated. since 5.3.3 use ConfiguredAreaDefinition(TemplateAvailability templateAvailability)
ConfiguredAreaDefinition(TemplateAvailability templateAvailability)

Method Summary

Modifier and Type	Method and Description
void	addAvailableComponent(String name, ComponentAvailability configuredComponentAvailability)
Map<String,ComponentAvailability>	getAvailableComponents()
String	getContentStructure()
Boolean	getCreateAreaNode()
Boolean	getEnabled()
InheritanceConfiguration	getInheritance()
Integer	getMaxComponents()
Boolean	getOptional() If an area is optional it has first to be created explicitly (i.e. via a create button).
String	getType() Specifies the template type, e.g.
Boolean	isEnabled()
Boolean	isOptional() If an area is optional it has first to be created explicitly (i.e. via a create button).
void	setAvailableComponents(Map<String,ComponentAvailability> availableComponents)
void	setContentStructure(String contentStructure)
void	setCreateAreaNode(Boolean createAreaNode)
void	setEnabled(Boolean enabled)
void	setInheritance(InheritanceConfiguration inheritanceConfiguration)
void	setMaxComponents(Integer maxComponents)
void	setOptional(Boolean optional)
void	setType(String type)

Methods inherited from class info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition

addArea, getAreas, getDeletable, getDialog, getEditable, getMoveable, getSubtype, getTemplateAvailability, getVisible, getWritable, setAreas, setDeletable, setDialog, setEditable, setMoveable, setSubtype, setTemplateAvailability, setVisible, setWritable

Methods inherited from class info.magnolia.rendering.template.configured.ConfiguredRenderableDefinition

addParameter, addVariation, getAutoGeneration, getAutoPopulateFromRequest, getDescription, getFragmentDefinition, getI18nBasename, getId, getModelClass, getName, getParameters, getRenderType, getTemplateScript, getTitle, getVariations, setAutoGeneration, setAutoPopulateFromRequest, setDescription, setFragmentDefinition, setI18nBasename, setId, setModelClass, setName, setParameters, setRenderType, setTemplateScript, setTitle, setVariations, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.magnolia.rendering.template.TemplateDefinition

getAreas, getDeletable, getDialog, getEditable, getMoveable, getSubtype, getTemplateAvailability, getVisible, getWritable

Methods inherited from interface info.magnolia.rendering.template.RenderableDefinition

getAutoGeneration, getAutoPopulateFromRequest, getDescription, getFragmentDefinition, getI18nBasename, getId, getModelClass, getName, getParameters, getRenderType, getTemplateScript, getTitle, getVariations, setId

Constructor Detail

ConfiguredAreaDefinition

public ConfiguredAreaDefinition()

Deprecated. since 5.3.3 use ConfiguredAreaDefinition(TemplateAvailability templateAvailability)

ConfiguredAreaDefinition

@Inject
public ConfiguredAreaDefinition(TemplateAvailability templateAvailability)

Method Detail

getAvailableComponents

public Map<String,ComponentAvailability> getAvailableComponents()

Specified by:

getAvailableComponents in interface AreaDefinition

setAvailableComponents

public void setAvailableComponents(Map<String,ComponentAvailability> availableComponents)

addAvailableComponent

public void addAvailableComponent(String name,
                                  ComponentAvailability configuredComponentAvailability)

getEnabled

public Boolean getEnabled()

Specified by:

getEnabled in interface AreaDefinition

setEnabled

public void setEnabled(Boolean enabled)

getType

public String getType()

Description copied from interface: TemplateDefinition

Specifies the template type, e.g. "home", "section", etc.

Specified by:

getType in interface AreaDefinition

Specified by:

getType in interface TemplateDefinition

Overrides:

getType in class ConfiguredTemplateDefinition

setType

public void setType(String type)

Overrides:

setType in class ConfiguredTemplateDefinition

getContentStructure

public String getContentStructure()

Specified by:

getContentStructure in interface AreaDefinition

setContentStructure

public void setContentStructure(String contentStructure)

getInheritance

public InheritanceConfiguration getInheritance()

Specified by:

getInheritance in interface AreaDefinition

setInheritance

public void setInheritance(InheritanceConfiguration inheritanceConfiguration)

isOptional

public Boolean isOptional()

Description copied from interface: AreaDefinition

If an area is optional it has first to be created explicitly (i.e. via a create button). Optional areas can be removed (i.e. via a remove button), whereas non optional (namely required) areas are always created and can not be removed. By default, areas are required.

Specified by:

isOptional in interface AreaDefinition

isEnabled

public Boolean isEnabled()

Specified by:

isEnabled in interface AreaDefinition

getOptional

public Boolean getOptional()

Description copied from interface: AreaDefinition

If an area is optional it has first to be created explicitly (i.e. via a create button). Optional areas can be removed (i.e. via a remove button), whereas non optional (namely required) areas are always created and can not be removed. By default, areas are required.

Specified by:

getOptional in interface AreaDefinition

setOptional

public void setOptional(Boolean optional)

getMaxComponents

public Integer getMaxComponents()

Specified by:

getMaxComponents in interface AreaDefinition

setCreateAreaNode

public void setCreateAreaNode(Boolean createAreaNode)

getCreateAreaNode

public Boolean getCreateAreaNode()

Specified by:

getCreateAreaNode in interface AreaDefinition

setMaxComponents

public void setMaxComponents(Integer maxComponents)