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.gwt.client.ui.contextmenu;
029
030import org.opencms.gwt.client.util.CmsEmbeddedDialogHandler;
031import org.opencms.gwt.shared.CmsContextMenuEntryBean;
032import org.opencms.gwt.shared.CmsGwtConstants;
033import org.opencms.util.CmsUUID;
034
035import java.util.Collections;
036import java.util.HashMap;
037import java.util.Map;
038
039/**
040 * Context menu command to call workplace actions.<p>
041 *
042 * When called the VAADIN UI will be embedded within an iFrame and the action dialog displayed within it.<p>
043 */
044public class CmsEmbeddedAction implements I_CmsHasContextMenuCommand, I_CmsContextMenuCommand {
045
046    /** Parameters to send to server, filled in by other code. */
047    public static final Map<String, String> PARAMS = new HashMap<>();
048
049    /**
050     * Hidden utility class constructor.<p>
051     */
052    private CmsEmbeddedAction() {}
053
054    /**
055     * Returns the context menu command according to
056     * {@link org.opencms.gwt.client.ui.contextmenu.I_CmsHasContextMenuCommand}.<p>
057     *
058     * @return the context menu command
059     */
060    public static I_CmsContextMenuCommand getContextMenuCommand() {
061
062        return new CmsEmbeddedAction();
063    }
064
065    /**
066     * @see org.opencms.gwt.client.ui.contextmenu.I_CmsContextMenuCommand#execute(org.opencms.util.CmsUUID, org.opencms.gwt.client.ui.contextmenu.I_CmsContextMenuHandler, org.opencms.gwt.shared.CmsContextMenuEntryBean)
067     */
068    public void execute(
069        final CmsUUID structureId,
070        final I_CmsContextMenuHandler handler,
071        CmsContextMenuEntryBean bean) {
072
073        String dialogId = bean.getParams().get(CmsGwtConstants.ACTION_PARAM_DIALOG_ID);
074        CmsEmbeddedDialogHandler dialogHandler = new CmsEmbeddedDialogHandler(handler);
075        dialogHandler.openDialog(
076            dialogId,
077            handler.getContextType(),
078            structureId != null ? Collections.singletonList(structureId) : Collections.<CmsUUID> emptyList(),
079            PARAMS);
080    }
081
082    /**
083     * @see org.opencms.gwt.client.ui.contextmenu.I_CmsContextMenuCommand#getItemWidget(org.opencms.util.CmsUUID, org.opencms.gwt.client.ui.contextmenu.I_CmsContextMenuHandler, org.opencms.gwt.shared.CmsContextMenuEntryBean)
084     */
085    public A_CmsContextMenuItem getItemWidget(
086        CmsUUID structureId,
087        I_CmsContextMenuHandler handler,
088        CmsContextMenuEntryBean bean) {
089
090        return null;
091    }
092
093    /**
094     * @see org.opencms.gwt.client.ui.contextmenu.I_CmsContextMenuCommand#hasItemWidget()
095     */
096    public boolean hasItemWidget() {
097
098        return false;
099    }
100}