View Javadoc
1   /**
2    * This file Copyright (c) 2009-2015 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.style;
35  
36  import info.magnolia.module.templatingkit.templates.ExtrasArea;
37  import info.magnolia.module.templatingkit.templates.Floating;
38  import info.magnolia.module.templatingkit.templates.SectionMainArea;
39  import info.magnolia.module.templatingkit.templates.pages.STKPage;
40  import info.magnolia.module.templatingkit.templates.pages.STKPageModel;
41  import info.magnolia.rendering.template.AreaDefinition;
42  
43  import org.apache.commons.lang3.ArrayUtils;
44  import org.apache.commons.lang3.StringUtils;
45  import org.slf4j.Logger;
46  import org.slf4j.LoggerFactory;
47  
48  
49  /**
50   * Default BodyClassResolver.
51   * The body class attributes are used to control the number of columns and the column width.
52   * It provides for instance information about whether we have vertical navigation or not.
53   */
54  public class BodyClassResolver {
55  
56      private static Logger log = LoggerFactory.getLogger(BodyClassResolver.class);
57  
58      private String[] allowedBodyClasses = {
59              "col",
60              "nav-col",
61              "col-subcol",
62              "col-subcol-equal",
63              "col-float3",
64              "col-float2",
65              "nav-col-float2",
66              "col-float2-subcol",
67              "col-subcol-subcol"
68      };
69  
70      public void setAllowedBodyClasses(String[] allowedBodyClasses) {
71          this.allowedBodyClasses = allowedBodyClasses;
72      }
73  
74      public String[] getAllowedBodyClasses() {
75          return allowedBodyClasses;
76      }
77  
78      public String resolveBodyClass(STKPageModel<? extends STKPage> model) {
79          final STKPage def = model.getDefinition();
80          if (StringUtils.isNotEmpty(def.getBodyClass())) {
81              return def.getBodyClass();
82          } else {
83              boolean nav;
84              nav = model.getNavigation().isShowVerticalNavigation();
85  
86              StringBuffer bodyClass = new StringBuffer();
87              if (nav) {
88                  bodyClass.append("-nav");
89              }
90  
91              bodyClass.append("-col");
92  
93              final AreaDefinition mainArea = def.getArea("main");
94              if (mainArea instanceof SectionMainArea) {
95                  final Floating floating = ((SectionMainArea) mainArea).getFloating();
96                  if (floating.isEnabled() && floating.getColumns() > 1) {
97                      bodyClass.append("-float" + floating.getColumns());
98                  }
99              }
100 
101             AreaDefinition extrasAsSimpleArea = def.getAreas().get("extras");
102             boolean extras = extrasAsSimpleArea.getEnabled() != null && extrasAsSimpleArea.getEnabled();
103             if (extras) {
104                 ExtrasArea extrasArea = (ExtrasArea) extrasAsSimpleArea;
105                 int extrasColumns = extrasArea.getColumns();
106                 for (int i = 1; i <= extrasColumns; i++) {
107                     bodyClass.append("-subcol");
108                 }
109 
110                 boolean extrasSmall = extrasArea.getSmall();
111                 if (!extrasSmall) {
112                     bodyClass.append("-equal");
113                 }
114             }
115 
116             // delete leading -
117             bodyClass.deleteCharAt(0);
118             String result = bodyClass.toString();
119 
120             if (result.equals("nav-col-subcol")) {
121                 return "";
122             }
123 
124             if (!ArrayUtils.contains(allowedBodyClasses, result)) {
125                 log.error("Is not an allowed body class: " + result);
126                 return "";
127             }
128 
129             return result;
130         }
131     }
132 
133 }