001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://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: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://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.apps;
029
030import org.opencms.main.OpenCms;
031
032import java.util.Locale;
033
034import com.vaadin.server.Resource;
035import com.vaadin.ui.Button;
036import com.vaadin.ui.Button.ClickEvent;
037import com.vaadin.ui.Button.ClickListener;
038import com.vaadin.ui.Component;
039
040/**
041 * A workplace menu item.<p>
042 */
043public abstract class A_CmsMenuItem implements I_CmsMenuItem {
044
045    /** The item icon. */
046    protected Resource m_icon;
047
048    /** The label message key. */
049    protected String m_labelKey;
050
051    /**
052     * Constructor.<p>
053     *
054     * @param labelKey the label message key
055     * @param icon the icon
056     */
057    public A_CmsMenuItem(String labelKey, Resource icon) {
058
059        m_labelKey = labelKey;
060        m_icon = icon;
061    }
062
063    /**
064     * @see org.opencms.ui.apps.I_CmsMenuItem#getItemComponent(java.util.Locale)
065     */
066    public Component getItemComponent(Locale locale) {
067
068        Button b = new Button(getLabel(locale), m_icon);
069        b.addClickListener(new ClickListener() {
070
071            private static final long serialVersionUID = 1L;
072
073            public void buttonClick(ClickEvent event) {
074
075                executeAction();
076            }
077        });
078        return b;
079    }
080
081    /**
082     * Returns the label for the given locale.<p>
083     *
084     * @param locale the user locale
085     *
086     * @return the label
087     */
088    protected String getLabel(Locale locale) {
089
090        return OpenCms.getWorkplaceManager().getMessages(locale).key(m_labelKey);
091    }
092
093    /**
094     * Executes the item action.<p>
095     */
096    abstract void executeAction();
097
098}