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