001/**
002 * Copyright 2005-2018 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.container;
017
018import java.util.HashSet;
019import java.util.Set;
020
021import org.kuali.rice.krad.datadictionary.parse.BeanTag;
022import org.kuali.rice.krad.datadictionary.parse.BeanTagAttribute;
023import org.kuali.rice.krad.datadictionary.parse.BeanTags;
024import org.kuali.rice.krad.uif.UifConstants;
025import org.kuali.rice.krad.uif.component.Component;
026import org.kuali.rice.krad.uif.util.LifecycleElement;
027import org.kuali.rice.krad.uif.widget.Accordion;
028
029/**
030 * Accordion group class used to stack groups by there header titles in an accordion layout.
031 *
032 * @author Kuali Rice Team (rice.collab@kuali.org)
033 */
034@BeanTags({@BeanTag(name = "accordionGroup", parent = "Uif-AccordionGroup"),
035        @BeanTag(name = "accordionSection", parent = "Uif-AccordionSection"),
036        @BeanTag(name = "accordionSubSection", parent = "Uif-AccordionSubSection"),
037        @BeanTag(name = "disclosureAccordionSection", parent = "Uif-Disclosure-AccordionSection"),
038        @BeanTag(name = "disclosureAccordionSubSection", parent = "Uif-Disclosure-AccordionSubSection")})
039public class AccordionGroup extends GroupBase {
040    private static final long serialVersionUID = 7230145606607506418L;
041
042    private Accordion accordionWidget;
043
044    /**
045     * {@inheritDoc}
046     */
047    @Override
048    public void performFinalize(Object model, LifecycleElement parent) {
049        super.performFinalize(model, parent);
050        this.addDataAttribute(UifConstants.DataAttributes.TYPE, "Uif-AccordionGroup");
051    }
052
053    /**
054     * Only groups are supported for this group.
055     *
056     * {@inheritDoc}
057     */
058    @Override
059    public Set<Class<? extends Component>> getSupportedComponents() {
060        Set<Class<? extends Component>> supportedComponents = new HashSet<Class<? extends Component>>();
061        supportedComponents.add(Group.class);
062
063        return supportedComponents;
064    }
065
066    /**
067     * Gets the widget which contains any configuration for the accordion widget component used to render
068     * this AccordionGroup.
069     *
070     * @return the accordionWidget
071     */
072    @BeanTagAttribute
073    public Accordion getAccordionWidget() {
074        return this.accordionWidget;
075    }
076
077    /**
078     * @see AccordionGroup#getAccordionWidget()
079     */
080    public void setAccordionWidget(Accordion accordionWidget) {
081        this.accordionWidget = accordionWidget;
082    }
083}