org.opencms.ui.components.CmsVerticalMenu.java Source code

Introduction

Here is the source code for org.opencms.ui.components.CmsVerticalMenu.java

Source

/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.ui.components;

import com.vaadin.server.Resource;
import com.vaadin.ui.Button;
import com.vaadin.ui.CssLayout;

/**
 * A vertical menu styled like e menu bar sub menu or the context menu.<p>
 */
public class CmsVerticalMenu extends CssLayout {

    /** The serial version id. */
    private static final long serialVersionUID = 3525340578362922967L;

    /**
     * Constructor.<p>
     */
    public CmsVerticalMenu() {
        setSizeFull();
        setPrimaryStyleName(OpenCmsTheme.VERTICAL_MENU);
    }

    /**
     * Adds a menu entry button.<p>
     *
     * @param entryButton the entry button
     */
    public void addMenuEntry(Button entryButton) {

        entryButton.setPrimaryStyleName(OpenCmsTheme.VERTICAL_MENU_ITEM);
        addComponent(entryButton);
    }

    /**
     * Adds an entry to the menu, returns the entry button.<p>
     *
     * @param label the label
     * @param icon the icon
     *
     * @return the entry button
     */
    public Button addMenuEntry(String label, Resource icon) {

        Button button = new Button(label, icon);
        button.setPrimaryStyleName(OpenCmsTheme.VERTICAL_MENU_ITEM);
        addComponent(button);
        return button;
    }
}