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.actions;
029
030import org.opencms.file.CmsObject;
031import org.opencms.file.CmsResource;
032import org.opencms.gwt.shared.CmsCoreData.AdeContext;
033import org.opencms.ui.I_CmsDialogContext;
034import org.opencms.ui.contextmenu.CmsMenuItemVisibilityMode;
035import org.opencms.workplace.explorer.Messages;
036
037import java.util.List;
038import java.util.Map;
039
040/**
041 * Action to logout.<p>
042 * Used within the ADE context only.<p>
043 */
044public class CmsLogoutAction extends A_CmsWorkplaceAction implements I_CmsADEAction {
045
046    /** The action id. */
047    public static final String ACTION_ID = "logout";
048
049    /**
050     * @see org.opencms.ui.actions.I_CmsWorkplaceAction#executeAction(org.opencms.ui.I_CmsDialogContext)
051     */
052    public void executeAction(I_CmsDialogContext context) {
053
054        // not supported
055    }
056
057    /**
058     * @see org.opencms.ui.actions.I_CmsADEAction#getCommandClassName()
059     */
060    public String getCommandClassName() {
061
062        return "org.opencms.gwt.client.ui.contextmenu.CmsLogout";
063    }
064
065    /**
066     * @see org.opencms.ui.actions.I_CmsWorkplaceAction#getId()
067     */
068    public String getId() {
069
070        return ACTION_ID;
071    }
072
073    /**
074     * @see org.opencms.ui.actions.I_CmsADEAction#getJspPath()
075     */
076    public String getJspPath() {
077
078        return null;
079    }
080
081    /**
082     * @see org.opencms.ui.actions.I_CmsADEAction#getParams()
083     */
084    public Map<String, String> getParams() {
085
086        return null;
087    }
088
089    /**
090     * @see org.opencms.ui.contextmenu.I_CmsHasMenuItemVisibility#getVisibility(org.opencms.file.CmsObject, java.util.List)
091     */
092    public CmsMenuItemVisibilityMode getVisibility(CmsObject cms, List<CmsResource> resources) {
093
094        return CmsMenuItemVisibilityMode.VISIBILITY_INVISIBLE;
095    }
096
097    /**
098     * @see org.opencms.ui.actions.A_CmsWorkplaceAction#getVisibility(org.opencms.ui.I_CmsDialogContext)
099     */
100    @Override
101    public CmsMenuItemVisibilityMode getVisibility(I_CmsDialogContext context) {
102
103        boolean visible = AdeContext.editprovider.name().equals(context.getAppId());
104        return visible ? CmsMenuItemVisibilityMode.VISIBILITY_ACTIVE : CmsMenuItemVisibilityMode.VISIBILITY_INVISIBLE;
105    }
106
107    /**
108     * @see org.opencms.ui.actions.I_CmsADEAction#isAdeSupported()
109     */
110    public boolean isAdeSupported() {
111
112        return true;
113    }
114
115    /**
116     * @see org.opencms.ui.actions.A_CmsWorkplaceAction#getTitleKey()
117     */
118    @Override
119    protected String getTitleKey() {
120
121        return Messages.GUI_EXPLORER_CONTEXT_LOGOUT_0;
122    }
123}