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.ui.CmsCssIcon;
031import org.opencms.ui.components.OpenCmsTheme;
032
033import java.util.Locale;
034
035import com.vaadin.server.Resource;
036
037/**
038 * The file explorer app configuration.<p>
039 */
040public class CmsFileExplorerConfiguration extends A_CmsWorkplaceAppConfiguration {
041
042    /** The app id. */
043    public static final String APP_ID = "explorer";
044
045    /** The app icon resource (size 32x32). */
046    public static final CmsCssIcon ICON = new CmsCssIcon(OpenCmsTheme.ICON_EXLPORER_BIG);
047
048    /**
049     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getAppCategory()
050     */
051    @Override
052    public String getAppCategory() {
053
054        return CmsWorkplaceAppManager.MAIN_CATEGORY_ID;
055    }
056
057    /**
058     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getAppInstance()
059     */
060    public I_CmsWorkplaceApp getAppInstance() {
061
062        return new CmsFileExplorer();
063    }
064
065    /**
066     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getHelpText(java.util.Locale)
067     */
068    @Override
069    public String getHelpText(Locale locale) {
070
071        return Messages.get().getBundle(locale).key(Messages.GUI_EXPLORER_HELP_0);
072    }
073
074    /**
075     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getIcon()
076     */
077    public Resource getIcon() {
078
079        return ICON;
080    }
081
082    /**
083     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getId()
084     */
085    public String getId() {
086
087        return APP_ID;
088    }
089
090    /**
091     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getName(java.util.Locale)
092     */
093    @Override
094    public String getName(Locale locale) {
095
096        return Messages.get().getBundle(locale).key(Messages.GUI_EXPLORER_TITLE_0);
097    }
098
099    /**
100     * @see org.opencms.ui.apps.I_CmsWorkplaceAppConfiguration#getOrder()
101     */
102    @Override
103    public int getOrder() {
104
105        return 3;
106    }
107}