ro.sync.ecss.extensions.api.callouts
Class CalloutsRenderingInformationProvider

java.lang.Object
  ro.sync.ecss.extensions.api.callouts.CalloutsRenderingInformationProvider

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

Provider for data that will be rendered as callouts, in Author mode, for custom persistent highlights.
The callouts are representations of Track Changes insert and delete highlights, review comment highlights and custom review highlights in Author mode.
By default, the callouts visibility in Author mode is controlled from Oxygen Preferences but it can be changed by using the AuthorCalloutsController methods.
The callouts rendering provider can be set from AuthorCalloutsController.setCalloutsRenderingInformationProvider(CalloutsRenderingInformationProvider)

Since:

14
*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

Constructor Summary

CalloutsRenderingInformationProvider()

Method Summary

abstract AuthorCalloutRenderingInformation	getCalloutRenderingInformation(AuthorPersistentHighlight highlight) Get the callout rendering information associated with a custom persistent highlight.
abstract boolean	shouldRenderAsCallout(AuthorPersistentHighlight highlight) Asks if a custom persistent highlight should be rendered as a callout in the Author mode.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CalloutsRenderingInformationProvider

public CalloutsRenderingInformationProvider()

Method Detail

getCalloutRenderingInformation

public abstract AuthorCalloutRenderingInformation getCalloutRenderingInformation(AuthorPersistentHighlight highlight)

Get the callout rendering information associated with a custom persistent highlight. The callout rendering information is requested only for that custom persistent highlights for which the shouldRenderAsCallout(AuthorPersistentHighlight) returns true.
The callouts are representations of Track Changes insert and delete highlights, review comment highlights and custom review highlights in Author mode.

Parameters:

highlight - The Author persistent highlight.

Returns:

The callout rendering information associated with a custom persistent highlight or null if the highlight must not be rendered in Author as a callout.

shouldRenderAsCallout

public abstract boolean shouldRenderAsCallout(AuthorPersistentHighlight highlight)

Asks if a custom persistent highlight should be rendered as a callout in the Author mode.
The callouts are representations of Track Changes insert and delete highlights, review comment highlights and custom persistent highlights in Author mode.
If this method returns true, the callout rendering information for this callout must be provided by getCalloutRenderingInformation(AuthorPersistentHighlight) method.
The implementation of this method must be fast, being called frequently.

Parameters:

highlight - The Author custom persistent highlight.

Returns:

true if the highlight can be rendered as a callout in Author mode.