View Javadoc

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.configured;
35  
36  import info.magnolia.rendering.template.AreaDefinition;
37  import info.magnolia.rendering.template.TemplateAvailability;
38  import info.magnolia.rendering.template.TemplateDefinition;
39  
40  import java.util.HashMap;
41  import java.util.Map;
42  
43  import javax.inject.Inject;
44  
45  /**
46   * A {@link TemplateDefinition} configured in the configuration workspace.
47   */
48  public class ConfiguredTemplateDefinition extends ConfiguredRenderableDefinition implements TemplateDefinition {
49  
50      private Boolean visible;
51      private String dialog;
52      private Map<String, AreaDefinition> areaDefinitions = new HashMap<String, AreaDefinition>();
53      private Boolean editable;
54  
55      private Boolean moveable;
56      private Boolean deletable;
57      private Boolean writable;
58  
59      private TemplateAvailability templateAvailability;
60  
61      /**
62       * @deprecated use {@link #ConfiguredTemplateDefinition(TemplateAvailability templateAvailability)}
63       */
64      public ConfiguredTemplateDefinition() {
65          this.templateAvailability = new ConfiguredTemplateAvailability();
66      }
67  
68      @Inject
69      public ConfiguredTemplateDefinition(TemplateAvailability templateAvailability) {
70          this.templateAvailability = templateAvailability;
71      }
72  
73      @Override
74      public Boolean getVisible() {
75          return visible;
76      }
77  
78      public void setVisible(Boolean visible) {
79          this.visible = visible;
80      }
81  
82      @Override
83      public Boolean getEditable() {
84          return editable;
85      }
86  
87      public void setEditable(Boolean editable) {
88          this.editable = editable;
89      }
90  
91      @Override
92      public Boolean getMoveable() {
93          return moveable;
94      }
95  
96      public void setMoveable(Boolean moveable) {
97          this.moveable = moveable;
98      }
99  
100     @Override
101     public Boolean getDeletable() {
102         return deletable;
103     }
104 
105     public void setDeletable(Boolean deletable) {
106         this.deletable = deletable;
107     }
108 
109     @Override
110     public Boolean getWritable() {
111         return writable;
112     }
113 
114     public void setWritable(Boolean writable) {
115         this.writable = writable;
116     }
117 
118     @Override
119     public String getDialog() {
120         return this.dialog;
121     }
122 
123     public void setDialog(String dialog) {
124         this.dialog = dialog;
125     }
126 
127     @Override
128     public Map<String, AreaDefinition> getAreas() {
129         return this.areaDefinitions;
130     }
131 
132     public void setAreas(Map<String, AreaDefinition> areaDefinitions) {
133         this.areaDefinitions = areaDefinitions;
134     }
135 
136     public void addArea(String name, AreaDefinition areaDefinition){
137         this.areaDefinitions.put(name, areaDefinition);
138     }
139 
140     @Override
141     public TemplateAvailability getTemplateAvailability() {
142         return templateAvailability;
143     }
144 
145     public void setTemplateAvailability(TemplateAvailability templateAvailability) {
146         this.templateAvailability = templateAvailability;
147     }
148 }