View Javadoc
1   /**
2    * This file Copyright (c) 2008-2018 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.module.templatingkit.templates.pages;
35  
36  import info.magnolia.module.templatingkit.resources.Resource;
37  import info.magnolia.module.templatingkit.style.CssFile;
38  import info.magnolia.module.templatingkit.templates.ExtrasArea;
39  import info.magnolia.module.templatingkit.templates.STKTemplateAvailability;
40  import info.magnolia.module.templatingkit.templates.SiteNavigation;
41  import info.magnolia.rendering.template.AreaDefinition;
42  import info.magnolia.rendering.template.configured.ConfiguredTemplateDefinition;
43  
44  import java.util.ArrayList;
45  import java.util.List;
46  
47  /**
48   * Define the base template definition (Areas settings, base template renderer,....)
49   * configured in the configuration workspace.
50   */
51  public class STKPage extends ConfiguredTemplateDefinition {
52  
53      private SiteNavigation navigation;
54  
55      private String bodyID;
56  
57      private String category = "content";
58  
59      private String subcategory;
60  
61      private String bodyClass;
62  
63      private List<Resource> jsFiles = new ArrayList<Resource>();
64  
65      private List<CssFile> cssFiles = new ArrayList<CssFile>();
66  
67  
68      public STKPage() {
69          super(new STKTemplateAvailability());
70      }
71  
72      /**
73       * Get the specified Area.
74       *
75       * @param key: Area name.
76       * @return Specified area. Null if not defined.
77       */
78      public AreaDefinition getArea(String key) {
79          return this.getAreas().get(key);
80      }
81  
82      /**
83       * Get Extra Area.
84       * Needed for the PoxyBeanMerger. In BodyClassResolver if we uses a (ExtrasArea)getArea("extras"),
85       * the proxy ExtraArea is cast and lost all his properties.
86       */
87      public ExtrasArea getExtrasArea() {
88          return (ExtrasArea) this.getAreas().get("extras");
89      }
90  
91      public String getBodyID() {
92          return bodyID;
93      }
94  
95      public void setBodyID(String bodyID) {
96          this.bodyID = bodyID;
97      }
98  
99      public String getBodyClass() {
100         return this.bodyClass;
101     }
102 
103     public void setBodyClass(String bodyClass) {
104         this.bodyClass = bodyClass;
105     }
106 
107     public SiteNavigation getNavigation() {
108         return this.navigation;
109     }
110 
111     public void setNavigation(SiteNavigation navigation) {
112         this.navigation = navigation;
113     }
114 
115     public String getCategory() {
116         return this.category;
117     }
118 
119     public void setCategory(String category) {
120         this.category = category;
121     }
122 
123     public String getSubcategory() {
124         return this.subcategory;
125     }
126 
127     public void setSubcategory(String subcategory) {
128         this.subcategory = subcategory;
129     }
130 
131     public List<Resource> getJsFiles() {
132         return this.jsFiles;
133     }
134 
135     public void setJsFiles(List<Resource> jsFiles) {
136         this.jsFiles = jsFiles;
137     }
138 
139     public void addJsFile(Resource jsFile) {
140         this.jsFiles.add(jsFile);
141     }
142 
143     public List<CssFile> getCssFiles() {
144         return this.cssFiles;
145     }
146 
147     public void setCssFiles(List<CssFile> cssFiles) {
148         this.cssFiles = cssFiles;
149     }
150 
151     public void addCssFile(CssFile cssFile) {
152         this.cssFiles.add(cssFile);
153     }
154 }