Package ro.sync.ecss.extensions.api.review

Class AuthorReviewRenderingInformation

  • @API(type=EXTENDABLE,
     src=PUBLIC)
public abstract class AuthorReviewRenderingInformation
extends java.lang.Object
    The review view entries are representations of Track Changes insert and delete highlights and review comment highlights highlights in Author mode.
    Since:
    17.1

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getAuthor()
      Provides the reviewer author name that will be presented in the review view entry.
      Color getColor()
      Provides color for styling the associated review entry box.
      java.lang.String getComment​(int limit)
      Provides the review comment that will be presented in the review entry.
      java.lang.String getContentFromTarget​(int limit)
      Provides a section from the document content that is covered by this review entry.
      java.lang.String getIconPath()
      Provides the icon URL path for styling the associated review entry box.
      long getTimestamp()
      Provides the review creation or modification time.
      java.lang.String getTooltip()
      Get tooltip to show when hovering over the review entry.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AuthorReviewRenderingInformation

        public AuthorReviewRenderingInformation()

    • Method Detail

      • getAuthor

        public java.lang.String getAuthor()
        Provides the reviewer author name that will be presented in the review view entry.
        Returns:
        the reviewer author name. Can be null if the default author must be used

      • getTimestamp

        public 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 review view will present the default detected timestamp.

      • getTooltip

        public java.lang.String getTooltip()
        Get tooltip to show when hovering over the review entry. By default this shows the review creation or modification time.
        Returns:
        the tooltip to show when hovering over the review entry.

        Can be null to use the default behavior.

      • getComment

        public java.lang.String getComment​(int limit)
        Provides the review comment that will be presented in the review entry. This could be a part of the real comment stored in the change or persistent highlight.
        Parameters:
        limit - the suggested text limit (in characters).
        Returns:
        the review comment. Can be null if you want the default processing to be performed.

      • getContentFromTarget

        public java.lang.String getContentFromTarget​(int limit)
        Provides a section from the document content that is covered by this review entry. This will be presented in the content part of the review entry. Note that it is not necessary to provide the entire content related to the review entry.
        Parameters:
        limit - the suggested text limit (in characters).
        Returns:
        the limited document content. Can be null if the content should be processed using the default behavior.

      • getColor

        public Color getColor()
        Provides color for styling the associated review entry box.
        Returns:
        The color to be used for rendering the review entry. Can be null for the default.

      • getIconPath

        public java.lang.String getIconPath()
        Provides the icon URL path for styling the associated review entry box.
        Returns:
        The icon to be used for rendering the review entry. Can be null for the default.