HighlightActionsProvider (Oxygen XML API)

java.lang.Object
- ro.sync.ecss.extensions.api.highlights.HighlightActionsProvider

@API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class HighlightActionsProvider
extends java.lang.Object

Provider for the actions available for a highlight.

Since:: 17.1

Constructor Summary

Constructors
Constructor Description

HighlightActionsProvider()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract java.util.List`	`getActions(AuthorAccess authorAccess)`	Get the available actions for a highlight.
`abstract java.lang.Object`	`getCollapsedWidgetIcon()`	Get the icon for the collapsed widget.
`abstract java.lang.Object`	`getExpandedWidgetIcon()`	Get the icon for the expanded widget.
`HighlightActionsRenderingStyle`	`getRenderingStyle()`	Get the rendering style of the actions.
`java.lang.String`	`getWidgetTooltipMessage()`	Get the tolltip message displayed when hovering over the widget.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HighlightActionsProvider
```
public HighlightActionsProvider()
```
- Method Detail
  - getActions
```
public abstract java.util.List getActions(AuthorAccess authorAccess)
```
    Get the available actions for a highlight.
    
    Parameters:
    
    authorAccess - The author access.
    
    Returns:
    
    the list of actions.
  - getCollapsedWidgetIcon
```
public abstract java.lang.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 java.lang.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 java.lang.String getWidgetTooltipMessage()
```
    Get the tolltip message displayed when hovering over the widget.
    
    Returns:
    
    The tooltip message displayed on the widget.