AreaDefinition (Magnolia Main Project (Parent) 5.6.5 API)

All Superinterfaces:

Cloneable, NamedDefinition, RenderableDefinition, TemplateDefinition

All Known Implementing Classes:

ConfiguredAreaDefinition
```
public interface AreaDefinition
extends TemplateDefinition, Cloneable
```
Definition for a Area.

Field Summary

Fields
Modifier and Type	Field and Description
`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

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`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.
`String`	`getType()` Specifies the type of area `TYPE_LIST`, `TYPE_SINGLE` and `DEFAULT_TYPE`.
`Boolean`	`isEnabled()` Deprecated. since 5.0 - use `getEnabled()` instead.
`Boolean`	`isOptional()` Deprecated. since 4.5.9 - use `getOptional()` instead.

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

- 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()
```
  - getEnabled
```
Boolean getEnabled()
```
  - getOptional
```
Boolean getOptional()
```
    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.
  - getType
```
String getType()
```
    Specifies the type of area TYPE_LIST, TYPE_SINGLE and DEFAULT_TYPE.
    - TYPE_LIST: area can contain multiple elements
    - TYPE_SINGLE: area can contain one element only
    Specified by:
    
    getType in interface TemplateDefinition
  - getContentStructure
```
String getContentStructure()
```
  - getInheritance
```
InheritanceConfiguration getInheritance()
```
  - isOptional
```
@Deprecated
Boolean isOptional()
```
    Deprecated. since 4.5.9 - use getOptional() instead.
    
    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.
  - isEnabled
```
@Deprecated
Boolean isEnabled()
```
    Deprecated. since 5.0 - use getEnabled() instead.
  - getMaxComponents
```
Integer getMaxComponents()
```
  - getCreateAreaNode
```
Boolean getCreateAreaNode()
```

Interface AreaDefinition

Field Summary

Method Summary

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

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

Field Detail

TYPE_NO_COMPONENT

TYPE_LIST

TYPE_SINGLE

CONTENT_STRUCTURE_FLAT

CONTENT_STRUCTURE_NODE

DEFAULT_TYPE

CMS_ADD

CMS_PLACEHOLDER

CMS_EDIT

Method Detail

getAvailableComponents

getEnabled

getOptional

getType

getContentStructure

getInheritance

isOptional

isEnabled

getMaxComponents

getCreateAreaNode