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 GmbH & Co. KG, 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.workplace.list;
029
030import org.opencms.util.CmsStringUtil;
031import org.opencms.workplace.CmsWorkplace;
032
033/**
034 * Default implementation of a independent action for a html list column that can execute java script code.<p>
035 *
036 * @since 6.0.0
037 */
038public abstract class A_CmsListIndependentJsAction extends CmsListIndependentAction {
039
040    /**
041     * Default Constructor.<p>
042     *
043     * @param id unique id
044     */
045    public A_CmsListIndependentJsAction(String id) {
046
047        super(id);
048    }
049
050    /**
051     * The js code to execute.<p>
052     *
053     * @param wp the workplace context
054     *
055     * @return js code to execute
056     */
057    public abstract String jsCode(CmsWorkplace wp);
058
059    /**
060     * @see org.opencms.workplace.list.CmsListIndependentAction#resolveOnClic(org.opencms.workplace.CmsWorkplace)
061     */
062    @Override
063    protected String resolveOnClic(CmsWorkplace wp) {
064
065        String confirmationMessage = getConfirmationMessage().key(wp.getLocale());
066        StringBuffer onClic = new StringBuffer(128);
067        if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(confirmationMessage)) {
068            onClic.append("if (confirm('");
069            onClic.append(CmsStringUtil.escapeJavaScript(confirmationMessage));
070            onClic.append("')) { ");
071        }
072        onClic.append(jsCode(wp));
073        if (CmsStringUtil.isNotEmptyOrWhitespaceOnly(confirmationMessage)) {
074            onClic.append(" } ");
075        }
076        return onClic.toString();
077    }
078}