source: main/waeup.sirp/trunk/src/waeup/sirp/browser/resources.py @ 6011

##
## resources.py
## Login : <uli@pu.smp.net>
## Started on  Fri Mar 11 10:49:59 2011 Uli Fouquet
## $Id$
## 
## Copyright (C) 2011 Uli Fouquet
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
## 
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
## 
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##
"""Special JavaScript and CSS resources provided by waeup.sirp.
"""
from hurry import yui
from hurry.resource import Library, ResourceInclusion
from hurry.jqueryui import jqueryui, base, blitzer, ui_lightness, humanity
from hurry.jquery import jquery


#: All local resources are registered under the name ``waeup_sirp``.
waeup_sirp = Library('waeup_sirp', 'static')

#: A resource that binds a jQueryUI datepicker widget to each
#: <div> or <input> tag with class ``datepicker``.
#: If you want to let a JavaScript datepicker appear when
#: clicking into some input field, then you have to perform
#: two steps:
#:
#: * In the `update()` method of the responsible view/page/form
#:   require the JavaScript code to be rendered into the page:
#:
#:     from waeup.sirp.browser.resources import datepicker
#:     ...
#:     class MyPage(...):
#:       ...
#:       def update(self):
#:         datepicker.need()
#:
#:   This way all required JavaScripts will be rendered correctly
#:   into the HTML page generated.
#:
#: * In your HTML code add some ``<input>`` or ``<div>`` tag with
#:   ``class`` set to ``datepicker``, like this::
#:
#:     <input type="text" name="entrydate" class="datepicker" />
#:
#: When the HTML is rendered, clicking into the field will open
#: a datepicker widget. The datepicker functionality will be
#: delivered by jQueryUI for every ``<div>/<input>`` field with class
#: ``datepicker`` set.
#:
#: That means, you can also have several date input fields on a
#: single page as long as each one has class ``datepicker``.
datepicker = ResourceInclusion(waeup_sirp, 'datepicker.js',
                               depends=[jqueryui])
                               

#: If you want generate alert or confirm messages then you have to perform
#: two steps:
#: * In the `update()` method of the responsible view/page/form
#:   require the JavaScript code to be rendered into the page:
#:
#:     from waeup.sirp.browser.resources import datepicker
#:     ...
#:     class MyPage(...):
#:       ...
#:       def update(self):
#:         warning.need()
#:
#:   This way all required JavaScripts will be rendered correctly
#:   into the HTML page generated.
#: 
#:   In your HTML code add some <input> or <a> tag with onClick event:
#:
#:   <input type="submit" name="xyz" value="abc"/>
#:          onclick="return confirmPost('Are you sure?')">
warning = ResourceInclusion(waeup_sirp, 'warning.js')        

#: A resource that binds jQueryUI tabs to <div> tags with class
#: ``tabs``.
#:
#:
#: If you want jQuery tabs for some <div>s in your page then you
#: have to perform two steps:
#:
#: * In the `update()` method of the responsible view/page/form
#:   require the JavaScript code to be rendered into the page:
#:
#:     from waeup.sirp.browser.resources import tabs
#:     ...
#:     class MyPage(...):
#:       ...
#:       def update(self):
#:         tabs.need()
#:
#:   This way all required JavaScripts will be rendered correctly
#:   into the HTML page generated.
#:
#: * In your HTML code add some ``<div>`` tag with ``class`` set to
#    ``tabs``, like this::
#:    
#:      <div id="tabs">
#:        <ul>
#:          <li><a href="#tab-1"><span>Tab 1 Heading</span></a></li>
#:          <li><a href="#tab-2"><span>Tab 2 Heading</span></a></li>
#:        </ul>
#:        <div id="tab-1">
#:          Content of tab 1
#:        </div>
#:        <div id="tab-2">
#:          Content of tab 2
#:        </div>
#:      </div>
#:
#: When the HTML is rendered, clicking into one of the tabs will make
#: other <div>s disappear. See
#:
#:   http://jqueryui.com/demos/tabs/
#:
#: for details.
#:
tabs = ResourceInclusion(waeup_sirp, 'tabs.js',
                         depends=[jquery, jqueryui])

#: Resource that makes datatables for jQuery UI available.
#:
#: We register a normal version and a minified version. To make real
#: use of datatables you might want to add some specialized CSS like
#: `datatable_css` below.
datatables = ResourceInclusion(waeup_sirp, 'jquery.dataTables.js',
                               minified='jquery.dataTables.min.js',
                               depends=[jquery])

#: A stylesheet for datatables
datatables_css = ResourceInclusion(waeup_sirp, 'datatables.css')
                                  
#: A resource that turns HTML tables into sortable, searchable and :
#: multi-page widgets using jQuery and the dataTables plugin available
#: from http://www.datatables.net.
#:
#: If you want jQuery datatables for some <table> in your page then you
#: have to perform two steps:
#:
#: * In the `update()` method of the responsible view/page/form
#:   require the JavaScript code to be rendered into the page:
#:
#:     from waeup.sirp.browser.resources import datatable
#:     ...
#:     class MyPage(...):
#:       ...
#:       def update(self):
#:         datatable.need()
#:
#:   This way all required JavaScripts will be rendered correctly
#:   into the HTML page generated.
#:
#: * Assign a ``datatable`` id to the HTML table you want to tune:
#:    
#:      <table id="datatable">
#:        <thead>
#:          <tr>
#:            <th>Name</th><th>Title</th>
#:          </tr>
#:        </thead>
#:        <tbody>
#:          <tr class="gradeA">
#:            <td>Manfred</td><td>Mammoth of the year</td>
#:          </tr>
#:          <tr class="gradeA">
#:            <td>Wolfgang</td><td>Junior</td>
#:          </tr>
#:        </tbody>
#:      </table>
#:
#: When the HTML is rendered, clicking into one of the tabs will make
#: other <div>s disappear. See
#:
#:   http://jqueryui.com/demos/tabs/
#:
#: for details.
#:
datatable = ResourceInclusion(waeup_sirp, 'datatable.js',
                              depends=[datatables, datatables_css])

#: Register basic YUI based CSS as a resource.
yuiapp_css = ResourceInclusion(
    waeup_sirp, 'yuiapp.css',
    depends=[yui.reset_fonts_grids, yui.sam])

#: Register basic WAeUP base CSS (which is based on ``yuiapp.css`` as a
#: resource.
waeup_base_css = ResourceInclusion(
    waeup_sirp, 'waeup-base.css',
    depends=[yuiapp_css])

#: The red WAeUP theme registered as a resource.
waeuptheme_red1 = ResourceInclusion(
    waeup_sirp, 'waeuptheme-red1.css',
    depends=[waeup_base_css, base])

#: The gray WAeUP theme registered as a resource.
waeuptheme_gray1 = ResourceInclusion(
    waeup_sirp, 'waeuptheme-gray1.css',
    depends=[waeup_base_css])

#: A basic theme based on jQuery only (crappy yet).
waeuptheme_base = ResourceInclusion(
    waeup_sirp, 'empty.css',
    depends=[humanity])