001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (https://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: https://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: https://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.ui.components;
029
030import com.vaadin.server.Resource;
031import com.vaadin.ui.Button;
032import com.vaadin.ui.CssLayout;
033
034/**
035 * A vertical menu styled like e menu bar sub menu or the context menu.<p>
036 */
037public class CmsVerticalMenu extends CssLayout {
038
039    /** The serial version id. */
040    private static final long serialVersionUID = 3525340578362922967L;
041
042    /**
043     * Constructor.<p>
044     */
045    public CmsVerticalMenu() {
046
047        setSizeFull();
048        setPrimaryStyleName(OpenCmsTheme.VERTICAL_MENU);
049    }
050
051    /**
052     * Adds a menu entry button.<p>
053     *
054     * @param entryButton the entry button
055     */
056    public void addMenuEntry(Button entryButton) {
057
058        entryButton.setPrimaryStyleName(OpenCmsTheme.VERTICAL_MENU_ITEM);
059        addComponent(entryButton);
060    }
061
062    /**
063     * Adds an entry to the menu, returns the entry button.<p>
064     *
065     * @param label the label
066     * @param icon the icon
067     *
068     * @return the entry button
069     */
070    public Button addMenuEntry(String label, Resource icon) {
071
072        Button button = new Button(label, icon);
073        button.setPrimaryStyleName(OpenCmsTheme.VERTICAL_MENU_ITEM);
074        addComponent(button);
075        return button;
076    }
077}