remove dbg statement

[myslice.git] / unfold / plugin.py

diff --git a/unfold/plugin.py b/unfold/plugin.py
index 7ae4745..cc2eaeb 100644 (file)
--- a/unfold/plugin.py
+++ b/unfold/plugin.py
@@ -16,8 +16,8 @@ from unfold.prelude import Prelude
 # . True : to debug all plugin
 
 DEBUG= False
-DEBUG= [ 'SimpleList' ]
-DEBUG=True
+#DEBUG= [ 'SimpleList' ]
+#DEBUG=True
 
 # decorator to deflect calls on Plugin to its Prelude through self.page.prelude
 def to_prelude (method):
@@ -43,10 +43,19 @@ class Plugin:
     # . page: the context of the request being served
     # . title: is used visually for displaying the widget
     #### optional
-    # . togglable: whether it can be turned on and off (like PleKitToggle)
-    # . toggled: if togglable, what's the initial status
     # . visible: if not set the plugin does not show up at all
     #            (not quite sure what this was for)
+    # . togglable: whether it can be turned on and off by clicking on the title (like PleKitToggle)
+    # . toggled:   whether the plugin should startup open/shown or closed/hidden
+    #              possible values are
+    #   .. True         : start up open/hidden
+    #   .. False        : start up closed/shown
+    #   .. 'persistent' : start up as it was the last time that browser showed it (based on 'domid')
+    #                NOTE that it is required for you to set a domid if you want to use persistent mode
+    #                     since domid is the key for storing that data in the browser storage space
+    #   .. None         : if not passed to __init__ at all, then the default_toggled() method is called
+    #   ..              : anything else, defaults to True
+    #
     #### internal data
     # . domid: created internally, but can be set at creation time if needed
     #          useful for hand-made css, or for selecting an active plugin in a composite
@@ -57,7 +66,7 @@ class Plugin:
     # which will result in 'foo' being accessible to the template engine
     # 
     def __init__ (self, page, title, domid=None,
-                  visible=True, togglable=True, toggled=True, **settings):
+                  visible=True, togglable=True, toggled=None, **settings):
         self.page = page
         self.title=title
         # callers can provide their domid for css'ing 
@@ -67,7 +76,8 @@ class Plugin:
         self.plugin_classname=self._js_classname()
         self.visible=visible
         self.togglable=togglable
-        self.toggled=toggled
+        if toggled is not None: self.toggled=toggled
+        else:                   self.toggled=self.default_toggled()
         # what comes from subclasses
         for (k,v) in settings.iteritems():
             setattr(self,k,v)
@@ -80,6 +90,9 @@ class Plugin:
         # do this only once the structure is fine
         self.page.record_plugin(self)
 
+    def __repr__ (self):
+        return "[%s]:%s"%(self.classname,self.domid)
+
     def _py_classname (self): 
         try:    return self.__class__.__name__
         except: return 'Plugin'
@@ -103,7 +116,7 @@ class Plugin:
             except: return '%s:"undefined"'%setting
         else:
             value=getattr(self,setting,None)
-            if not value: value = "unknown-setting-%s"%setting
+            if value is None: value = "unknown-setting-%s"%setting
         # first try to use to_json method (json.dumps not working on class instances)
         try:    value_json=value.to_json()
         except: value_json=json.dumps(value,separators=(',',':'))
@@ -142,8 +155,19 @@ class Plugin:
         # need_spin is used in plugin.html
         self.need_spin=self.start_with_spin()
         env.update(self.__dict__)
+        # translate high-level 'toggled' into 4 different booleans
+        if self.toggled=='persistent':
+            # start with everything turned off and let the js callback do its job
+            env.update({'persistent_toggle':True,'display_hide_button':False,'display_show_button':False,'display_body':False})
+        elif self.toggled==False:
+            env.update({'persistent_toggle':False,'display_hide_button':False,'display_show_button':True,'display_body':False})
+        else:
+            env.update({'persistent_toggle':False,'display_hide_button':True,'display_show_button':False,'display_body':True})
         if self.need_debug(): 
             print "rendering plugin.html with env keys %s"%env.keys()
+            print "rendering plugin.html with env"
+            for (k,v) in env.items(): 
+                if "display" in k or "persistent" in k: print k,'->',v
         result = render_to_string ('plugin.html',env)
 
         # export this only for relevant plugins
@@ -164,7 +188,12 @@ class Plugin:
     def render_content (self, request):
         """Should return an HTML fragment"""
         template = self.template_file()
-        env=self.template_env(request)
+        # start with a fresh one
+        env={}
+        # add our own settings as defaults
+        env.update(self.__dict__)
+        # then the things explicitly defined in template_env()
+        env.update(self.template_env(request))
         if not isinstance (env,dict):
             raise Exception, "%s.template_env returns wrong type"%self.classname
         result=render_to_string (template, env)
@@ -221,6 +250,8 @@ class Plugin:
     def template_file (self):           return "undefined_template"
     def template_env (self, request):   return {}
 
+    def default_toggled (self):         return 'persistent'
+
 #    # tell the framework about requirements (for the document <header>)
 #    # the notion of 'Media' in django provides for medium-dependant
 #    # selection of css files