WebPage.htmlTable Class Reference

Collaboration diagram for WebPage.htmlTable:

Public Member Functions
	__init__ (self, tableAttr='', defaultCellAttr=[], useTableSorter=False, escapeText=False)
	__str__ (self)
	appendRow (self, cellData, rowAttr='')
	getHtml (self)

Public Attributes
	tableAttr = tableAttr
	defaultCellAttr = defaultCellAttr
	useTableSorter = useTableSorter
	escapeText = escapeText
list	rows = []

Detailed Description

Make a table. Table row data is accumulated internally in a list.
   The table can be made sortable (using jQuery's plugin Tablesorter)
   by setting useTableSorter to True. Special HTML characters in cell
   data are properly replaced (using escape from cgi) if escapeText
   is set True.

Definition at line 91 of file WebPage.py.

Constructor & Destructor Documentation

__init__()

WebPage.htmlTable.__init__	(		self,
			tableAttr = '',
			defaultCellAttr = [],
			useTableSorter = False,
			escapeText = False )

Definition at line 98 of file WebPage.py.

    def __init__(self, tableAttr='', defaultCellAttr = [], useTableSorter=False, escapeText=False):
        self.tableAttr = tableAttr
        self.defaultCellAttr = defaultCellAttr
        self.useTableSorter = useTableSorter
        self.escapeText = escapeText
        self.rows = []   # list of HTML strings with complete rows of the table
 

Member Function Documentation

__str__()

WebPage.htmlTable.__str__

(

self

)

Definition at line 105 of file WebPage.py.

    def __str__(self):
        return self.getHtml()
 

appendRow()

WebPage.htmlTable.appendRow	(		self,
			cellData,
			rowAttr = '' )

Append a row to the table. cellData is a list of the contents of
   the cells in the row. The data for each cell is either a string
   with the contents of the cell, or a tuple where the first element
   is the contents of the cell and the second element contains any
   HTML tags. Special HTML characters are properly replaced (using
   escape from cgi) if escapeText was set True when creating the
   table. If the table uses Tablesorter, <th> is used instead of
   <td> in the first row.

Definition at line 108 of file WebPage.py.

    def appendRow(self, cellData, rowAttr=''):
        """Append a row to the table. cellData is a list of the contents of
           the cells in the row. The data for each cell is either a string
           with the contents of the cell, or a tuple where the first element
           is the contents of the cell and the second element contains any
           HTML tags. Special HTML characters are properly replaced (using
           escape from cgi) if escapeText was set True when creating the
           table. If the table uses Tablesorter, <th> is used instead of
           <td> in the first row."""
        r = '<tr%s>\n' % sep(rowAttr)
        if self.useTableSorter and len(self.rows)==0:
            # First row using Tablesorter - must use <th> instead of <td>
            cellFormat = '<th%s>%s</th>\n'
        else:
            cellFormat = '<td%s>%s</td>\n'
        iCell = 0
        for c in cellData:
            cellAttr = self.defaultCellAttr[iCell] if iCell<len(self.defaultCellAttr) else ''
            if isinstance(c,tuple):
                r += cellFormat % (sep(c[1]),escape(str(c[0])) if self.escapeText else str(c[0]))
            else:
                r += cellFormat % (sep(cellAttr),escape(str(c)) if self.escapeText else str(c))
            iCell += 1
        r += '</tr>'
        self.rows.append(r)
 

getHtml()

WebPage.htmlTable.getHtml

(

self

)

Return the HTML code for the table.

Definition at line 134 of file WebPage.py.

    def getHtml(self):
        """Return the HTML code for the table."""
        if len(self.rows)<1:
            return ''
        if self.useTableSorter:
            if self.tableAttr:
                h = '<table %s>\n' % self.tableAttr
            else:
                h = '<table class="tablesorter">\n'
            h += '<thead>\n'
            h += self.rows[0]
            h += '\n</thead><tbody>\n'
            h += '\n'.join(self.rows[1:])
            h += '\n</tbody></table>\n'
        else:
            h = '<table%s>\n' % sep(self.tableAttr)
            h += '\n'.join(self.rows)
            h += '\n</table>\n'
        return h
 

Member Data Documentation

defaultCellAttr

WebPage.htmlTable.defaultCellAttr = defaultCellAttr

Definition at line 100 of file WebPage.py.

escapeText

WebPage.htmlTable.escapeText = escapeText

Definition at line 102 of file WebPage.py.

rows

WebPage.htmlTable.rows = []

Definition at line 103 of file WebPage.py.

tableAttr

WebPage.htmlTable.tableAttr = tableAttr

Definition at line 99 of file WebPage.py.

useTableSorter

WebPage.htmlTable.useTableSorter = useTableSorter

Definition at line 101 of file WebPage.py.

---

The documentation for this class was generated from the following file:

• WebPage.py