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

"""
Module Documentation here
"""
#=========================================================================================
# Licence, Reference and Credits
#=========================================================================================
__copyright__ = "Copyright (C) CCPN project (https://www.ccpn.ac.uk) 2014 - 2022"
__credits__ = ("Ed Brooksbank, Joanna Fox, Victoria A Higman, Luca Mureddu, Eliza Płoskoń",
               "Timothy J Ragan, Brian O Smith, Gary S Thompson & Geerten W Vuister")
__licence__ = ("CCPN licence. See https://ccpn.ac.uk/software/licensing/")
__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: Luca Mureddu $"
__dateModified__ = "$dateModified: 2022-02-28 11:43:53 +0000 (Mon, February 28, 2022) $"
__version__ = "$Revision: 3.1.0 $"
#=========================================================================================
# Created
#=========================================================================================
__author__ = "$Author: CCPN $"
__date__ = "$Date: 2017-03-30 11:28:58 +0100 (Thu, March 30, 2017) $"
#=========================================================================================
# Start of code
#=========================================================================================

from ccpn.ui.gui.popups.AttributeEditorPopupABC import AttributeEditorPopupABC
from ccpn.core.RestraintTable import RestraintTable
from ccpn.ui.gui.widgets.CompoundWidgets import EntryCompoundWidget, PulldownListCompoundWidget


class RestraintTablePopupABC(AttributeEditorPopupABC):
    """Base class for RestraintTable attributes editor popups
    """

    def _getRestraintTypes(self, obj=None):
        self.restraintType.modifyTexts(RestraintTable.restraintTypes)
        self.restraintType.setIndex(0)

    klass = RestraintTable  # The class whose properties are edited/displayed
    attributes = []  # A list of (attributeName, getFunction, setFunction, kwds) tuples;

    def __init__(self, parent=None, mainWindow=None, obj=None,
                 restraintTable=None, structureData=None, **kwds):
        self._structureData = structureData

        super().__init__(parent=parent, mainWindow=mainWindow, obj=obj, **kwds)

    def _applyAllChanges(self, changes):
        """Apply all changes - add new restraintTable
        """
        super()._applyAllChanges(changes)
        if not self.EDITMODE:
            # restraintTable constraint, restraintType MUST be set
            if not self.obj.restraintType:
                self.obj.restraintType = self.restraintType.getText()

            # use the blank container as a dict for creating the new restraintTable
            self._structureData.newRestraintTable(**self.obj)

    # def _populateInitialValues(self):
    #     """Populate the initial values for an empty object
    #     """
    #     self.obj.name = self.klass._nextAvailableName(self.klass, self.project)


class RestraintTableEditPopup(RestraintTablePopupABC):
    """RestraintTable attributes editor popup
    """

    attributes = [('Name', EntryCompoundWidget, getattr, setattr, None, None, {'backgroundText': '> Enter name <'}),
                  ('Comment', EntryCompoundWidget, getattr, setattr, None, None, {'backgroundText': '> Optional <'}),
                  ('Restraint Type', EntryCompoundWidget, getattr, None, None, None, {}),
                  ]


class RestraintTableNewPopup(RestraintTablePopupABC):
    """RestraintTable attributes editor popup
    """

    # new requires a pulldown list for restraintType - in edit it is fixed
    attributes = [('Name', EntryCompoundWidget, getattr, setattr, None, None, {'backgroundText': '> Enter name <'}),
                  ('Comment', EntryCompoundWidget, getattr, setattr, None, None, {'backgroundText': '> Optional <'}),
                  ('Restraint Type', PulldownListCompoundWidget, getattr, setattr, RestraintTablePopupABC._getRestraintTypes, None, {}),
                  ]