WebPage Namespace Reference

Classes
class	GlobalConfiguration
class	HelloWorld
class	htmlTable
class	WebPage
class	WebPageConfigurationError

Functions
def	sep (s)
def	htmlDiv (id, contents='', attr='', keepEmptyDiv=True)
def	htmlText (text, attr='', escapeText=False)
def	htmlPre (text, attr='', escapeText=False)
def	htmlPara (text='', attr='', escapeText=False)
def	htmlLink (text, link, attr='', escapeText=False)
def	htmlList (contents, attr='', listType='ul')
def	htmlLI (text, attr='', escapeText=False)
def	htmlFoldingSection (header, content, isClosed=True, headerClass='section-header', contentClass='section-content')
def	htmlForm (contents, action='', method='post', attr='')
def	htmlLabel (labelText, parName, attr='')
def	htmlSelect (labelText, parName, args, choiceList, hint=None, descriptionSeparator='::', labelAttr='', attr='')
def	htmlCheckbox (labelText, parName, args, labelAttr='', attr='')
def	htmlTextInput (labelText, parName, args, size=None, maxLength=None, labelAttr='', attr='')
def	htmlSubmit (text, parName, attr='', onlyOnce=False)

Variables
string	__author__ = 'Juerg Beringer'
string	__version__ = 'WebPage.py atlas/athena'
string	startPage
string	endPage

Function Documentation

htmlCheckbox()

def WebPage.htmlCheckbox	(		labelText,
			parName,
			args,
			labelAttr = '',
			attr = ''
	)

Make a checkbox (including label with text).

Definition at line 206 of file WebPage.py.

def htmlCheckbox(labelText, parName, args, labelAttr='', attr=''):
    """Make a checkbox (including label with text)."""
    snippet = htmlLabel(labelText,parName,labelAttr)
    checked = 'checked="checked"' if parName in args else ''
    snippet += '<input type="checkbox" name="%s"%s%s/>\n' % (parName,sep(checked),sep(attr))
    return snippet
 

htmlDiv()

def WebPage.htmlDiv	(		id,
			contents = '',
			attr = '',
			keepEmptyDiv = True
	)

Make a named div element containing contents. If
   contents is empty, an empty string is returned,
   unless keepEmtpyDiv is set True.

Definition at line 46 of file WebPage.py.

def htmlDiv(id, contents='', attr='', keepEmptyDiv=True):
    """Make a named div element containing contents. If
       contents is empty, an empty string is returned,
       unless keepEmtpyDiv is set True."""
    if contents or keepEmptyDiv:
        if id:
            return '<div id="%s"%s>\n%s</div>\n' % (id,sep(attr),contents)
        else:
            return '<div%s>\n%s</div>\n' % (sep(attr),contents)
    else:
        return ''
 

htmlFoldingSection()

def WebPage.htmlFoldingSection	(		header,
			content,
			isClosed = True,
			headerClass = 'section-header',
			contentClass = 'section-content'
	)

Generate the html for a folding section using the toggleSection JavaScript utility
   from WebPageUtils.js and CSS classes section-closed, section-open, and hidden.

Definition at line 154 of file WebPage.py.

def htmlFoldingSection(header, content, isClosed=True,
                       headerClass='section-header',
                       contentClass='section-content'):
    """Generate the html for a folding section using the toggleSection JavaScript utility
       from WebPageUtils.js and CSS classes section-closed, section-open, and hidden."""
    if isClosed:
        s = '<div class="section-closed" onclick="toggleSection(this);">'
    else:
        s = '<div class="section-open" onclick="toggleSection(this);">'
    s += '<span class="%s">%s</span></div>\n' % (headerClass,header)
    h = ' hidden' if isClosed else ''
    s += '<div class="%s%s">\n%s</div>\n' % (contentClass,h,content)
    return s
 

htmlForm()

def WebPage.htmlForm	(		contents,
			action = '',
			method = 'post',
			attr = ''
	)

