app/soc/views/helpers/custom_widgets.py
author Pawel Solyga <Pawel.Solyga@gmail.com>
Tue, 23 Sep 2008 19:20:57 +0000
changeset 188 27ed1a09c98d
parent 141 e120c24b89e2
child 194 8bdb1d2d0c36
permissions -rw-r--r--
Changes in TinyMCE widget in custom_widgets.py based on review comments. Patch by: Pawel Solyga Review url: http://code.google.com/p/soc/source/detail?r=550

#!/usr/bin/python2.5
#
# Copyright 2008 the Melange authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Custom widgets used for form fields.
"""

__authors__ = [
  '"Pawel Solyga" <pawel.solyga@gmail.com>',
  ]

from django import newforms as forms
from django.newforms.widgets import flatatt
from django.newforms.util import smart_unicode
from django.utils.html import escape
from django.utils import simplejson
from django.utils.safestring import mark_safe

class TinyMCE(forms.widgets.Textarea):
    """TinyMCE widget. 
    
    Requires to include tiny_mce_src.js in your template. Widget can be
    customized by overwriting or adding extra options to mce_settings
    dictionary

    You can set TinyMCE widget for particular form field using code below:
      class ExampleForm(forms_helpers.DbModelForm):
        content = forms.fields.CharField(widget=custom_widgets.TinyMCE())
    
    You can include tiny_mce_src.js in your template using:
      {% block scripts %}
    	  <script type="text/javascript" src="/tiny_mce/tiny_mce_src.js"></script>
      {% endblock %}
    """ 
    MCE_DEF_SETTINGS = { 'mode': "exact",
                         'theme': "simple",
                         'theme_advanced_toolbar_location': "top",
                         'theme_advanced_toolbar_align': "center"}

    mce_settings = MCE_DEF_SETTINGS

    TINY_MCE_HTML_FMT = u'''<textarea %(attrs)s>%(value)s</textarea>
                <script type="text/javascript">
                tinyMCE.init(%(settings_json)s)</script>'''
    
    def render(self, name, value, attrs=None):
        """Render TinyMCE widget as HTML.
        """
        if value is None:
          value = ''
        value = smart_unicode(value)
        final_attrs = self.build_attrs(attrs, name=name)

        self.mce_settings['elements'] = "id_%s" % name
        
        # convert mce_settings from dict to JSON
        mce_json = simplejson.JSONEncoder().encode(self.mce_settings)

        return mark_safe( self.TINY_MCE_HTML_FMT % 
            { 'attrs': flatatt(final_attrs),
              'value': escape(value), 
              'settings_json':  mce_json})