org.opencms.widgets.CmsRemoveFormatterWidget Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opencms-test Show documentation
OpenCms is an enterprise-ready, easy to use website content management system based on Java and XML technology. Offering a complete set of features, OpenCms helps content managers worldwide to create and maintain beautiful websites fast and efficiently.
There is a newer version: 18.0
Show newest version
/*
 * This library is part of OpenCms -
 * the Open Source Content Management System
 *
 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about Alkacon Software, please see the
 * company website: http://www.alkacon.com
 *
 * For further information about OpenCms, please see the
 * project website: http://www.opencms.org
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.opencms.widgets;

import org.opencms.ade.configuration.CmsADEConfigData;
import org.opencms.ade.configuration.CmsConfigurationReader;
import org.opencms.file.CmsObject;
import org.opencms.util.CmsUUID;
import org.opencms.xml.containerpage.I_CmsFormatterBean;
import org.opencms.xml.content.CmsXmlContent;
import org.opencms.xml.content.CmsXmlContentRootLocation;

import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;

import com.google.common.collect.Lists;

/**
 * Widget used to select a formatter to remove.
 *
 * Please note that this widget assumes the resource being edited is a sitemap configuration, and will not work correctly in a different context.
 */
public class CmsRemoveFormatterWidget extends A_CmsFormatterWidget {

    /**
     * Default constructor.

     */
    public CmsRemoveFormatterWidget() {

        super();
    }

    /**
     * Constructor with a configuration parameter.
     * @param config the configuration string
     */
    public CmsRemoveFormatterWidget(String config) {

        super();
    }

    /**
     * @see org.opencms.widgets.I_CmsADEWidget#getCssResourceLinks(org.opencms.file.CmsObject)
     */
    @Override
    public List getCssResourceLinks(CmsObject cms) {

        return null;
    }

    /**
     * @see org.opencms.widgets.I_CmsADEWidget#getInitCall()
     */
    @Override
    public String getInitCall() {

        return null;
    }

    /**
     * @see org.opencms.widgets.I_CmsADEWidget#getJavaScriptResourceLinks(org.opencms.file.CmsObject)
     */
    @Override
    public List getJavaScriptResourceLinks(CmsObject cms) {

        return null;
    }

    /**
     * @see org.opencms.widgets.I_CmsADEWidget#isInternal()
     */
    @Override
    public boolean isInternal() {

        return true;
    }

    /**
     * @see org.opencms.widgets.CmsSelectWidget#newInstance()
     */
    @Override
    public I_CmsWidget newInstance() {

        return new CmsRemoveFormatterWidget();
    }

    /**
     * @see org.opencms.widgets.A_CmsFormatterWidget#getFormatterOptions(org.opencms.file.CmsObject, org.opencms.ade.configuration.CmsADEConfigData, java.lang.String, boolean)
     */
    @Override
    protected List getFormatterOptions(
        CmsObject cms,
        CmsADEConfigData config,
        String rootPath,
        boolean allRemoved) {

        List result = Lists.newArrayList();
        if (!allRemoved) {
            Map activeFormatters = config.getActiveFormatters();
            List formatters = Lists.newArrayList(activeFormatters.values());
            Collections.sort(formatters, new A_CmsFormatterWidget.FormatterSelectComparator());
            for (I_CmsFormatterBean formatterBean : formatters) {
                CmsSelectWidgetOption option = getWidgetOptionForFormatter(cms, formatterBean);
                result.add(option);
            }
        }
        return result;
    }

    /**
     * @see org.opencms.widgets.A_CmsFormatterWidget#getSelectedInFile(org.opencms.ade.configuration.CmsConfigurationReader, org.opencms.xml.content.CmsXmlContent)
     */
    @Override
    protected Set getSelectedInFile(CmsConfigurationReader reader, CmsXmlContent content) {

        CmsXmlContentRootLocation root = new CmsXmlContentRootLocation(content, Locale.ENGLISH);
        Set addFormatters = reader.parseRemoveFormatters(root);
        return addFormatters;
    }

    /**
     * @see org.opencms.widgets.A_CmsFormatterWidget#getTypeOptions(org.opencms.file.CmsObject, org.opencms.ade.configuration.CmsADEConfigData, boolean)
     */
    @Override
    protected List getTypeOptions(
        CmsObject cms,
        CmsADEConfigData adeConfig,
        boolean allRemoved) {

        List result = Lists.newArrayList();
        if (!allRemoved) {
            Set activeTypes = adeConfig.getTypesWithActiveSchemaFormatters();
            for (String activeType : activeTypes) {
                CmsSelectWidgetOption option = getWidgetOptionForType(cms, activeType);
                result.add(option);
            }
        }
        return result;
    }

}