# Copyright 2008 Nanorex, Inc.  See LICENSE file for details. 
"""
@author:    Piotr
@version:   $Id$
@copyright: 2008 Nanorex, Inc.  See LICENSE file for details.
"""

import foundation.changes as changes
from commands.SelectChunks.SelectChunks_GraphicsMode import SelectChunks_GraphicsMode
from command_support.EditCommand import EditCommand
from utilities.constants import red
from protein.commands.CompareProteins.CompareProteins_PropertyManager import CompareProteins_PropertyManager
from utilities.GlobalPreferences import USE_COMMAND_STACK
from utilities.GlobalPreferences import MODEL_AND_SIMULATE_PROTEINS
# == GraphicsMode part

_superclass_for_GM = SelectChunks_GraphicsMode

class CompareProteins_GraphicsMode(SelectChunks_GraphicsMode ):
    """
    Graphics mode for Compare Proteins command. 
    """
    pass
    
# == Command part


class CompareProteins_Command(EditCommand): 
    """
    
    """
    #Temporary attr 'command_porting_status. See baseCommand for details.
    command_porting_status = None #fully ported
    
    # class constants
    GraphicsMode_class = CompareProteins_GraphicsMode
    
    PM_class = CompareProteins_PropertyManager

    commandName = 'COMPARE_PROTEINS'
    featurename = "Compare Proteins"
    from utilities.constants import CL_SUBCOMMAND
    command_level = CL_SUBCOMMAND
    command_parent = 'BUILD_PROTEIN'
    
    if MODEL_AND_SIMULATE_PROTEINS:
        command_parent = 'MODEL_AND_SIMULATE_PROTEIN'
           
    command_can_be_suspended = False
    command_should_resume_prevMode = True 
    command_has_its_own_PM = True
    
    flyoutToolbar = None
    
    def _getFlyoutToolBarActionAndParentCommand(self):
        """
        See superclass for documentation.
        @see: self.command_update_flyout()
        """
        flyoutActionToCheck = 'compareProteinsAction'
        if MODEL_AND_SIMULATE_PROTEINS:
            parentCommandName = 'MODEL_AND_SIMULATE_PROTEIN'    
        else:
            parentCommandName = None
            
        return flyoutActionToCheck, parentCommandName
    
    if not USE_COMMAND_STACK:
        def init_gui(self):
            """
            Initialize GUI for this mode 
            """
            from utilities.GlobalPreferences import MODEL_AND_SIMULATE_PROTEINS
            if MODEL_AND_SIMULATE_PROTEINS:
                self._init_gui_flyout_action( 'compareProteinsAction', 'MODEL_AND_SIMULATE_PROTEIN' )
            else:
                self._init_gui_flyout_action( 'compareProteinsAction')
                
            if self.propMgr is None:
                self.propMgr = CompareProteins_PropertyManager(self)
                #@bug BUG: following is a workaround for bug 2494.
                #This bug is mitigated as propMgr object no longer gets recreated
                #for modes -- niand 2007-08-29
                changes.keep_forever(self.propMgr)  
                
            self.propMgr.show()
            
        def restore_gui(self):
            """
            Restore the GUI 
            """
            EditCommand.restore_gui(self)
            if self.flyoutToolbar:
                self.flyoutToolbar.compareProteinsAction.setChecked(False)    
        
    def keep_empty_group(self, group):
        """
        Returns True if the empty group should not be automatically deleted. 
        otherwise returns False. The default implementation always returns 
        False. Subclasses should override this method if it needs to keep the
        empty group for some reasons. Note that this method will only get called
        when a group has a class constant autdelete_when_empty set to True. 
        (and as of 2008-03-06, it is proposed that dna_updater calls this method
        when needed. 
        @see: Command.keep_empty_group() which is overridden here. 
        """
        
        bool_keep = EditCommand.keep_empty_group(self, group)
        
        return bool_keep