Package com.acrolinx.sidebar.adapter

Class NullEditorAdapter

java.lang.Object
com.acrolinx.sidebar.adapter.NullEditorAdapter
All Implemented Interfaces:
InputAdapterInterface
public class NullEditorAdapter extends Object implements InputAdapterInterface
Use as fallback input adapter.
See Also:

  • Constructor Details

    • NullEditorAdapter

      public NullEditorAdapter()

  • Method Details

    • getInputFormat

      public InputFormat getInputFormat()
      Description copied from interface: InputAdapterInterface
      Receives the current input format. If this method returns null, the check will be canceled by the sidebar.
      Specified by:
      getInputFormat in interface InputAdapterInterface
      Returns:
      Returns the current input format.
      See Also:

    • getContent

      public String getContent()
      Description copied from interface: InputAdapterInterface
      Receives the current text from the editor.
      Specified by:
      getContent in interface InputAdapterInterface
      Returns:
      Returns the text to be checked.

    • getExternalContent

      public ExternalContent getExternalContent()
      Description copied from interface: InputAdapterInterface
      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.
      Specified by:
      getExternalContent in interface InputAdapterInterface
      Returns:
      Returns the object for external content.

    • getDocumentReference

      public String getDocumentReference()
      Description copied from interface: InputAdapterInterface
      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.
      Specified by:
      getDocumentReference in interface InputAdapterInterface

    • selectRanges

      public void selectRanges(String checkId, List<AcrolinxMatch> acrolinxMatches)
      Description copied from interface: InputAdapterInterface
      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).

      Specified by:
      selectRanges in interface InputAdapterInterface
      Parameters:
      checkId - The current check id.
      acrolinxMatches - The ranges to be highlighted as sent by the AcrolinxServer.

    • replaceRanges

      public void replaceRanges(String checkId, List<AcrolinxMatchWithReplacement> matches)
      Description copied from interface: InputAdapterInterface
      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).

      Specified by:
      replaceRanges in interface InputAdapterInterface
      Parameters:
      checkId - The current check id.
      matches - The ranges to be replaced.

    • getCurrentSelection

      public List<IntRange> getCurrentSelection()
      Description copied from interface: InputAdapterInterface
      Is called when checkSelection is enabled to get the current selected intRange for checking.
      Specified by:
      getCurrentSelection in interface InputAdapterInterface
      Returns:
      currently selected range.