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.widget;
017
018import org.apache.commons.lang.StringUtils;
019import org.kuali.rice.krad.datadictionary.parse.BeanTag;
020import org.kuali.rice.krad.datadictionary.parse.BeanTagAttribute;
021import org.kuali.rice.krad.uif.CssConstants;
022import org.kuali.rice.krad.uif.component.Component;
023import org.kuali.rice.krad.uif.util.LifecycleElement;
024
025/**
026 * Decorates a group with scroll functionality.
027 *
028 * @author Kuali Rice Team (rice.collab@kuali.org)
029 */
030@BeanTag(name = "scrollpane", parent = "Uif-Scrollpane")
031public class Scrollpane  extends WidgetBase {
032    private static final long serialVersionUID = 3853028195825084261L;
033
034    private String height;
035
036    @Override
037    public void performFinalize(Object model, LifecycleElement parent) {
038        super.performFinalize(model, parent);
039
040        if (parent instanceof Component) {
041            buildCSSforScrollPane((Component) parent);
042        }
043    }
044
045    private void buildCSSforScrollPane(Component parent) {
046        if (StringUtils.isNotBlank(getHeight())) {
047            if (!StringUtils.contains(parent.getStyle(), CssConstants.HEIGHT)) {
048                parent.appendToStyle(CssConstants.HEIGHT + getHeight() +";");
049            }
050
051            if (!StringUtils.contains(parent.getStyle(), CssConstants.OVERFLOW)) {
052                parent.appendToStyle(CssConstants.OVERFLOW + "auto;");
053            }
054        }
055    }
056
057    /**
058     * Height the content should take up in the group
059     *
060     * <p>
061     * If the content size exceeds the height then a scroll bar will be shown.
062     * </p>
063     * <p>
064     * e.g. '30%' or '55px'
065     * </p>
066     *
067     * @return Content height of the group
068     */
069    @BeanTagAttribute
070    public String getHeight() {
071        return height;
072    }
073
074    /**
075     * Setter for the group height
076     *
077     * @param height
078     */
079    public void setHeight(String height) {
080        this.height = height;
081    }
082
083}