Package org.opencms.widgets

Interface I_CmsComplexWidget

All Known Implementing Classes:
A_CmsNativeComplexWidget, CmsDataViewWidget, CmsDefaultComplexWidget
public interface I_CmsComplexWidget
Interface for complex widgets which are used in the Acacia editor to render whole nested contents.

  • Method Details

    • configure

      I_CmsComplexWidget configure(String configuration)
      Returns a copy of this widget which has been configured with the given configuration string.

      Parameters:
      configuration - the configuration string
      Returns:
      the configured copy of the widget

    • getName

      String getName()
      Gets the name of the complex widget.

      The string returned by this function should be a valid Javascript identifier.

      Returns:
      the name of the complex widget

    • getWidgetData

      CmsComplexWidgetData getWidgetData(CmsObject cms)
      Gets the data needed for the editor to render the complex widget.

      Parameters:
      cms - The CMS object to use for VFS operations
      Returns:
      the data for the complex widget