Source code for ccpn.ui.gui.popups.IntegralListPropertiesPopup

"""
Module Documentation here
"""
#=========================================================================================
# Licence, Reference and Credits
#=========================================================================================
__copyright__ = "Copyright (C) CCPN project (http://www.ccpn.ac.uk) 2014 - 2020"
__credits__ = ("Ed Brooksbank, Luca Mureddu, Timothy J Ragan & Geerten W Vuister")
__licence__ = ("CCPN licence. See http://www.ccpn.ac.uk/v3-software/downloads/license")
__reference__ = ("Skinner, S.P., Fogh, R.H., Boucher, W., Ragan, T.J., Mureddu, L.G., & Vuister, G.W.",
                 "CcpNmr AnalysisAssign: a flexible platform for integrated NMR analysis",
                 "J.Biomol.Nmr (2016), 66, 111-124, http://doi.org/10.1007/s10858-016-0060-y")
#=========================================================================================
# Last code modification
#=========================================================================================
__modifiedBy__ = "$modifiedBy: Ed Brooksbank $"
__dateModified__ = "$dateModified: 2020-11-02 17:47:53 +0000 (Mon, November 02, 2020) $"
__version__ = "$Revision: 3.0.1 $"
#=========================================================================================
# Created
#=========================================================================================
__author__ = "$Author: CCPN $"
__date__ = "$Date: 2017-03-30 11:28:58 +0100 (Thu, March 30, 2017) $"
#=========================================================================================
# Start of code
#=========================================================================================

from ccpn.ui.gui.lib.OpenGL.CcpnOpenGL import GLNotifier
from ccpn.ui.gui.popups.PMIListPropertiesPopupABC import PMIListPropertiesPopupABC
from ccpn.core.IntegralList import IntegralList


class IntegralListPropertiesPopup(PMIListPropertiesPopupABC):
    """
    Popup to handle changing parameters in multipletLists
    """

    # class of lists handled by popup
    klass = IntegralList
    attributes = [('Id', getattr, None, {'backgroundText': '> Not defined <'}),
                  ('Comment', getattr, setattr, {'backgroundText': '> Optional <'}),
                  ]
    _symbolColourOption = True
    _textColourOption = True
    _lineColourOption = False
    _meritColourOption = True
    _meritOptions = True

    def __init__(self, parent=None, mainWindow=None, integralList=None, title=None, **kwds):
        super().__init__(parent=parent, mainWindow=mainWindow, ccpnList=integralList,
                         title='%s Properties' % self.klass.className, **kwds)

        self.__postInit__()

    def _refreshGLItems(self):
        # emit a signal to rebuild all peaks and multiplets
        self.GLSignals.emitEvent(targets=[self.ccpnList], triggers=[GLNotifier.GLINTEGRALLISTS,
                                                                    GLNotifier.GLINTEGRALLISTLABELS])

    def _getListViews(self, ccpnList):
        """Return the listViews containing this list
        """
        return [integralListView for integralListView in self.project.integralListViews
                if integralListView.integralList == ccpnList]

    def _applyAllChanges(self, changes):
        """Apply all changes - add new integralList to the spectrum
        """
        super()._applyAllChanges(changes)
        if not self.EDITMODE:

            if 'id' in self.ccpnList:
                del self.ccpnList['id']

            # create the new integralList
            self.spectrum.newIntegralList(**self.ccpnList)

    def _populateInitialValues(self):
        """Populate the initial values for an empty object
        """
        super()._populateInitialValues()

        # need to get the next available integralList name
        _num = len(self.spectrum.integralLists) + 1
        self.ccpnList.id = '{}.{}'.format(self.spectrum.name, _num)