Class AcrolinxMultiViewSidebarSWT


  • public class AcrolinxMultiViewSidebarSWT
    extends java.lang.Object
    • Constructor Detail

      • 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 Detail

      • addSidebar

        public void addSidebar​(java.lang.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​(java.lang.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​(java.lang.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.