root/trunk/RBSkinning/RBSkinning/skin/CompoundSkinObject.py

#!/usr/bin/env python
##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
##~ License 
##~ 
##- The RuneBlade Foundation library is intended to ease some 
##- aspects of writing intricate Jabber, XML, and User Interface (wxPython, etc.) 
##- applications, while providing the flexibility to modularly change the 
##- architecture. Enjoy.
##~ 
##~ Copyright (C) 2002  TechGame Networks, LLC.
##~ 
##~ This library is free software; you can redistribute it and/or
##~ modify it under the terms of the BSD style License as found in the 
##~ LICENSE file included with this distribution.
##~ 
##~ TechGame Networks, LLC can be reached at:
##~ 3578 E. Hartsel Drive #211
##~ Colorado Springs, Colorado, USA, 80920
##~
##~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#~ Imports 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

import weakref
from RBSkinning.SkinObject import SkinObject
from RBSkinning.UtilitySkinElements import StoreXML, RestoreStoredXMLMixin
from RBFoundation.XMLClassBuilder import ElementFactory, ElementFactorySet
from template import TemplateElementFactorySet

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#~ Definitions 
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

class CompoundSkinModel(object):
    def OnSkinInitialize(self, Obj):
        """Called before CompoundSkinObject has been initialized.
        Obj is the owning CompoundSkinObject element"""
        pass
    
    def OnSkinFinalize(self, Obj):
        """Called after CompoundSkinObject has been finalized.
        Obj is the owning CompoundSkinObject element"""
        pass

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    
class CompoundSkinObject(SkinObject, RestoreStoredXMLMixin):
    """This object is meant to be derived from in order to generate compound skin elements.
    
    In the derived class, place the compound object's xml skin description in
    xmlskin, then instantiate as usual."""

    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Constants / Variables / Etc. 
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    default_settings = SkinObject.default_settings.copy()
    default_settings[SkinObject.BaseSettingsSave] = "::settings"
    modelctxvar = "compoundmodel"
    invokename = "::contents"
    xmlskin = """<template xmlns='http://namespaces.runeblade.com/skin' expand='::contents'/>"""

    ElementFactories = TemplateElementFactorySet

    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    #~ Public Methods 
    #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    def __init__(self, owner, parent, node, attributes, namespacemap): 
        SkinObject.__init__(self, owner, parent, node, attributes, namespacemap)
        self.owner = owner

    def _InitContext(self, *args, **kw):
        result = SkinObject._InitContext(self, *args, **kw)
        self.PushContext() # This needs to happen before self._InitSettings
        return result

    def GetCompoundModel(self):
        pass

    def SkinInitialize(self):
        self.object = self.GetCompoundModel()

        # Call the model's OnSkinInitialize, if it has one
        try: objOnSkinInitialize = self.object.OnSkinInitialize
        except AttributeError: pass
        else: objOnSkinInitialize(self)
        
        setattr(self.context, self.modelctxvar, self.object)
        self.owner.PushElementFactorySet(self.ElementFactories)

    def SkinFinalize(self):
        self.owner.PopElementFactorySet()

        setattr(self.context, '::invoke:' + self.invokename, weakref.proxy(self))
        self.ReferenceSkin(self.settings)
        delattr(self.context, '::invoke:' + self.invokename)
        
        # Call the model's OnSkinFinalize, if it has one
        try: objOnSkinFinalize = self.object.OnSkinFinalize
        except AttributeError: pass
        else: objOnSkinFinalize(self)

        del self.owner
        
    def ReferenceSkin(self, kwAddedContext={}):
        if self.xmlskin:
            self.context.__skinner__()._SkinXMLFromTopElement(self.xmlskin, kwAddedContext)