Definition at line 168 of file WebPage.py.

def htmlForm(contents, action='', method='post', attr=''):
    snippet = '<form action="%s" method="%s"%s>\n' % (action,method,sep(attr))
    snippet += '<fieldset>\n'
    snippet += contents
    snippet += '</fieldset>\n</form>\n'
    return snippet
 

htmlLabel()

def WebPage.htmlLabel	(		labelText,
			parName,
			attr = ''
	)

Make a label for parName. If labelText is None,
   an empty string is returned.

Definition at line 175 of file WebPage.py.

def htmlLabel(labelText, parName, attr=''):
    """Make a label for parName. If labelText is None,
       an empty string is returned."""
    if labelText!=None:
        return '<label for="%s"%s>%s</label>' % (parName,sep(attr),labelText)
    else:
        return ''
 

htmlLI()

def WebPage.htmlLI	(		text,
			attr = '',
			escapeText = False
	)

Make a list item.  Special HTML characters
   in the text are properly replaced (using escape from cgi) if
   escapeText is set True.

Definition at line 85 of file WebPage.py.

def htmlLI(text, attr='', escapeText=False):
    """Make a list item.  Special HTML characters
       in the text are properly replaced (using escape from cgi) if
       escapeText is set True."""
    return '<li%s>%s</li>\n' % (sep(attr), escape(text) if escapeText else text)
 

htmlLink()

def WebPage.htmlLink	(		text,
			link,
			attr = '',
			escapeText = False
	)

Definition at line 77 of file WebPage.py.

def htmlLink(text, link, attr='', escapeText=False):
    return '<a href="%s"%s>%s</a>' % (link,sep(attr),escape(text) if escapeText else text)
 

htmlList()

def WebPage.htmlList	(		contents,
			attr = '',
			listType = 'ul'
	)

Enclose list contents (a string with one or more list items) with
   the proper list tag. The type of the list is given by listType.

Definition at line 80 of file WebPage.py.

def htmlList(contents, attr='', listType='ul'):
    """Enclose list contents (a string with one or more list items) with
       the proper list tag. The type of the list is given by listType."""
    return '<%s%s>\n%s</%s>\n' % (listType,sep(attr),contents,listType)
 

htmlPara()

def WebPage.htmlPara	(		text = '',
			attr = '',
			escapeText = False
	)

Make a paragraph.

Definition at line 70 of file WebPage.py.

def htmlPara(text='', attr='', escapeText=False):
    """Make a paragraph."""
    if text or attr:
        return '<p%s>%s</p>\n' % (sep(attr), escape(text) if escapeText else text)
    else:
        return '<p>\n'
 

htmlPre()

def WebPage.htmlPre	(		text,
			attr = '',
			escapeText = False
	)

Make a preformatted text section. Special HTML characters
   in the text are properly replaced (using escape from cgi) if
   escapeText is set True.

Definition at line 64 of file WebPage.py.

def htmlPre(text, attr='', escapeText=False):
    """Make a preformatted text section. Special HTML characters
       in the text are properly replaced (using escape from cgi) if
       escapeText is set True."""
    return '<pre%s>\n%s\n</pre>\n' % (sep(attr),escape(text) if escapeText else text)
 

htmlSelect()

def WebPage.htmlSelect	(		labelText,
			parName,
			args,
			choiceList,
			hint = None,
			descriptionSeparator = '::',
			labelAttr = '',
			attr = ''
	)

Make a select statement (including label with text).

Definition at line 183 of file WebPage.py.

