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.file.CmsObject;
031
032import java.util.Locale;
033
034import com.vaadin.server.Resource;
035
036/**
037 * Displays a sub menu in the app launch pad.
038 */
039public interface I_CmsFolderAppCategory extends I_CmsAppCategory {
040
041    /**
042     * Returns the button style.<p>
043     *
044     * @return the button style
045     */
046    String getButtonStyle();
047
048    /**
049     * Gets the help text for the app in the given locale.<p>
050     *
051     * @param locale the locale to use
052     *
053     * @return the help text
054     */
055    String getHelpText(Locale locale);
056
057    /**
058     * Returns the app icon resource.<p>
059     *
060     * @return the icon resource
061     */
062    Resource getIcon();
063
064    /**
065     * Returns the visibility status of the app for the given user context.<p>
066     *
067     * @param cms the user context
068     *
069     * @return the visibility status
070     */
071    CmsAppVisibilityStatus getVisibility(CmsObject cms);
072}