001    /**
002     * Copyright 2005-2013 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     */
016    package org.kuali.rice.krad.uif.layout;
017    
018    import org.apache.commons.lang.StringUtils;
019    import org.kuali.rice.krad.datadictionary.parse.BeanTag;
020    import org.kuali.rice.krad.datadictionary.parse.BeanTagAttribute;
021    import org.kuali.rice.krad.datadictionary.parse.BeanTags;
022    import org.kuali.rice.krad.uif.CssConstants;
023    import org.kuali.rice.krad.uif.CssConstants.Padding;
024    import org.kuali.rice.krad.uif.UifConstants.Orientation;
025    import org.kuali.rice.krad.uif.component.Component;
026    import org.kuali.rice.krad.uif.container.Container;
027    import org.kuali.rice.krad.uif.view.View;
028    
029    import java.util.ArrayList;
030    import java.util.List;
031    
032    /**
033     * Layout manager that organizes components in a single row (horizontal) or
034     * column (vertical)
035     *
036     * <p>
037     * Although a table based template could be used, setup is done to also support
038     * a CSS based template. The items in the <code>Container</code> instance are
039     * rendered sequentially wrapping each one with a span element. The padding
040     * property can be configured to space the elements as needed. To achieve a
041     * vertical orientation, the span style is set to block. Additional styling can
042     * be set for the items by using the itemSpanStyle property.
043     * </p>
044     *
045     * @author Kuali Rice Team (rice.collab@kuali.org)
046     */
047    @BeanTags({@BeanTag(name = "boxLayout-bean", parent = "Uif-BoxLayoutBase"),
048            @BeanTag(name = "horizontalBoxLayout-bean", parent = "Uif-HorizontalBoxLayout"),
049            @BeanTag(name = "verticalBoxLayout-bean", parent = "Uif-VerticalBoxLayout")})
050    public class BoxLayoutManager extends LayoutManagerBase {
051        private static final long serialVersionUID = 4467342272983290044L;
052    
053        private Orientation orientation;
054        private String padding;
055    
056        private String itemStyle;
057        private List<String> itemStyleClasses;
058    
059        public BoxLayoutManager() {
060            super();
061    
062            itemStyle = "";
063            orientation = Orientation.HORIZONTAL;
064            itemStyleClasses = new ArrayList<String>();
065        }
066    
067        /**
068         * Sets the item span style
069         *
070         * @see org.kuali.rice.krad.uif.layout.LayoutManagerBase#performFinalize(org.kuali.rice.krad.uif.view.View,
071         *      java.lang.Object, org.kuali.rice.krad.uif.container.Container)
072         */
073        @Override
074        public void performFinalize(View view, Object model, Container container) {
075            super.performFinalize(view, model, container);
076    
077            if (StringUtils.isBlank(itemStyle)) {
078                itemStyle = "";
079            }
080    
081            if (StringUtils.isNotEmpty(padding)) {
082                if (orientation.equals(Orientation.VERTICAL)) {
083                    // set item to block which will cause a line break and margin
084                    // bottom for padding
085                    itemStyle += CssConstants.getCssStyle(Padding.PADDING_BOTTOM, padding);
086                } else {
087                    // set margin right for padding
088                    itemStyle += CssConstants.getCssStyle(Padding.PADDING_RIGHT, padding);
089                }
090            }
091    
092            // classes to identify this layout in jQuery and to clear the float correctly in all browsers
093            this.addStyleClass("clearfix");
094    
095            for (Component c : container.getItems()) {
096                if (c != null) {
097                    // add item styles to the the item
098                    List<String> styleClasses = c.getCssClasses();
099                    if (orientation.equals(Orientation.HORIZONTAL)) {
100                        styleClasses.add("uif-boxLayoutHorizontalItem");
101                        styleClasses.addAll(this.getItemStyleClasses());
102                    } else {
103                        styleClasses.add("uif-boxLayoutVerticalItem");
104                        styleClasses.addAll(this.getItemStyleClasses());
105                        styleClasses.add("clearfix");
106                    }
107                    c.setCssClasses(styleClasses);
108    
109                    if (c.getStyle() != null && !c.getStyle().endsWith(";")) {
110                        c.appendToStyle(";" + this.getItemStyle());
111                    } else {
112                        c.appendToStyle(this.getItemStyle());
113                    }
114                }
115            }
116        }
117    
118        /**
119         * Indicates whether the components should be rendered in a horizontal or
120         * vertical column
121         *
122         * @return Orientation orientation configured for layout
123         */
124        @BeanTagAttribute(name = "orientation", type = BeanTagAttribute.AttributeType.SINGLEBEAN)
125        public Orientation getOrientation() {
126            return this.orientation;
127        }
128    
129        /**
130         * Setter for the orientation for layout
131         *
132         * @param orientation
133         */
134        public void setOrientation(Orientation orientation) {
135            this.orientation = orientation;
136        }
137    
138        /**
139         * Amount of separation between each item
140         *
141         * <p>
142         * For horizontal orientation, this will be the right padding for each item.
143         * For vertical, it will be the bottom padding for each item. The value can
144         * be a fixed length (like px) or percentage
145         * </p>
146         *
147         * @return String
148         */
149        @BeanTagAttribute(name = "padding")
150        public String getPadding() {
151            return this.padding;
152        }
153    
154        /**
155         * Setter for the item padding
156         *
157         * @param padding
158         */
159        public void setPadding(String padding) {
160            this.padding = padding;
161        }
162    
163        /**
164         * Used by the render to set the style on the span element that wraps the
165         * item. By using a wrapping span the items can be aligned based on the
166         * orientation and given the correct padding
167         *
168         * @return String css style string
169         */
170        @BeanTagAttribute(name = "itemStyle")
171        public String getItemStyle() {
172            return this.itemStyle;
173        }
174    
175        /**
176         * Setter for the span style
177         *
178         * @param itemStyle
179         */
180        public void setItemStyle(String itemStyle) {
181            this.itemStyle = itemStyle;
182        }
183    
184        /**
185         * List of style classes that should be applied to each span that wraps the item in the layout
186         *
187         * @return List<String>
188         */
189        @BeanTagAttribute(name = "itemStyleClasses", type = BeanTagAttribute.AttributeType.LISTVALUE)
190        public List<String> getItemStyleClasses() {
191            return itemStyleClasses;
192        }
193    
194        /**
195         * Setter for the list of style classes that should apply to each item span
196         *
197         * @param itemStyleClasses
198         */
199        public void setItemStyleClasses(List<String> itemStyleClasses) {
200            this.itemStyleClasses = itemStyleClasses;
201        }
202    
203        /**
204         * Builds the HTML class attribute string by combining the item styleClasses list
205         * with a space delimiter
206         *
207         * @return String class attribute string
208         */
209        public String getItemStyleClassesAsString() {
210            if (itemStyleClasses != null) {
211                return StringUtils.join(itemStyleClasses, " ");
212            }
213    
214            return "";
215        }
216    
217    }