Package ro.sync.ecss.extensions.api

Interface AuthorReviewController

    • Method Detail

      • getAuthorCalloutsController

        AuthorCalloutsController getAuthorCalloutsController()
        The callouts are representations of Track Changes insert and delete highlights, review comment highlights and the custom review highlights in Author mode.
        This controller can be used to check what types of callouts are presented in Author mode. It also can be used to override the callouts display options from Oxygen Preferences.
        Returns:
        The Author review callouts controller.
        Since:
        14

      • getAuthorReviewViewController

        AuthorReviewViewController getAuthorReviewViewController()
        The entries in the Review View are representations of Track Changes insert and delete highlights, review comment highlights in Author mode.
        This controller can override review entries display options and contextual menu actions.
        Returns:
        The Author Review View controller.
        Since:
        17.1

      • getCurrentTimestamp

        java.lang.String getCurrentTimestamp()
        Get the current time stamp in a format identical to the one used by Oxygen for insert and delete review highlights.
        Form: yyyyMMdd'T'HHmmssZ
        Returns:
        the current time stamp.

      • getReviewerAutoColor

        Color getReviewerAutoColor​(java.lang.String reviewerAuthorName)
        Get a color assigned automatically to the reviewer author name.
        It is used when in the Oxygen Preferences Auto coloring is set for the Insert, Delete or Comment reviews.
        Parameters:
        reviewerAuthorName - The reviewer author name.
        Returns:
        The color automatically assigned to the specified author. Never null.

      • setReviewRenderer

        void setReviewRenderer​(PersistentHighlightRenderer renderer)
        Set a renderer for customizing the way that the review highlights (Insert, Delete or Comment) are displayed.
        Parameters:
        renderer - the renderer used to customize painting for the review highlights.

      • getCommentHighlights

        AuthorPersistentHighlight[] getCommentHighlights()
        Fetches the list of comment highlights.
        Returns:
        The comment highlights array.
        Since:
        12

      • getCommentHighlights

        AuthorPersistentHighlight[] getCommentHighlights​(int startOffset,
                                                 int endOffset)
        Fetches the list of comment highlights that intersect the interval between the given start offset and end offset.
        Parameters:
        startOffset - The start offset(inclusive).
        endOffset - The end offset (inclusive).
        Returns:
        The comment highlights array. Can be null if no comment highlight intersects the given offsets interval.
        Since:
        14.1

      • setPersistentHighlightProperties

        void setPersistentHighlightProperties​(AuthorPersistentHighlight highlight,
                                      java.util.LinkedHashMap<java.lang.String,​java.lang.String> properties)
                               throws java.lang.IllegalArgumentException
        Set some properties to a persistent highlight. A copy of the initial properties can be obtained from AuthorPersistentHighlight.getClonedProperties() Please note that this method allows setting the properties of all persistent highlights, whether the current author is the author of the highlight or not. The existing properties will be overwritten, excepting the ones that are specific to Oxygen XML comments or track changes processing instructions, that cannot be changed. You can see the name of these specific properties in AuthorPersistentHighlightConstants.
        Parameters:
        highlight - The highlight.
        properties - name/value pairs which will get serialized to disk.

        Notes:
        1. Each property name must be a valid XML attribute name.
        2. Each property value will be escaped to be a valid XML attribute value. 3. A null value means that the property will be removed.

        Throws:
        java.lang.IllegalArgumentException - Thrown when a property name is not a valid XML attribute name or when the given properties map contains a property specific to Oxygen XML comments or track changes processing instructions
        Since:
        23.1

      • removePersistentHighlightProperties

        void removePersistentHighlightProperties​(AuthorPersistentHighlight highlight,
                                         java.util.List<java.lang.String> properties)
                                  throws java.lang.IllegalArgumentException
        Remove properties from a persistent highlight. A copy of the initial properties can be obtained from AuthorPersistentHighlight.getClonedProperties() Please note that the properties that are specific to Oxygen XML comments or track changes processing instructions cannot be removed. You can see the name of these specific properties in AuthorPersistentHighlightConstants
        Parameters:
        highlight - The highlight.
        properties - The names of the properties to be removed.
        Throws:
        java.lang.IllegalArgumentException - Thrown when trying to remove a property specific to Oxygen XML comments or track changes processing instructions
        Since:
        23.1

      • removeAuthorPersistentHighlightListener

        void removeAuthorPersistentHighlightListener​(AuthorPersistentHighlightsListener listener)
        Removes a persistent highlights listener.
        Parameters:
        listener - The listener to remove.
        Since:
        23.1

      • addPersistentHighlightsFilter

        void addPersistentHighlightsFilter​(AuthorPersistentHighlightsFilter persistentHighlightsFilter)
        Add a persistent highlights filter. A filter capable of filtering the highlights by author is present by default.
        Parameters:
        persistentHighlightsFilter - The filter to be added.
        Since:
        23.1