View Javadoc

1   /**
2    * This file Copyright (c) 2009-2011 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.lang.ArrayUtils;
44  import org.apache.commons.lang.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   * @author pbracher
54   * @version $Id$
55   *
56   */
57  public class BodyClassResolver {
58  
59      private static Logger log = LoggerFactory.getLogger(BodyClassResolver.class);
60  
61      private String[] allowedBodyClasses = {
62              "col",
63              "nav-col",
64              "col-subcol",
65              "col-subcol-equal",
66              "col-float3",
67              "col-float2",
68              "nav-col-float2",
69              "col-float2-subcol",
70              "col-subcol-subcol"
71      };
72  
73      public void setAllowedBodyClasses(String[] allowedBodyClasses){
74          this.allowedBodyClasses = allowedBodyClasses;
75      }
76  
77      public String[] getAllowedBodyClasses() {
78          return allowedBodyClasses;
79      }
80  
81      public String resolveBodyClass(STKPageModel<? extends STKPage> model) {
82          final STKPage def = model.getDefinition();
83          if(StringUtils.isNotEmpty(def.getBodyClass())){
84              return def.getBodyClass();
85          }
86          else{
87              boolean nav;
88              nav = model.getNavigation().isShowVerticalNavigation();
89  
90              StringBuffer bodyClass = new StringBuffer();
91              if(nav) {
92                  bodyClass.append("-nav");
93              }
94  
95              bodyClass.append("-col");
96  
97              final AreaDefinition mainArea = def.getArea("main");
98              if (mainArea instanceof SectionMainArea) {
99                  final Floating floating = ((SectionMainArea)mainArea).getFloating();
100                 if(floating.isEnabled() && floating.getColumns() > 1) {
101                     bodyClass.append("-float" + floating.getColumns());
102                 }
103             }
104 
105             AreaDefinition extrasAsSimpleArea = def.getAreas().get("extras");
106             boolean extras = extrasAsSimpleArea.isEnabled() != null && extrasAsSimpleArea.isEnabled();
107             if(extras){
108                 ExtrasArea extrasArea = (ExtrasArea) extrasAsSimpleArea;
109                 int extrasColumns = extrasArea.getColumns();
110                 for(int i=1; i<= extrasColumns; i++) {
111                     bodyClass.append("-subcol");
112                 }
113 
114                 boolean extrasSmall = extrasArea.getSmall();
115                 if(!extrasSmall){
116                     bodyClass.append("-equal");
117                 }
118             }
119 
120             // delete leading -
121             bodyClass.deleteCharAt(0);
122             String result = bodyClass.toString();
123 
124             if(result.equals("nav-col-subcol")){
125                 return "";
126             }
127 
128             if(!ArrayUtils.contains(allowedBodyClasses, result)){
129                 log.error("Is not an allowed body class: " + result);
130                 return "";
131             }
132 
133             return result;
134         }
135     }
136 
137 }