001/**
002 * Copyright 2005-2015 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.krad.uif.layout;
017
018import org.apache.commons.lang.StringUtils;
019import org.kuali.rice.krad.datadictionary.parse.BeanTag;
020import org.kuali.rice.krad.uif.CssConstants;
021import org.kuali.rice.krad.uif.component.Component;
022import org.kuali.rice.krad.uif.lifecycle.ViewLifecycleRestriction;
023
024import java.util.ArrayList;
025import java.util.List;
026
027/**
028 * Css Grid Layout managers are a layout managers which creates div "rows" and "cells" to replicate a
029 * table look by using div elements for its items.
030 *
031 * @author Kuali Rice Team (rice.collab@kuali.org)
032 */
033@BeanTag(name = "cssGridLayoutBase", parent = "Uif-CssGridLayoutBase")
034public abstract class CssGridLayoutManagerBase extends LayoutManagerBase {
035    private static final long serialVersionUID = 1830635073147703757L;
036
037    protected static final int NUMBER_OF_COLUMNS = 12;
038    protected static final String BOOTSTRAP_SPAN_PREFIX = "col-md-";
039
040    // Cannot be set by bean
041    protected List<Component> cellItems;
042    protected List<String> cellCssClassAttributes;
043
044    // Internal local variables
045    protected int xsTotalSize = 0;
046    protected int smTotalSize = 0;
047    protected int mdTotalSize = 0;
048    protected int lgTotalSize = 0;
049
050    public CssGridLayoutManagerBase() {
051        cellCssClassAttributes = new ArrayList<String>();
052        cellItems = new ArrayList<Component>();
053    }
054
055    /**
056     * Determines the css class(es) and based on what settings the item, defaultSizes and basicSize have
057     *
058     * <p>
059     * Priority of what sizes to apply are as follows:
060     * 1. cssGridSizes on the item itself
061     * 2. Sizes in the defaultSizes object
062     * 3. basicSize passed in the if the above two contain no settings, defaults to md (medium) col size
063     * </p>
064     *
065     * @param item the item to process classes for
066     * @param cellCssClasses the list of classes to add the new class string to
067     * @param defaultSizes the default fallback sizes to use if items have none
068     * @param basicSize the fallback md size to use if both item and default size have none
069     */
070    protected void calculateCssClassAndSize(Component item, List<String> cellCssClasses, CssGridSizes defaultSizes,
071            int basicSize) {
072
073        if (StringUtils.isNotBlank(item.getCssGridSizes().getCssClassString())) {
074            cellCssClasses.add(0, item.getCssGridSizes().getCssClassString());
075
076            xsTotalSize += item.getCssGridSizes().getXsSize();
077            smTotalSize += item.getCssGridSizes().getTotalSmSize();
078            mdTotalSize += item.getCssGridSizes().getTotalMdSize();
079            lgTotalSize += item.getCssGridSizes().getTotalLgSize();
080        } else if (StringUtils.isNotBlank(defaultSizes.getCssClassString())) {
081            cellCssClasses.add(0, defaultSizes.getCssClassString());
082
083            xsTotalSize += defaultSizes.getXsSize();
084            smTotalSize += defaultSizes.getTotalSmSize();
085            mdTotalSize += defaultSizes.getTotalMdSize();
086            lgTotalSize += defaultSizes.getTotalLgSize();
087        } else {
088            cellCssClasses.add(0, BOOTSTRAP_SPAN_PREFIX + basicSize);
089
090            mdTotalSize += basicSize;
091        }
092    }
093
094    /**
095     * Adds a class (or classeees) which will clear the left float for wrapped content at each screen size, which
096     * will prevent natural float from taking available space instead of wrapping to a new "row".
097     *
098     * @param cellCssClasses the set of css classes to add the left clear class to
099     */
100    protected void addLeftClearCssClass(List<String> cellCssClasses) {
101        String classString = getCellStyleClassesAsString(cellCssClasses);
102
103        // We explicitly check for the col prefix to avoid unnecessary class additions since the clear will be
104        // inherited from a smaller size screen if no size/offset has been specified for this size specifically
105        // see KRAD css grid css
106        if (lgTotalSize > 12) {
107            if (classString.contains(CssConstants.CssGrid.LG_COL_PREFIX)) {
108                cellCssClasses.add(0, CssConstants.CssGrid.LG_CLEAR_LEFT);
109            }
110            lgTotalSize = lgTotalSize - 12;
111        }
112
113        if (mdTotalSize > 12) {
114            if (classString.contains(CssConstants.CssGrid.MD_COL_PREFIX)) {
115                cellCssClasses.add(0, CssConstants.CssGrid.MD_CLEAR_LEFT);
116            }
117            mdTotalSize = mdTotalSize - 12;
118        }
119
120        if (smTotalSize > 12) {
121            if (classString.contains(CssConstants.CssGrid.SM_COL_PREFIX)) {
122                cellCssClasses.add(0, CssConstants.CssGrid.SM_CLEAR_LEFT);
123            }
124            smTotalSize = smTotalSize - 12;
125        }
126
127        if (xsTotalSize > 12) {
128            cellCssClasses.add(0, CssConstants.CssGrid.XS_CLEAR_LEFT);
129            xsTotalSize = xsTotalSize - 12;
130        }
131    }
132
133    /**
134     * Builds the HTML class attribute string by combining the cellStyleClasses list with a space
135     * delimiter
136     *
137     * @param cellCssClasses list of cell CSS classes
138     * @return class attribute string
139     */
140    protected String getCellStyleClassesAsString(List<String> cellCssClasses) {
141        if (cellCssClasses != null) {
142            return StringUtils.join(cellCssClasses, " ").trim();
143        }
144
145        return "";
146    }
147
148    /**
149     * Get the items which will make up each "cell" divs of this css grid layout, these divs will have appropriate
150     * css class applied to them based on the values stored in cellCssClassAttributes
151     *
152     * @return the items of this cssGrid
153     */
154    @ViewLifecycleRestriction
155    public List<Component> getCellItems() {
156        return cellItems;
157    }
158
159    /**
160     * List of css class HTML attribute values ordered by the order in which the cell appears
161     *
162     * @return the list of css class HTML attributes for cells
163     */
164    public List<String> getCellCssClassAttributes() {
165        return cellCssClassAttributes;
166    }
167
168}