Class AuthorCalloutRenderingInformation
java.lang.Object
ro.sync.ecss.extensions.api.callouts.AuthorCalloutRenderingInformation
@API(type=EXTENDABLE,
src=PUBLIC)
public abstract class AuthorCalloutRenderingInformation
extends Object
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
The AuthorReviewCalloutInformation object holds the data that will be rendered as a callout, in Author mode.
To render a custom highlight as a callout in Author mode, a callouts information provider must be set from
By default, the callouts visibility in Author mode is controlled from Oxygen Preferences but it can be changed by using the
AuthorCalloutsController
methods.
The AuthorReviewCalloutInformation object holds the data that will be rendered as a callout, in Author mode.
To render a custom highlight as a callout in Author mode, a callouts information provider must be set from
AuthorCalloutsController.setCalloutsRenderingInformationProvider(CalloutsRenderingInformationProvider)
method.- Since:
- 14
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionProvides the review additional data that will be presented in the callout content part.abstract String
Provides the reviewer author name that will be presented in the callout header part, ifgetHeaderInformation()
method returnsnull
.abstract String
Provides a human readable string representing the callout type that will be rendered as a description of the callout, in the header part, ifgetHeaderInformation()
method returnsnull
.abstract Color
getColor()
Provides color for styling the associated callout box.abstract String
getComment
(int limit) Provides the review comment that will be presented in the callout content part.abstract String
getContentFromTarget
(int limit) Provides a section from the document content that is covered by this callout.Provides a human readable string representing the callout description that will be rendered in the header part.abstract long
Provides the review creation or modification time.
-
Constructor Details
-
AuthorCalloutRenderingInformation
public AuthorCalloutRenderingInformation()
-
-
Method Details
-
getAuthor
Provides the reviewer author name that will be presented in the callout header part, ifgetHeaderInformation()
method returnsnull
.- Returns:
- the reviewer author name.
Can be
null
if the author is not relevant.
-
getTimestamp
public abstract long getTimestamp()Provides the review creation or modification time.- Returns:
- the review creation or modification time.
Returns the number of milliseconds since January 1, 1970, 00:00:00 GMT
Can be
-1
if the modification time was not set. In this case, the callout will not present any information regarding the review creation or modification time.
-
getComment
Provides the review comment that will be presented in the callout content part. This could be a part of the real comment stored in the change or persistent highlight.- Parameters:
limit
- the suggested text limit (in characters). This value comes from the Callouts Options (user preferences). Examples: 80 or 160 characters.- Returns:
- the review comment.
Can be
null
if a comment is not available for this callout.
-
getContentFromTarget
Provides a section from the document content that is covered by this callout. This will be presented in the content part of the callout. Note that it is not necessary to provide the entire content related to the callout.- Parameters:
limit
- the suggested text limit (in characters). This value comes from the Callouts Options (user preferences). Examples: 80 or 160 characters.- Returns:
- the limited document content. Can be
null
if the content is not relevant for the callout.
-
getAdditionalData
Provides the review additional data that will be presented in the callout content part.
The callout additional data must be provided as a map between data type and actual callout data. It will be rendered inside the callout as "data_type: data" strings, separated by new lines.- Returns:
- The review additional data.
Can be
null
if there is no additional information available for this review.
-
getCalloutType
Provides a human readable string representing the callout type that will be rendered as a description of the callout, in the header part, ifgetHeaderInformation()
method returnsnull
.- Returns:
- The human readable string representing the callout type or
null
if the type is not relevant.
-
getHeaderInformation
Provides a human readable string representing the callout description that will be rendered in the header part.- Returns:
- The callout description to be rendered in the header part. If this is
null
, the header will render the type (provided bygetCalloutType()
method) and the author (provided bygetAuthor()
method) - Since:
- 18
-
getColor
Provides color for styling the associated callout box.- Returns:
- The color to be used for rendering the callout. Can be
null
for the default.
-