Interface ContextDescriptionProvider

All Known Subinterfaces:
InputURLChooser

@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface ContextDescriptionProvider
Provides language-independent information about a certain context.
Since:
14.2
  • Method Details

    • getContextDescription

      String getContextDescription()
      Get a language-independent description for the dialog in which the CMS action will be provided. Can be null if no such description is available.
      Returns:
      a language-independent description for the dialog in which the CMS action will be provided. Can be null if no such description is available.
    • getAttributeEditingContextDescription

      AttributeEditingContextDescription getAttributeEditingContextDescription()
      When the chooser is used for editing an attribute value, we can obtain an additional description about the element name and the attribute name which is being edited.
      Returns:
      an additional description about the element name and the attribute name which is being edited. Can be null if the editing context is not called when editing an attribute value.
      Since:
      15