Package com.acrolinx.sidebar

Interface AcrolinxSidebar

All Known Implementing Classes:
AcrolinxMultiViewSidebarSwing, AcrolinxSidebarJFX, AcrolinxSidebarSwing, AcrolinxSidebarSWT
public interface AcrolinxSidebar
These commands are available to interact with the Acrolinx Sidebar.

  • Method Details

    • configure

      void configure(SidebarConfiguration sidebarConfiguration)
      Pushed the configuration to the Acrolinx Sidebar.
      See Also:

    • checkGlobal

      void checkGlobal()
      Triggers a check action in the Acrolinx Sidebar, same as pushing the checkButton.

    • onGlobalCheckRejected

      void onGlobalCheckRejected()
      Notifies the sidebar that the check was canceled.

    • invalidateRanges

      void invalidateRanges(List<CheckedDocumentPart> invalidCheckedDocumentRanges)
      Notifies the sidebar about invalid ranges of the current document. The sidebar will then invalidate all cards containing issues within this text range.

    • invalidateRangesForMatches

      void invalidateRangesForMatches(List<? extends AbstractMatch> matches)
      Notifies the sidebar about invalid ranges of the current document. The sidebar will then invalidate all cards containing issues within this text range for the current check.

    • loadSidebarFromServerLocation

      void loadSidebarFromServerLocation(String serverAddress)
      Load the sidebar from a different server address.

    • reload

      void reload()
      Reload the current sidebar.

    • getLastCheckedDocumentReference

      String getLastCheckedDocumentReference()
      Gets the document reference of the lasted successfully checked document.
      Returns:
      documentReference

    • getLastCheckedDocument

      String getLastCheckedDocument()
      Gets the content of the lasted successfully checked document.
      Returns:
      documentContent

    • showMessage

      void showMessage(SidebarMessage sidebarMessage)
      Shows a message in the sidebar.

    • initBatchCheck

      void initBatchCheck(List<BatchCheckRequestOptions> batchCheckRequestOptions)

    • checkDocumentInBatch

      void checkDocumentInBatch(String documentIdentifier, String documentContent, CheckOptions checkOptions)