Package com.acrolinx.sidebar

Interface AcrolinxIntegration

public interface AcrolinxIntegration
This interface needs be implemented to integrate Acrolinx with an editor or editing environment. These methods are called by the Acrolinx Sidebar to interact with the editor.

Remember to activate logging by using LoggingUtils.setupDefaultLogging() on application/plugin start.

  • Method Details

    • getEditorAdapter

      InputAdapterInterface getEditorAdapter()
      Adapter to extract the text to be checked. It needs to be an implementation of InputAdapterInterface.
      See Also:

    • getInitParameters

      AcrolinxSidebarInitParameter getInitParameters()
      Gets the parameters used to initialize the Acrolinx Sidebar.
      See Also:

    • onCheckResult

      void onCheckResult(CheckResult checkResult)
      Notifies the Acrolinx Integration about the checks result.

    • onInitFinished

      void onInitFinished(Optional<SidebarError> initResult)
      Notifies the Acrolinx Integration about the result of the initializing process.

    • openDocumentInEditor

      boolean openDocumentInEditor(String documentIdentifier)
      Opens the given document in editor and notifies the sidebar that the document has been opened.

    • extractReferences

      List<BatchCheckRequestOptions> extractReferences()
      Extracts all the references that should be listed for background check

    • getCheckOptionsForDocument

      CheckOptions getCheckOptionsForDocument(String documentIdentifier)
      Called together with getContentForDocument before running the background check on the given document.

    • getContentForDocument

      String getContentForDocument(String documentIdentifier)
      Gets the content for a requested background check