Package com.acrolinx.sidebar.swt

Class AcrolinxMultiViewSidebarSWT

java.lang.Object

com.acrolinx.sidebar.swt.AcrolinxMultiViewSidebarSWT

public class AcrolinxMultiViewSidebarSWT
extends Object

Constructor Summary

Constructors

Constructor	Description
AcrolinxMultiViewSidebarSWT(org.eclipse.swt.widgets.Composite parent, AcrolinxStorage acrolinxStorage)
AcrolinxMultiViewSidebarSWT(org.eclipse.swt.widgets.Shell parent, AcrolinxStorage acrolinxStorage)

Method Summary

Modifier and Type	Method	Description
void	addSidebar(String documentId, AcrolinxIntegration acrolinxIntegration)
AcrolinxSidebarSWT	getActiveSidebar()
void	removeSidebar(String documentId)
void	switchSidebar(String documentId)

Methods inherited from class java.lang.Object

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

Constructor Details

AcrolinxMultiViewSidebarSWT

public AcrolinxMultiViewSidebarSWT(org.eclipse.swt.widgets.Composite parent,
 AcrolinxStorage acrolinxStorage)

Parameters:

parent - SWT Composite to which sidebar would be child of.

acrolinxStorage - Acrolinx storage to act as external storage to sidebar local storage

AcrolinxMultiViewSidebarSWT

public AcrolinxMultiViewSidebarSWT(org.eclipse.swt.widgets.Shell parent,
 AcrolinxStorage acrolinxStorage)

Parameters:

parent - SWT Shell to which sidebar would be child of.

acrolinxStorage - Acrolinx storage to act as external storage to sidebar local storage

Method Details

addSidebar

public void addSidebar(String documentId,
 AcrolinxIntegration acrolinxIntegration)
                throws AcrolinxException

Parameters:

acrolinxIntegration - New integration dedicated per sidebar instance

documentId - Unique document Id for the sidebar instance eg: file path

Throws:

AcrolinxException - Throws exception is sidebar already exists for the document

switchSidebar

public void switchSidebar(String documentId)
                   throws AcrolinxException

Parameters:

documentId - Document Id of the sidebar instance to switch active sidebar to.

Throws:

AcrolinxException - Throws if sidebar not found for provided document id.

removeSidebar

public void removeSidebar(String documentId)
                   throws AcrolinxException

Parameters:

documentId - Document Id for the sidebar instance to be removed

Throws:

AcrolinxException - Throws if sidebar not found for the provided document id.

getActiveSidebar

public AcrolinxSidebarSWT getActiveSidebar()

Returns:

Get Active sidebar from the list. Returns sidebar with visiblity set to true. Null if not found.