1 /**
2 * This file Copyright (c) 2011-2013 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.rendering.template;
35
36
37 import java.util.Map;
38
39
40 /**
41 * Definition for a Area.
42 *
43 * @version $Id$
44 */
45 public interface AreaDefinition extends TemplateDefinition, Cloneable {
46
47 static final String TYPE_NO_COMPONENT = "noComponent";
48 static final String TYPE_LIST = "list";
49 static final String TYPE_SINGLE = "single";
50 static final String CONTENT_STRUCTURE_FLAT = "flat";
51 static final String CONTENT_STRUCTURE_NODE = "node";
52 static final String DEFAULT_TYPE = TYPE_LIST;
53
54 static final String CMS_ADD = "cms:add";
55 static final String CMS_PLACEHOLDER = "cms:placeholder";
56 static final String CMS_EDIT = "cms:edit";
57
58 Map<String, ComponentAvailability> getAvailableComponents();
59
60 Boolean getEnabled();
61
62 /**
63 * 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
64 * non optional (namely required) areas are always created and can not be removed. <strong>By default, areas are required.</strong>
65 */
66 Boolean getOptional();
67
68 String getType();
69
70 String getContentStructure();
71
72 InheritanceConfiguration getInheritance();
73
74 /**
75 * 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
76 * non optional (namely required) areas are always created and can not be removed. <strong>By default, areas are required.</strong>
77 *
78 * @Deprecated Use {@link #getOptional()} instead.
79 */
80 @Deprecated
81 Boolean isOptional();
82
83 /**
84 * @Deprecated Use {@link #getEnabled()} instead.
85 */
86 @Deprecated
87 Boolean isEnabled();
88
89 Integer getMaxComponents();
90
91 }