Package com.acrolinx.sidebar

Interface InputAdapterInterface

    • Method Detail

      • getInputFormat

        InputFormat getInputFormat()
        Receives the current input format. If this method returns null, the check will be canceled by the sidebar.
        Returns:
        Returns the current input format.
        See Also:
        InputFormat

      • getContent

        java.lang.String getContent()
        Receives the current text from the editor.
        Returns:
        Returns the text to be checked.

      • getExternalContent

        ExternalContent getExternalContent()
        Receives the external text from the editor. Only supported with Acrolinx Platform 2019.10 (Sidebar version 14.16) and newer. Return null if not used.
        Returns:
        Returns the object for external content.

      • getDocumentReference

        java.lang.String getDocumentReference()
        The path or filename of the document to check. In a CMS, it can be the id that is used to look up the document.

      • selectRanges

        void selectRanges​(java.lang.String checkId,
                  java.util.List<AcrolinxMatch> acrolinxMatches)
        Is called by the Acrolinx Integration to highlight current issues in the text editor.

        Note that the matches contain the ranges as found in the originally checked text. It might be necessary to implement some lookup algorithm here to map these ranges to the current document (which might have changed in the meantime).

        Parameters:
        checkId - The current check id.
        acrolinxMatches - The ranges to be highlighted as sent by the AcrolinxServer.

      • replaceRanges

        void replaceRanges​(java.lang.String checkId,
                   java.util.List<AcrolinxMatchWithReplacement> matchesWithReplacement)
        Is called by the Acrolinx Integration to replace found issues with suggestions from the Acrolinx Sidebar. If the Acrolinx Sidebar is configured as read only, this method won't be called.

        Note that the matches contain the ranges as found in the originally checked text. It might be necessary to implement some lookup algorithm here to map these ranges to the current document (which might have changed in the meantime).

        Parameters:
        checkId - The current check id.
        matchesWithReplacement - The ranges to be replaced.

      • getCurrentSelection

        java.util.List<IntRange> getCurrentSelection()
        Is called when checkSelection is enabled to get the current selected intRange for checking.
        Returns:
        currently selected range.