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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<BatchCheckRequestOptions>
extractReferences()
Extracts all the references that should be listed for background checkCheckOptions
getCheckOptionsForDocument(java.lang.String documentIdentifier)
Called together with getContentForDocument before running the background check on the given document.java.lang.String
getContentForDocument(java.lang.String documentIdentifier)
Gets the content for a requested background checkInputAdapterInterface
getEditorAdapter()
Adapter to extract the text to be checked.AcrolinxSidebarInitParameter
getInitParameters()
Gets the parameters used to initialize the Acrolinx Sidebar.void
onCheckResult(CheckResult checkResult)
Notifies the Acrolinx Integration about the checks result.void
onInitFinished(java.util.Optional<SidebarError> initResult)
Notifies the Acrolinx Integration about the result of the initializing process.boolean
openDocumentInEditor(java.lang.String documentIdentifier)
Opens the given document in editor and notifies the sidebar that the document has been opened.
-
-
-
Method Detail
-
getEditorAdapter
InputAdapterInterface getEditorAdapter()
Adapter to extract the text to be checked. It needs to be an implementation of InputAdapterInterface.- See Also:
InputAdapterInterface
-
getInitParameters
AcrolinxSidebarInitParameter getInitParameters()
Gets the parameters used to initialize the Acrolinx Sidebar.- See Also:
AcrolinxSidebarInitParameter
-
onCheckResult
void onCheckResult(CheckResult checkResult)
Notifies the Acrolinx Integration about the checks result.
-
onInitFinished
void onInitFinished(java.util.Optional<SidebarError> initResult)
Notifies the Acrolinx Integration about the result of the initializing process.
-
openDocumentInEditor
boolean openDocumentInEditor(java.lang.String documentIdentifier)
Opens the given document in editor and notifies the sidebar that the document has been opened.
-
extractReferences
java.util.List<BatchCheckRequestOptions> extractReferences()
Extracts all the references that should be listed for background check
-
getCheckOptionsForDocument
CheckOptions getCheckOptionsForDocument(java.lang.String documentIdentifier)
Called together with getContentForDocument before running the background check on the given document.
-
getContentForDocument
java.lang.String getContentForDocument(java.lang.String documentIdentifier)
Gets the content for a requested background check
-
-