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.widgets;
029
030import org.opencms.file.CmsObject;
031import org.opencms.i18n.CmsMessages;
032
033import java.util.List;
034
035/**
036 * Enables a dynamic configuration of values for the {@link CmsVfsImageWidget}.<p>
037 *
038 * The following values can be configured dynamically:
039 * <ul>
040 * <li>The list of image format values for the corresponding format names</li>
041 * <li>The type of the preselected image list (gallery or category)</li>
042 * <li>The preselected image list (i.e. a gallery folder or category)</li>
043 * </ul>
044 *
045 * @since 7.5.0
046 */
047public interface I_CmsImageWidgetDynamicConfiguration {
048
049    /**
050     * Returns the matching format values for the given format select options.<p>
051     *
052     * A format value should look like this:
053     * <ul>
054     * <li>320x480: The width and height as fixed values</li>
055     * <li>320x?: A fixed width and dynamic height</li>
056     * </ul>
057     *
058     * @param cms an initialized instance of a CmsObject
059     * @param widgetDialog the dialog where the widget is used on
060     * @param param the widget parameter to generate the widget for
061     * @param selectFormat the list of format select options ({@link CmsSelectWidgetOption}) for the widget
062     * @param formatValues the list of predefined format values for the widget
063     * @return  the matching format values for the given format select options
064     */
065    List<String> getFormatValues(
066        CmsObject cms,
067        CmsMessages widgetDialog,
068        I_CmsWidgetParameter param,
069        List<CmsSelectWidgetOption> selectFormat,
070        List<String> formatValues);
071
072    /**
073     * Returns the required information for the initial image list to load.<p>
074     *
075     * If a gallery should be shown, the path to the gallery must be specified,
076     * for a category the category path.<p>
077     *
078     * @param cms an initialized instance of a CmsObject
079     * @param widgetDialog the dialog where the widget is used on
080     * @param param the widget parameter to generate the widget for
081     * @return the required information for the initial image list to load
082     */
083    String getStartup(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param);
084
085    /**
086     * Returns the type of the initial image list to load, either gallery or category.<p>
087     *
088     * @param cms an initialized instance of a CmsObject
089     * @param widgetDialog the dialog where the widget is used on
090     * @param param the widget parameter to generate the widget for
091     * @return the type of the initial image list to load, either gallery or category
092     */
093    String getType(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param);
094}