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.element;
017
018import org.kuali.rice.krad.uif.container.Group;
019
020/**
021 * Component that renders a standard application header including a logo, navigation, and toolbar.
022 *
023 * @author Kuali Rice Team (rice.collab@kuali.org)
024 */
025public class ApplicationHeader extends Header {
026    private static final long serialVersionUID = 6213942245727420161L;
027
028    private NavigationBar applicationNavigation;
029
030    private Group applicationToolbar;
031
032    public ApplicationHeader() {
033        super();
034    }
035
036    /**
037     * Navigation bar component that is used to render the application navigation within the header.
038     *
039     * @return navigation bar instance
040     */
041    public NavigationBar getApplicationNavigation() {
042        return applicationNavigation;
043    }
044
045    /**
046     * @see ApplicationHeader#getApplicationNavigation()
047     */
048    public void setApplicationNavigation(NavigationBar applicationNavigation) {
049        this.applicationNavigation = applicationNavigation;
050    }
051
052    /**
053     * Convenience setter for configuring the application logo (brand image) for the navigation bar.
054     *
055     * @param applicationLogo image instance to use as logo
056     * @see NavigationBar#setBrandImage(org.kuali.rice.krad.uif.element.Image)
057     */
058    public void setApplicationLogo(Image applicationLogo) {
059        if (applicationNavigation == null) {
060            throw new RuntimeException("App navigation is null, cannot set application logo");
061        } else {
062            applicationNavigation.setBrandImage(applicationLogo);
063        }
064    }
065
066    /**
067     * Group that is rendered below the navigation bar with a toolbar style.
068     *
069     * <p>Common group toolbar for placing things such as user actions, links/dropdowns to other application
070     * actions</p>
071     *
072     * @return Group instance
073     */
074    public Group getApplicationToolbar() {
075        return applicationToolbar;
076    }
077
078    /**
079     * @see ApplicationHeader#getApplicationToolbar()
080     */
081    public void setApplicationToolbar(Group applicationToolbar) {
082        this.applicationToolbar = applicationToolbar;
083    }
084}