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 Summary

Modifier and Type	Method	Description
void	checkDocumentInBatch(java.lang.String documentIdentifier, java.lang.String documentContent, CheckOptions checkOptions)
void	checkGlobal()	Triggers a check action in the Acrolinx Sidebar, same as pushing the checkButton.
void	configure(SidebarConfiguration sidebarConfiguration)	Pushed the configuration to the Acrolinx Sidebar.
java.lang.String	getLastCheckedDocument()	Gets the content of the lasted successfully checked document.
java.lang.String	getLastCheckedDocumentReference()	Gets the document reference of the lasted successfully checked document.
void	initBatchCheck(java.util.List<BatchCheckRequestOptions> batchCheckRequestOptions)
void	invalidateRanges(java.util.List<CheckedDocumentPart> invalidCheckedDocumentRanges)	Notifies the sidebar about invalid ranges of the current document.
void	invalidateRangesForMatches(java.util.List<? extends AbstractMatch> matches)	Notifies the sidebar about invalid ranges of the current document.
void	loadSidebarFromServerLocation(java.lang.String serverAddress)	Load the sidebar from a different server address.
void	onGlobalCheckRejected()	Notifies the sidebar that the check was canceled.
void	reload()	Reload the current sidebar.
void	showMessage(SidebarMessage sidebarMessage)	Shows a message in the sidebar.

Method Detail

configure

void configure(SidebarConfiguration sidebarConfiguration)

Pushed the configuration to the Acrolinx Sidebar.

See Also:

SidebarConfiguration

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(java.util.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(java.util.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(java.lang.String serverAddress)

Load the sidebar from a different server address.

reload

void reload()

Reload the current sidebar.

getLastCheckedDocumentReference

java.lang.String getLastCheckedDocumentReference()

Gets the document reference of the lasted successfully checked document.

Returns:

documentReference

getLastCheckedDocument

java.lang.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(java.util.List<BatchCheckRequestOptions> batchCheckRequestOptions)

checkDocumentInBatch

void checkDocumentInBatch(java.lang.String documentIdentifier,
                          java.lang.String documentContent,
                          CheckOptions checkOptions)