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.ui.A_CmsUI;
033import org.opencms.ui.I_CmsDialogContext;
034import org.opencms.ui.I_CmsUpdateListener;
035import org.opencms.ui.components.extensions.CmsGwtDialogExtension;
036import org.opencms.ui.contextmenu.CmsMenuItemVisibilityMode;
037import org.opencms.ui.contextmenu.CmsMenuItemVisibilitySingleOnly;
038import org.opencms.ui.contextmenu.CmsStandardVisibilityCheck;
039import org.opencms.ui.contextmenu.I_CmsHasMenuItemVisibility;
040import org.opencms.util.CmsUUID;
041import org.opencms.workplace.explorer.Messages;
042
043import java.util.HashMap;
044import java.util.List;
045import java.util.Map;
046
047import com.google.common.collect.Lists;
048
049/**
050 * The categories dialog action.<p>
051 */
052public class CmsCategoriesDialogAction extends A_CmsWorkplaceAction implements I_CmsADEAction {
053
054    /** The action id. */
055    public static final String ACTION_ID = "categories";
056
057    /** The action visibility. */
058    public static final I_CmsHasMenuItemVisibility VISIBILITY = new CmsMenuItemVisibilitySingleOnly(
059        CmsStandardVisibilityCheck.DEFAULT);
060
061    /** Parameter specifying if the category tree should be collapsed when shown first. */
062    private static final String PARAM_COLLAPSED = "displayCollapsed";
063
064    /**
065     * @see org.opencms.ui.actions.I_CmsWorkplaceAction#executeAction(org.opencms.ui.I_CmsDialogContext)
066     */
067    public void executeAction(final I_CmsDialogContext context) {
068
069        if (!hasBlockingLocks(context)) {
070            CmsGwtDialogExtension extension = new CmsGwtDialogExtension(
071                A_CmsUI.get(),
072                new I_CmsUpdateListener<String>() {
073
074                    public void onUpdate(List<String> updatedItems) {
075
076                        List<CmsUUID> ids = Lists.newArrayList();
077                        for (String item : updatedItems) {
078                            ids.add(new CmsUUID(item));
079                        }
080                        context.finish(ids);
081                    }
082                });
083            extension.openCategories(context.getResources().get(0));
084        }
085    }
086
087    /**
088     * @see org.opencms.ui.actions.I_CmsADEAction#getCommandClassName()
089     */
090    public String getCommandClassName() {
091
092        return "org.opencms.gwt.client.ui.contextmenu.CmsCategories";
093    }
094
095    /**
096     * @see org.opencms.ui.actions.I_CmsWorkplaceAction#getId()
097     */
098    public String getId() {
099
100        return ACTION_ID;
101    }
102
103    /**
104     * @see org.opencms.ui.actions.I_CmsADEAction#getJspPath()
105     */
106    public String getJspPath() {
107
108        return null;
109    }
110
111    /**
112     * Add the option specifying if the categories should be displayed collapsed
113     * when the dialog opens.
114     *
115     * @see org.opencms.ui.actions.I_CmsADEAction#getParams()
116     */
117    public Map<String, String> getParams() {
118
119        Map<String, String> params = new HashMap<>(1);
120        params.put(PARAM_COLLAPSED, Boolean.TRUE.toString());
121        return params;
122    }
123
124    /**
125     * @see org.opencms.ui.contextmenu.I_CmsHasMenuItemVisibility#getVisibility(org.opencms.file.CmsObject, java.util.List)
126     */
127    public CmsMenuItemVisibilityMode getVisibility(CmsObject cms, List<CmsResource> resources) {
128
129        return VISIBILITY.getVisibility(cms, resources);
130    }
131
132    /**
133     * @see org.opencms.ui.actions.I_CmsADEAction#isAdeSupported()
134     */
135    public boolean isAdeSupported() {
136
137        return true;
138    }
139
140    /**
141     * @see org.opencms.ui.actions.A_CmsWorkplaceAction#getTitleKey()
142     */
143    @Override
144    protected String getTitleKey() {
145
146        return Messages.GUI_EXPLORER_CONTEXT_CATEGORIES_0;
147    }
148}