Package com.acrolinx.sidebar.swt

Class AcrolinxSidebarSWT

java.lang.Object

com.acrolinx.sidebar.swt.AcrolinxSidebarSWT

All Implemented Interfaces:

AcrolinxSidebar

public class AcrolinxSidebarSWT
extends java.lang.Object
implements AcrolinxSidebar

SWT implementation of Acrolinx Sidebar.

See Also:

AcrolinxSidebar

Constructor Summary

Constructors

Constructor	Description
AcrolinxSidebarSWT(org.eclipse.swt.widgets.Composite parent, AcrolinxIntegration acrolinxIntegration)
AcrolinxSidebarSWT(org.eclipse.swt.widgets.Composite parent, AcrolinxIntegration acrolinxIntegration, AcrolinxStorage acrolinxStorage)
AcrolinxSidebarSWT(org.eclipse.swt.widgets.Shell parent, AcrolinxIntegration acrolinxIntegration)
AcrolinxSidebarSWT(org.eclipse.swt.widgets.Shell parent, AcrolinxIntegration acrolinxIntegration, AcrolinxStorage acrolinxStorage)

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.
ExternalContent	getLastCheckedExternalContent()
org.eclipse.swt.browser.Browser	getSidebarBrowser()
void	initBatchCheck(java.util.List<BatchCheckRequestOptions> batchCheckRequestOptions)
void	invalidateRanges(java.util.List<CheckedDocumentPart> invalidDocumentParts)	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.
java.lang.Boolean	isVisible()
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	setVisible(java.lang.Boolean visibility)
void	showMessage(SidebarMessage sidebarMessage)	Shows a message in the sidebar.
void	toggleVisibility()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AcrolinxSidebarSWT

public AcrolinxSidebarSWT(org.eclipse.swt.widgets.Composite parent,
                          AcrolinxIntegration acrolinxIntegration)

AcrolinxSidebarSWT

public AcrolinxSidebarSWT(org.eclipse.swt.widgets.Shell parent,
                          AcrolinxIntegration acrolinxIntegration)

AcrolinxSidebarSWT

public AcrolinxSidebarSWT(org.eclipse.swt.widgets.Composite parent,
                          AcrolinxIntegration acrolinxIntegration,
                          AcrolinxStorage acrolinxStorage)

AcrolinxSidebarSWT

public AcrolinxSidebarSWT(org.eclipse.swt.widgets.Shell parent,
                          AcrolinxIntegration acrolinxIntegration,
                          AcrolinxStorage acrolinxStorage)

Method Detail

initBatchCheck

public void initBatchCheck(java.util.List<BatchCheckRequestOptions> batchCheckRequestOptions)

Specified by:

initBatchCheck in interface AcrolinxSidebar

getSidebarBrowser

public org.eclipse.swt.browser.Browser getSidebarBrowser()

configure

public void configure(SidebarConfiguration sidebarConfiguration)

Description copied from interface: AcrolinxSidebar

Pushed the configuration to the Acrolinx Sidebar.

Specified by:

configure in interface AcrolinxSidebar

See Also:

SidebarConfiguration

checkGlobal

public void checkGlobal()

Description copied from interface: AcrolinxSidebar

Triggers a check action in the Acrolinx Sidebar, same as pushing the checkButton.

Specified by:

checkGlobal in interface AcrolinxSidebar

onGlobalCheckRejected

public void onGlobalCheckRejected()

Description copied from interface: AcrolinxSidebar

Notifies the sidebar that the check was canceled.

Specified by:

onGlobalCheckRejected in interface AcrolinxSidebar

invalidateRanges

public void invalidateRanges(java.util.List<CheckedDocumentPart> invalidDocumentParts)

Description copied from interface: AcrolinxSidebar

Notifies the sidebar about invalid ranges of the current document. The sidebar will then invalidate all cards containing issues within this text range.

Specified by:

invalidateRanges in interface AcrolinxSidebar

invalidateRangesForMatches

public void invalidateRangesForMatches(java.util.List<? extends AbstractMatch> matches)

Description copied from interface: AcrolinxSidebar

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.

Specified by:

invalidateRangesForMatches in interface AcrolinxSidebar

loadSidebarFromServerLocation

public void loadSidebarFromServerLocation(java.lang.String serverAddress)

Description copied from interface: AcrolinxSidebar

Load the sidebar from a different server address.

Specified by:

loadSidebarFromServerLocation in interface AcrolinxSidebar

reload

public void reload()

Description copied from interface: AcrolinxSidebar

Reload the current sidebar.

Specified by:

reload in interface AcrolinxSidebar

getLastCheckedDocumentReference

public java.lang.String getLastCheckedDocumentReference()

Description copied from interface: AcrolinxSidebar

Gets the document reference of the lasted successfully checked document.

Specified by:

getLastCheckedDocumentReference in interface AcrolinxSidebar

Returns:

documentReference

getLastCheckedExternalContent

public ExternalContent getLastCheckedExternalContent()

getLastCheckedDocument

public java.lang.String getLastCheckedDocument()

Description copied from interface: AcrolinxSidebar

Gets the content of the lasted successfully checked document.

Specified by:

getLastCheckedDocument in interface AcrolinxSidebar

Returns:

documentContent

showMessage

public void showMessage(SidebarMessage sidebarMessage)

Description copied from interface: AcrolinxSidebar

Shows a message in the sidebar.

Specified by:

showMessage in interface AcrolinxSidebar

checkDocumentInBatch

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

Specified by:

checkDocumentInBatch in interface AcrolinxSidebar

toggleVisibility

public void toggleVisibility()

setVisible

public void setVisible(java.lang.Boolean visibility)

isVisible

public java.lang.Boolean isVisible()