Package ro.sync.ecss.extensions.api.highlights

Class HighlightActionsProvider

java.lang.Object
ro.sync.ecss.extensions.api.highlights.HighlightActionsProvider
@API(type=EXTENDABLE, src=PUBLIC) public abstract class HighlightActionsProvider extends Object
Provider for the actions available for a highlight.
Since:
17.1

  • Constructor Details

    • HighlightActionsProvider

      public HighlightActionsProvider()

  • Method Details

    • getActions

      public abstract List getActions(AuthorAccess authorAccess)
      Get the available actions for a highlight.
      Parameters:
      authorAccess - The author access.
      Returns:
      the list of actions.

    • getCollapsedWidgetIcon

      public abstract Object getCollapsedWidgetIcon()
      Get the icon for the collapsed widget. The collapsed widget is shown when hovering over a highlight.
      Returns:
      the icon for the collapsed widget.

    • getExpandedWidgetIcon

      public abstract Object getExpandedWidgetIcon()
      Get the icon for the expanded widget. The expanded widget is shown when hovering over the collapsed widget. The collapsed widget is shown when hovering over a highlight.
      Returns:
      the icon for the expanded widget.

    • getRenderingStyle

      public HighlightActionsRenderingStyle getRenderingStyle()
      Get the rendering style of the actions.
      Returns:
      the rendering style of the actions.

    • getWidgetTooltipMessage

      public String getWidgetTooltipMessage()
      Get the tolltip message displayed when hovering over the widget.
      Returns:
      The tooltip message displayed on the widget.