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 CMS_ADD
           
static String CMS_EDIT
           
static String CMS_PLACEHOLDER
           
static String CONTENT_STRUCTURE_FLAT
           
static String CONTENT_STRUCTURE_NODE
           
static String DEFAULT_TYPE
           
static String TYPE_LIST
           
static String TYPE_NO_COMPONENT
           
static String TYPE_SINGLE
           
 
Method Summary
 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.
 
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
 

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

CONTENT_STRUCTURE_FLAT

static final String CONTENT_STRUCTURE_FLAT
See Also:
Constant Field Values

CONTENT_STRUCTURE_NODE

static final String CONTENT_STRUCTURE_NODE
See Also:
Constant Field Values

DEFAULT_TYPE

static final String DEFAULT_TYPE
See Also:
Constant Field Values

CMS_ADD

static final String CMS_ADD
See Also:
Constant Field Values

CMS_PLACEHOLDER

static final String CMS_PLACEHOLDER
See Also:
Constant Field Values

CMS_EDIT

static final String CMS_EDIT
See Also:
Constant Field Values
Method Detail

getAvailableComponents

Map<String,ComponentAvailability> getAvailableComponents()

isEnabled

Boolean isEnabled()

getType

String getType()

getContentStructure

String getContentStructure()

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.



Copyright © 2003-2012 Magnolia International Ltd.. All Rights Reserved.