Package ro.sync.ecss.extensions.api.callouts

Class AuthorCalloutRenderingInformation

  • @API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class AuthorCalloutRenderingInformation
extends java.lang.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 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

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method 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.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AuthorCalloutRenderingInformation

        public AuthorCalloutRenderingInformation()

    • Method Detail

      • getAuthor

        public abstract java.lang.String getAuthor()
        Provides the reviewer author name that will be presented in the callout header part, if getHeaderInformation() method returns null.
        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

        public abstract java.lang.String getComment​(int limit)
        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

        public abstract java.lang.String getContentFromTarget​(int limit)
        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

        public 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.
        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

        public 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.
        Returns:
        The human readable string representing the callout type or null if the type is not relevant.

      • getHeaderInformation

        public java.lang.String 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 by getCalloutType() method) and the author (provided by getAuthor() method)
        Since:
        18

      • getColor

        public abstract Color 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.