Package org.opencms.widgets

Interface I_CmsGalleryWidgetDynamicConfiguration

public interface I_CmsGalleryWidgetDynamicConfiguration
Enables a dynamic configuration of values for the A_CmsGalleryWidget.

The following values can be configured dynamically:

  • The type of the preselected item list (gallery or category)
  • The preselected item list (i.e. a gallery folder or category)
Since:
7.5.0

  • Method Details

    • getStartup

      String getStartup(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param)
      Returns the required information for the initial item 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 item list to load

    • getType

      String getType(CmsObject cms, CmsMessages widgetDialog, I_CmsWidgetParameter param)
      Returns the type of the initial item 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