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:

AreaDefinition, RenderableDefinition, TemplateDefinition, Cloneable

public class ConfiguredAreaDefinition
extends ConfiguredTemplateDefinition
implements AreaDefinition

A AreaDefinition configured in the configuration workspace.

Version:

$Id$

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

ConfiguredAreaDefinition()

Method Summary

void	addAvailableComponent(String name, ComponentAvailability configuredComponentAvailability)
Map<String,ComponentAvailability>	getAvailableComponents()
String	getContentStructure()
InheritanceConfiguration	getInheritance()
String	getType()
Boolean	isEnabled()
Boolean	isOptional() If an area is optional it has first to be created explicitly (i.e.
void	setAvailableComponents(Map<String,ComponentAvailability> availableComponents)
void	setContentStructure(String contentStructure)
void	setEnabled(Boolean enabled)
void	setInheritance(InheritanceConfiguration inheritanceConfiguration)
void	setOptional(Boolean optional)
void	setType(String type)

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

addArea, getAreas, getDialog, getEditable, getTemplateAvailability, getVisible, setAreas, setDialog, setEditable, setTemplateAvailability, setVisible

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

addParameter, addVariation, getAutoGeneration, getDescription, getI18nBasename, getId, getModelClass, getName, getParameters, getRenderType, getTemplateScript, getTitle, getVariations, setAutoGeneration, setDescription, 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, getDialog, getEditable, getTemplateAvailability, getVisible

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

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

Constructor Detail

ConfiguredAreaDefinition

public ConfiguredAreaDefinition()

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)

isEnabled

public Boolean isEnabled()

Specified by:

isEnabled in interface AreaDefinition

setEnabled

public void setEnabled(Boolean enabled)

getType

public String getType()

Specified by:

getType in interface AreaDefinition

setType

public void setType(String type)

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

setOptional

public void setOptional(Boolean optional)