info.magnolia.rendering.template
Interface AreaDefinition

All Superinterfaces:

Cloneable, RenderableDefinition, TemplateDefinition

All Known Implementing Classes:

ConfiguredAreaDefinition

public interface AreaDefinition
extends TemplateDefinition, Cloneable

Definition for a Area.

Version:

$Id$

Field Summary

static String	DEFAULT_TYPE
static String	TYPE_LIST
static String	TYPE_NO_COMPONENT
static String	TYPE_SINGLE

Method Summary

Map<String,ComponentAvailability>	getAvailableComponents()
InheritanceConfiguration	getInheritance()
String	getType()
boolean	isEnabled()
boolean	isOptional() If an area is optional it has first to be created explicitly (i.e.

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

getAreas, getDialog

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

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

Field Detail

TYPE_NO_COMPONENT

static final String TYPE_NO_COMPONENT

See Also:

Constant Field Values

TYPE_LIST

static final String TYPE_LIST

See Also:

Constant Field Values

TYPE_SINGLE

static final String TYPE_SINGLE

See Also:

Constant Field Values

DEFAULT_TYPE

static final String DEFAULT_TYPE

See Also:

Constant Field Values

Method Detail

getAvailableComponents

Map<String,ComponentAvailability> getAvailableComponents()

isEnabled

boolean isEnabled()

getType

String getType()

getInheritance

InheritanceConfiguration getInheritance()

isOptional

boolean isOptional()

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.