org.opencms.widgets

Interface I_CmsImageWidgetDynamicConfiguration

public interface I_CmsImageWidgetDynamicConfiguration

Enables a dynamic configuration of values for the CmsVfsImageWidget.

The following values can be configured dynamically:

• The list of image format values for the corresponding format names
• The type of the preselected image list (gallery or category)
• The preselected image list (i.e. a gallery folder or category)

Since:

7.5.0

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getFormatValues(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param, java.util.List<CmsSelectWidgetOption> selectFormat, java.util.List<java.lang.String> formatValues) Returns the matching format values for the given format select options.
java.lang.String	getStartup(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param) Returns the required information for the initial image list to load.
java.lang.String	getType(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param) Returns the type of the initial image list to load, either gallery or category.

Method Detail

getFormatValues

java.util.List<java.lang.String> getFormatValues(CmsObject cms,
                                               CmsMessages widgetDialog,
                                               I_CmsWidgetParameter param,
                                               java.util.List<CmsSelectWidgetOption> selectFormat,
                                               java.util.List<java.lang.String> formatValues)

Returns the matching format values for the given format select options.

A format value should look like this:

• 320x480: The width and height as fixed values
• 320x?: A fixed width and dynamic height

Parameters:

cms - an initialized instance of a CmsObject

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

selectFormat - the list of format select options (CmsSelectWidgetOption) for the widget

formatValues - the list of predefined format values for the widget

Returns:

the matching format values for the given format select options

getStartup

java.lang.String getStartup(CmsObject cms,
                          CmsMessages widgetDialog,
                          I_CmsWidgetParameter param)

Returns the required information for the initial image list to load.

If a gallery should be shown, the path to the gallery must be specified, for a category the category path.

Parameters:

cms - an initialized instance of a CmsObject

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

Returns:

the required information for the initial image list to load

getType

java.lang.String getType(CmsObject cms,
                       CmsMessages widgetDialog,
                       I_CmsWidgetParameter param)

Returns the type of the initial image list to load, either gallery or category.

Parameters:

cms - an initialized instance of a CmsObject

widgetDialog - the dialog where the widget is used on

param - the widget parameter to generate the widget for

Returns:

the type of the initial image list to load, either gallery or category