001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (https://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: https://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: https://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.I_CmsDialogContext;
033import org.opencms.ui.I_CmsEditPropertyContext;
034import org.opencms.ui.components.CmsResourceTableProperty;
035import org.opencms.ui.contextmenu.CmsMenuItemVisibilityMode;
036import org.opencms.ui.contextmenu.CmsMenuItemVisibilitySingleOnly;
037import org.opencms.ui.contextmenu.CmsStandardVisibilityCheck;
038import org.opencms.ui.contextmenu.I_CmsHasMenuItemVisibility;
039
040import java.util.List;
041
042/**
043 * The edit table property action.<p>
044 */
045public class CmsEditPropertyAction extends A_CmsWorkplaceAction {
046
047    /** The action id. */
048    public static final String ACTION_ID = "edit_";
049
050    /** The action visibility. */
051    public static final I_CmsHasMenuItemVisibility VISIBILITY = new CmsMenuItemVisibilitySingleOnly(
052        CmsStandardVisibilityCheck.DEFAULT);
053
054    /** The property id. */
055    private CmsResourceTableProperty m_propertyId;
056
057    /** The action title message key. */
058    private String m_titleKey;
059
060    /**
061     * Constructor.<p>
062     *
063     * @param propertyId the property id
064     * @param titleKey the title message key
065     */
066    public CmsEditPropertyAction(CmsResourceTableProperty propertyId, String titleKey) {
067
068        m_propertyId = propertyId;
069        m_titleKey = titleKey;
070    }
071
072    /**
073     * @see org.opencms.ui.actions.I_CmsWorkplaceAction#executeAction(org.opencms.ui.I_CmsDialogContext)
074     */
075    public void executeAction(I_CmsDialogContext context) {
076
077        if (!hasBlockingLocks(context)) {
078            ((I_CmsEditPropertyContext)context).editProperty(m_propertyId);
079        }
080    }
081
082    /**
083     * @see org.opencms.ui.actions.I_CmsWorkplaceAction#getId()
084     */
085    public String getId() {
086
087        return ACTION_ID + m_propertyId.getId();
088    }
089
090    /**
091     * @see org.opencms.ui.contextmenu.I_CmsHasMenuItemVisibility#getVisibility(org.opencms.file.CmsObject, java.util.List)
092     */
093    public CmsMenuItemVisibilityMode getVisibility(CmsObject cms, List<CmsResource> resources) {
094
095        return VISIBILITY.getVisibility(cms, resources);
096    }
097
098    /**
099     * @see org.opencms.ui.actions.A_CmsWorkplaceAction#getVisibility(org.opencms.ui.I_CmsDialogContext)
100     */
101    @Override
102    public CmsMenuItemVisibilityMode getVisibility(I_CmsDialogContext context) {
103
104        if (!(context instanceof I_CmsEditPropertyContext)
105            || !((I_CmsEditPropertyContext)context).isPropertyEditable(m_propertyId)) {
106            return CmsMenuItemVisibilityMode.VISIBILITY_INVISIBLE;
107        } else {
108            return getVisibility(context.getCms(), context.getResources());
109        }
110    }
111
112    /**
113     * @see org.opencms.ui.actions.A_CmsWorkplaceAction#getTitleKey()
114     */
115    @Override
116    protected String getTitleKey() {
117
118        return m_titleKey;
119    }
120}