@API(type=EXTENDABLE,
src=PUBLIC)
public abstract class AuthorCalloutRenderingInformation
extends java.lang.Object
AuthorCalloutsController
methods.
AuthorCalloutsController.setCalloutsRenderingInformationProvider(CalloutsRenderingInformationProvider)
method.Constructor and Description |
---|
AuthorCalloutRenderingInformation() |
Modifier and Type | Method and Description |
---|---|
abstract java.util.Map<java.lang.String,java.lang.String> |
getAdditionalData()
Provides the review additional data that will be presented in the callout content part.
|
abstract java.lang.String |
getAuthor()
Provides the reviewer author name that will be presented in the callout header part,
if
getHeaderInformation() method returns null . |
abstract java.lang.String |
getCalloutType()
Provides a human readable string representing the callout type that will be rendered
as a description of the callout, in the header part, if
getHeaderInformation()
method returns null . |
abstract Color |
getColor()
Provides color for styling the associated callout box.
|
abstract java.lang.String |
getComment(int limit)
Provides the review comment that will be presented in the callout content part.
|
abstract java.lang.String |
getContentFromTarget(int limit)
Provides a section from the document content that is covered by this callout.
|
java.lang.String |
getHeaderInformation()
Provides a human readable string representing the callout description that will be rendered
in the header part.
|
abstract long |
getTimestamp()
Provides the review creation or modification time.
|
public abstract java.lang.String getAuthor()
getHeaderInformation()
method returns null
.null
if the author is not relevant.public abstract long getTimestamp()
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.
public abstract java.lang.String getComment(int limit)
limit
- the suggested text limit (in characters). This value comes from the
Callouts Options (user preferences). Examples: 80 or 160 characters.null
if a comment is not available for this callout.public abstract java.lang.String getContentFromTarget(int limit)
limit
- the suggested text limit (in characters). This value comes from the
Callouts Options (user preferences). Examples: 80 or 160 characters.null
if the
content is not relevant for the callout.public abstract java.util.Map<java.lang.String,java.lang.String> getAdditionalData()
null
if there is no additional information available for this review.public abstract java.lang.String getCalloutType()
getHeaderInformation()
method returns null
.null
if the type is not relevant.public java.lang.String getHeaderInformation()
null
,
the header will render the type (provided by getCalloutType()
method) and the author
(provided by getAuthor()
method)public abstract Color getColor()
null
for the default.© Copyright Syncro Soft SRL 2002 - 2022. All rights reserved.