def htmlSelect(labelText, parName, args, choiceList, hint=None, descriptionSeparator='::',               labelAttr='', attr=''):
    """Make a select statement (including label with text)."""
    snippet = htmlLabel(labelText,parName,labelAttr)
    default = args[parName] if parName in args else ''
    if not isinstance(default,list):
        default = [default]
    snippet += '<select name="%s"%s>\n' % (parName,sep(attr))
    if hint:
        snippet += '<option value="">%s</option>\n' % hint
    for c in choiceList:
        p = c.split(descriptionSeparator)
        if len(p)==2:
            (desc,val) = p
        else:
            (desc,val) = (c,c)
        if val in default:
            snippet += '<option selected="yes" value="%s">%s</option>\n' % (val,desc)
        else:
            snippet += '<option value="%s">%s</option>\n' % (val,desc)
    snippet += '</select>\n'
    return snippet
 
 

htmlSubmit()

def WebPage.htmlSubmit	(		text,
			parName,
			attr = '',
			onlyOnce = False
	)

Make a submit button. If onlyOnce is true, the button can only
   be clicked once in order to prevent multiple clicking of the
   submit button.

Definition at line 227 of file WebPage.py.

def htmlSubmit(text, parName, attr='', onlyOnce=False):
    """Make a submit button. If onlyOnce is true, the button can only
       be clicked once in order to prevent multiple clicking of the
       submit button."""
    if onlyOnce:
        # FIXME: this doesn't work yet - it disables submission
        s = '<input type="button" name="%s" value="%s"' % (parName,text)
        s += ' onclick="this.form.submit()"'
        s += '%s />\n' % sep(attr)
        return s
    else:
        return '<input type="submit" name="%s" value="%s"%s />\n' % (parName,text,sep(attr))
 
 
#
# Utility classes
#

htmlText()

def WebPage.htmlText	(		text,
			attr = '',
			escapeText = False
	)

Make a text consisting of an unnamed div. Special HTML characters
   in the text are properly replaced (using escape from cgi) if
   escapeText is set True.

Definition at line 58 of file WebPage.py.

def htmlText(text, attr='', escapeText=False):
    """Make a text consisting of an unnamed div. Special HTML characters
       in the text are properly replaced (using escape from cgi) if
       escapeText is set True."""
    return '<div%s>%s</div>\n' % (sep(attr),escape(text) if escapeText else text)
 

htmlTextInput()

def WebPage.htmlTextInput	(		labelText,
			parName,
			args,
			size = None,
			maxLength = None,
			labelAttr = '',
			attr = ''
	)

Make a text input area (including label with text). Special HTML
   characters in any default text are properly replaced.

Definition at line 213 of file WebPage.py.

def htmlTextInput(labelText, parName, args, size=None, maxLength = None, labelAttr='', attr=''):
    """Make a text input area (including label with text). Special HTML
       characters in any default text are properly replaced."""
    snippet = htmlLabel(labelText,parName,labelAttr)
    snippet += '<input type="text" name="%s"' % parName
    if parName in args:
        snippet += ' value="%s"' % escape(args[parName],True)
    if size!=None:
        snippet += ' size="%s"' % size
    if maxLength!=None:
        snippet += ' maxlength="%s"' % maxLength
    snippet += '%s/>\n' % sep(attr)
    return snippet
 

sep()

def WebPage.sep

(

s

)

Add separator to string s unless s is empty.

Definition at line 42 of file WebPage.py.

def sep(s):
    """Add separator to string s unless s is empty."""
    return ' '+s if s else s
 

Variable Documentation

__author__

string WebPage.__author__ = 'Juerg Beringer'

private

Definition at line 9 of file WebPage.py.

__version__

string WebPage.__version__ = 'WebPage.py atlas/athena'

private

Definition at line 10 of file WebPage.py.

endPage

string WebPage.endPage

Initial value:

=  """\
</body>
</html>\
"""

Definition at line 33 of file WebPage.py.

startPage

string WebPage.startPage

Initial value:

=  """\
%(contentType)s<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>%(pageTitle)s</title>
<link href="%(cssName)s" rel="stylesheet" type="text/css" />
%(pageHeaderSnippets)s\
</head>
<body>
"""

Definition at line 20 of file WebPage.py.