Package org.opencms.widgets

Interface I_CmsWidget

All Known Subinterfaces:
I_CmsADEWidget
All Known Implementing Classes:
A_CmsAdeGalleryWidget, A_CmsCategorizedSelectWidget, A_CmsFormatterWidget, A_CmsGalleryWidget, A_CmsHtmlWidget, A_CmsSelectWidget, A_CmsWidget, CmsAccessRestrictionWidget, CmsAddFormatterWidget, CmsAdeDownloadGalleryWidget, CmsAdeImageGalleryWidget, CmsCalendarWidget, CmsCategoryWidget, CmsCheckboxWidget, CmsCodeWidget, CmsColorpickerWidget, CmsComboWidget, CmsDependentSelectWidget, CmsDisplayTypeSelectWidget, CmsDisplayWidget, CmsDownloadGalleryWidget, CmsElementViewSelectWidget, CmsFilterSelectWidget, CmsGroupWidget, CmsHtmlWidget, CmsHttpUploadWidget, CmsImageGalleryWidget, CmsInputWidget, CmsInputWidgetPlaintext, CmsLinkGalleryWidget, CmsLocalizationWidget, CmsLocationPickerWidget, CmsMultiSelectGroupWidget, CmsMultiSelectWidget, CmsOrgUnitWidget, CmsPasswordWidget, CmsPrincipalWidget, CmsRadioSelectWidget, CmsRemoveFormatterWidget, CmsSelectComboWidget, CmsSelectGroupWidget, CmsSelectOnChangeReloadWidget, CmsSelectWidget, CmsSerialDateWidget, CmsTextareaWidget, CmsTextareaWidgetPlaintext, CmsTypeComboWidget, CmsTypeFilterWidget, CmsUserWidget, CmsVfsFileWidget, CmsVfsImageWidget
public interface I_CmsWidget
Describes an editor widget for use in the OpenCms workplace.

Since:
6.0.0

  • Method Details

    • getConfiguration

      String getConfiguration()
      Returns the configuration string.

      This can be used to enable / disable certain widget features that should not always be available, or to pass specific initialization information to the widget. It depends on the widget implementation on how this information is used.

      Returns:
      the configuration string

    • getDialogHtmlEnd

      String getDialogHtmlEnd(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
      Generates the html to include at the end of the dialog for this widget.

      The "help bubble" text div's are added using this method.

      Parameters:
      cms - the current users OpenCms context
      widgetDialog - the dialog where the widget is used on
      param - the widget parameter to generate the widget for
      Returns:
      the html to include at the end of the dialog for this widget

    • getDialogIncludes

      String getDialogIncludes(CmsObject cms, I_CmsWidgetDialog widgetDialog)
      Generates the necessary JavaScript inclusion code for this widget.

      Parameters:
      cms - the current users OpenCms context
      widgetDialog - the dialog where the widget is used on
      Returns:
      the JavaScript inclusion code

    • getDialogInitCall

      String getDialogInitCall(CmsObject cms, I_CmsWidgetDialog widgetDialog)
      Generates the initialisation method JavaScript code for this widget.

      Parameters:
      cms - the current users OpenCms context
      widgetDialog - the dialog where the widget is used on
      Returns:
      the initialisation method JavaScript code

    • getDialogInitMethod

      String getDialogInitMethod(CmsObject cms, I_CmsWidgetDialog widgetDialog)
      Generates the initialization method JavaScript code for this widget.

      Parameters:
      cms - an initialized instance of a CmsObject
      widgetDialog - the dialog where the widget is used on
      Returns:
      the initialization method JavaScript code

    • getDialogWidget

      String getDialogWidget(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
      Generates the widget HTML for the provided widget parameter.

      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 widget HTML for the provided widget parameter

    • getHelpBubble

      String getHelpBubble(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
      Creates the HTML code for the help bubble for this widget.

      Parameters:
      cms - the current users OpenCms context
      widgetDialog - the dialog where the widget is used on
      param - the widget parameter to generate the widget for
      Returns:
      the HTML code for the help bubble for this widget

    • getHelpText

      String getHelpText(I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter value)
      Creates a HTML <div> containing the help text for this widget.

      Parameters:
      widgetDialog - the dialog where the widget is used on
      value - the value to create the help bubble for
      Returns:
      a HTML <div> containing the help text for this widget

    • getWidgetStringValue

      String getWidgetStringValue(CmsObject cms, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
      Returns the I_CmsWidgetParameter.getStringValue(CmsObject) processed according to the output rules of this widget and the given widget dialog.

      Parameters:
      cms - the current users OpenCms context
      widgetDialog - the dialog where the widget is used on
      param - the widget parameter to generate the widget for
      Returns:
      the I_CmsWidgetParameter.getStringValue(CmsObject) processed according to the output rules of this widget
      See Also:

    • isCompactViewEnabled

      boolean isCompactViewEnabled()
      Returns if the widget is compact view enabled.

      Returns:
      true if the widget is compact view enabled

    • newInstance

      I_CmsWidget newInstance()
      Creates a duplicate of this widget instance.

      Returns:
      a duplicate of this widget instance

    • setConfiguration

      void setConfiguration(String configuration)
      Sets the configuration of this widget.

      This can be used to enable / disable certain widget features that should not always be available, or to pass specific initialization information to the widget. It depends on the widget implementation on how this information is used.

      Parameters:
      configuration - the configuration to set

    • setEditorValue

      void setEditorValue(CmsObject cms, Map<String,String[]> formParameters, I_CmsWidgetDialog widgetDialog, I_CmsWidgetParameter param)
      Sets the value of in the given widget parameter by reading the "right" value from the offered map of parameters.

      Parameters:
      cms - the current users OpenCms context
      formParameters - the map of parameters to get the value from
      widgetDialog - the dialog where the widget is used on
      param - the widget parameter to generate the widget for