class QikTable:
QikTable Class
Version:
2.2
Last Update: July 5, 2002
Author: Dennis Shearin
Copyright Dennis
Shearin, 2001, 2002
This class can be used to quickly and easily create
an HTML table. Many of the tables parameters (border, alignment, color, etc.)
can be set for the table as a whole or for individual rows, columns or cellls.
Several methods are provided to aid in importing data from various types of
databases. There is also support for CSS and templates, which can be used to
give tables a consistent look.
See license.txt for terms of
use.
Methods:
Constructor:
QikTable($contents = NULL, $headings = NULL, $comment = NULL,
$parameters = NULL, $data = NULL)
The constructor takes five
optional parameters.
The first, $contents, must be a two dimensional indexed
array representing the row and column data for the table.
The second,
$headings, is a one dimensional indexed array containing the text for the
headings. Various methods are provided to set, reset or clear these parameters
after instantiation.
The third, $comment, is a string that will be output as
an HTML comment immediately above the table.
The last two, $parameters
and $data, are not used by QikTable or any of its methods. Their purpose is to
provide a way of passing parameters to templates - eliminating the need for
using global variables. While there are no restrictions on the type or content
of these variables, $parameters is intended to be an associative array
containing the name/values pairs of parameters to be used by the template. $data
can be used for storing raw data to be processed by the template.
Nothing
is output at the time the QikTable object is instantiated. Methods are provided
to print the table once all parameters have been set.
Templates:
includeTemplate($templatefile)
This method
allows you to apply preconfigured templates to QikTable objects, making it easy
to create tables with a consistent look. This method can be used alone or in
conjuction with other QikTable methods. QikTable does not check for conflicts
between the parameters in the template and the other methods called. It is the
job of the browser to reconcile these conflicts and the results will depend, in
part, on the order in which the methods were called.
Template files are
simply standard PHP files. Any valid PHP command can be included and all these
commands must be contained within a PHP script tag. QikTable methods can be
invoked by preceding the method call with the keyword "$this->" (i.e.,
$this->setBorder(2);). Anything that appears outside of PHP tags will be
interpreted as HTML. This makes it possible to add titles or captions to your
tables using templates.
6/2/02 - This method will pass the return value
of a template back to the calling program.
useTemplate($templatefile)
This is an alias
for includeTemplate which reflects its more active role (i.e. macro capability).
This method allows you to apply preconfigured templates to QikTable objects,
making it easy to create tables with a consistent look. This method can be used
alone or in conjuction with other QikTable methods. QikTable does not check for
conflicts between the parameters in the template and the other methods called.
It is the job of the browser to reconcile these conflicts and the results will
depend, in part, on the order in which the methods were called.
Template
files are simply standard PHP files. Any valid PHP command can be included and
all these commands must be contained within a PHP script tag. QikTable methods
can be invoked by preceding the method call with the keyword "$this->" (i.e.,
$this->setBorder(2);). Anything that appears outside of PHP tags will be
interpreted as HTML. This makes it possible to add titles or captions to your
tables using templates.
QikTable Properties:
setComment($comment)
This method sets the
comment to be printed before the QikTable. A string is expected.
addComment($comment)
This method appends text
to the comment to be printed before the QikTable. A string is expected.
getComment()
This method returns the comment
to be printed before the QikTable.
setParameters($parameters)
This method sets
the contents of the Parameters variable. It is expected to be an associative
array containing name/value pairs of parameters to be used in a template.
getParameters()
This method returns the
contents of the Parameters variable.
setData($data)
This method sets the contents
of the Data section. This data storage area is intended for raw data to be
processed by a template and can be in any format.
getData()
This method returns the comment to
be printed before the QikTable.
Add Data:
addRow($newrow)
This method adds one row of
data to the end of the table. The parameter is expected to be an indexed
array.
This method is ideal for building an HTML table from an SQL table.
The output of each mysql_fetch_row statement can be used as the argument to the
addRow method.
addArray($inArray)
This method also takes an
array as input and adds one row of data to the end of the table. Unlike addRow,
this method will also process associative arrays, as well as non-sequential or
non-zero-based indexed arrays. It can be used in conjunction with the
mysql_fetch_assoc function.
addLine($line, $sep = "\t")
Like the above
methods, this adds one row of data to the end of the table, but it extracts that
data from a string rather than an array. The second parameter is an optional
separator character which is used to break the string into array elements. If
the separator is not specified, then the default character (tab) is
used.
This method is ideal for building an HTML table from CSV (comma
separated values) or tab-delimited flat file databases.
setContents($contents)
This method fills the
Contents array. The argument passed must be a two-dimensional indexed array
containing the data that will fill the rows and columns of the table's body. The
previous contents of the table are overwritten.
addContents($contents)
This method is exactly
like the method above except that it appends the new contents to the end of any
data that has already been added to the table.
clearContents()
This method clears all data
in the body of the table.
getContents()
This method can be used to
retrieve the current contents of the QikTable. It returns a two-dimensional
array representing the rows and columns of the table, or NULL if the contents
have been cleared or not set.
setHeadings($headings)
This method can be
used to set the headings for the table. It accepts an array containing the
headings. The previous contents of the headings array are overwritten.
clearHeadings()
This method clears the
headings for the table.
setHeadingsFromKeys($assocArray)
This is a
qik and easy way to set up the headings from the keys in an associative array.
The keys are extracted and the first letter of each key is capitalized. The
result from the mysql_fetch_assoc function can be used as an argument to this
function.
getHeadings()
This method can be used to
retrieve the current headings for the QikTable. It returns a one-dimensional
indexed array containing the column headings, or NULL if the headings have been
cleared or not set.
Set Number of Columns:
setColCount($numOfCols)
This method can be
used to set the number of columns to be displayed in the table. If the number of
columns is not set by calling one of these methods, then each row of the table
will contain the number of entries in that row of the array. No checking is done
to make sure that the number of cells is the same in each row of the table. The
major browsers don't seem to have a problem formatting uneven rows, but it's not
good form.
This method can also be used to limit the number of columns
printed. For example, if your array contains five elements per row, but you are
only interested in the first two, setting the Column Count to 2 will hide the
last three columns.
Do NOT set the number of columns if you are planning
on using the rowspan or colspan attributes.
setColCountFromHeadings()
This method sets
the number of columns to be displayed based on the number of entries in the
Headings array. To qikly set up a table from a MySQL table, first take the
results of the mysql_fetch_assoc function and call setHeadingsFromKeys(),
followed by setColCountFromHeadings().
setColCountFromContents()
This method sets
the number of columns to be displayed based on the longest row in the Contents
array. This is the least effective way to set the Column Count. If the Contents
array is large, this could be time consuming. Also, if every row in the array
contains at least one NULL value, then the results will not be accurate, as NULL
values are not counted.
This method will only set the Column Count if the
result it gets is greater than the current value of the Column Count. For
example, if every row of the Contents array has three elements and the Column
Count has been manually set to 4, a blank column will be output at the end of
the table. When using this method, it's best to explicitly set the Column Count
to zero first.
getColCount()
This method gets the number of
columns currently in the table. It does this by counting the number of entries
in the largest row of the Contents array. It ignores the Headings
array.
This method can be used in conditional statements in a QikTable
template file.
getRowCount()
This method gets the number of
rows currently in the table. It does this by counting the number of entries in
the Contents array. It does not count the Headings array.
This method can
be used in conditional statements in a QikTable template file.
Output Table:
startTable($toBrowser = TRUE)
This method
returns the initial TABLE tag with the parameters that have been set. If the
optional parameter is omitted or evaluates to TRUE, then the output will also be
sent to the browser.
endTable($toBrowser = TRUE)
This method
simply returns the closing TABLE tag and sends it to the browser if the optional
parameter is omitted or evaluates to TRUE.
printHeadings($toBrowser = TRUE)
This method
returns the headings for the table. They are also sent to the browser if the
optional parameter is omitted or evaluates to TRUE.
printContents($toBrowser = TRUE)
This method
returns the complete contents of the table as defined in the Contents array.
They are also sent to the browser if the optional parameter is omitted or
evaluates to TRUE.
printTable($toBrowser = TRUE)
This method
calls each of the above methods to return the complete table. The table is also
sent to the browser if the optional parameter is omitted or evaluates to
TRUE.
getTable()
This method returns the complete
table as a string. This can be useful for nesting QikTables or saving a
dynamically generated table as a static HTML file. This is an alias for
printTable(FALSE).
Set Table Attributes:
setTableAttrib($attribute, $value)
This
method can be used to set any attribute for the table - for example
setTableAttrib("border", 3). The first parameter is a string containing the name
of the HTML Table attribute to be set. The second parameter is the value
associated with that attribute, which can vary in type.
setBorder($border)
This method sets the
border parameter of the table. An integer parameter is expected and behavior is
undefined for any other argument type.
setCellSpacing($cellspacing)
This method sets
the cellspacing parameter of the table (the amount of whitespace between
adjacent table cells). An integer parameter is expected and behaviour is
undefined for any other argument type.
setCellPadding($cellpadding)
This method sets
the cellpadding parameter of the table (the amount of whitespace surrounding the
contents of a table cell). An integer parameter is expected and behaviour is
undefined for any other argument type.
setTableWidth($width)
This method can be used
to set the width of the table. Values can be entered in pixels or percentages.
Obviously, there is the potential for a conflict between this setting and the
value passed to the setColumnWidth method. QikTable does not check for these
conflicts, but leaves that to the user and browser to resolve.
setTableAlign($tableAlign)
This determines
how the table will be aligned with respect to the page (i.e., "left", "right",
"center").
setTableColor($color)
This method can be used
to set the background color for the table. Standard color names can be used or
the colors can be entered in hex notation (i.e., #FFFFFF, #9900FF, etc.). If not
called or called with a NULL argument, the table will be the same color as the
page.
setTableBackground($background)
This method
can be used to specify the URL of an image file to be used as a background for
the table. Typically, this takes precedence over the background color.
setTableClass($className)
This method can be
used to specify the CSS class that applies to the table as a whole. All the
characteristics of the table can be set in that class. The appearance of the
table can be changed by simply redefining the class or linking to a different
stylesheet.
setTableID($ID)
This method allows you to
uniquely identify the table with a CSS ID. This can be combined with a
stylesheet to set attributes for this table or it can make it possible to
dynamically manipulate the table via DHTML.
setTableStyle($style)
This method can be used
to directly enter the contents of a STYLE attribute that applies to the table as
a whole. No stylesheet or class definition is necessary (or this can be used to
override some attributes of a class). The argument passed to this method is in
the same form as the value of a STYLE attribute - for example,
setTableStyle("background-color: blue; font-family: sans-serif").
In a
CSS enabled browser, styles typically take precedence over HTML attributes. This
may be true even if the HTML attribute has a higher precedence in the QikTable
scheme. For example, Setting a Cell color to "blue" may not work if the Table
color has been set to "red" using setTableStyle.
addTableStyle($style)
The method is the same
as setTableStyle except that the new style information is appended to the end of
the current style definition, rather than overwriting it.
Set Cell Attributes:
Cell attributes apply only
to the cells in the content area of the table (not in the heading area). Cell
attributes take precedence over all other attributes (Table, Row,
Column).
The Cell is uniquely identified by the last 2 parameters -
$rowNum and $colNum. These are the zero-based indices for the row and column, so
the cell in the upper left-hand corner would be 0,0.
setCellAttrib($attribute, $value, $rowNum,
$colNum)
This method can be used to set any HTML attribute
for a cell - for example setCellAttrib("bgcolor", "blue", 0, 2). The first
parameter is a string containing the name of the HTML Table attribute to be set.
The second parameter is the value associated with that attribute, which can vary
in type.
setCellAlign($cellAlign, $rowNum,
$colNum)
This methods sets the alignment of the contents
within the cell indicated by $rowNum and $colNum. The first parameter should be
a string representing the alignment (i.e., "right", "left", "center").
setCellVAlign($cellVAlign, $rowNum,
$colNum)
This methods sets the vertical alignment of the
contents within the cell indicated by $rowNum and $colNum. The first parameter
should be a string representing the vertical alignment (i.e., "top", "bottom",
"middle").
setCellColor($color, $rowNum, $colNum)
Sets
the background color for the indicated cell. $color can be any named color
(i.e., "red", "blue", etc.) or in hex notation (i.e., "#663399","#99CCFF",
etc.). This setting will take precedence over the settings for the row and
column that the cell appears in.
setCellBackground($background, $rowNum,
$colNum)
Sets the background image for the cell. The first
parameter should be the URL of an image file. Support for this function varies
between browsers.
setCellClass($className, $rowNum,
$colNum)
This method sets the CSS class for the cell.
setCellStyle($style, $rowNum, $colNum)
Sets
the CSS style for this cell. The cell inherits all style attributes that are
defined in lower level components (i.e., Table, Row, Column) and overrides any
attributes that are set by this method.
addCellStyle($style, $rowNum, $colNum)
This
method is the same as setCellStyle except that it appends the new style
information to the end of the current Cell Style definition, rather than
overwriting it.
setCellID($id, $rowNum, $colNum)
This method
allows you to uniquely identify the cell with a CSS ID. This can be combined
with a stylesheet to set attributes for the cell or it can make it possible to
dynamically manipulate the cell via DHTML.
Set Heading Cell Attributes:
Since headings are
printed out one line at a time, heading cells are uniquely identified by the
zero-based index of the column they appear in. Heading cell settings take
precedence over heading attribute settings.
setHeadingCellAttrib($attribute, $value,
$colNum)
This method can be used to set any HTML attribute
for a heading cell - for example setHeadingCellAttrib("bgcolor", "blue", 2). The
first parameter is a string containing the name of the HTML Table attribute to
be set. The second parameter is the value associated with that attribute, which
can vary in type.
setHeadingCellAlign($headingCellAlign,
$colNum)
This methods sets the alignment of the contents
within the heading cell indicated by $colNum. The first parameter should be a
string representing the alignment (i.e., "right", "left", "center").
setHeadingCellVAlign($headingCellVAlign,
$colNum)
This methods sets the vertical alignment of the
contents within the cell indicated by $colNum. The first parameter should be a
string representing the vertical alignment (i.e., "top", "bottom",
"middle").
setHeadingCellColor($color, $colNum)
Sets the
background color for the indicated cell. $color can be any named color (i.e.,
"red", "blue", etc.) or in hex notation (i.e., "#663399","#99CCFF", etc.).
setHeadingCellBackground($background,
$colNum)
Sets the background image for the heading cell. The
first parameter should be the URL of an image file. Support for this function
varies between browsers.
setHeadingCellClass($className, $colNum)
This
method sets the CSS class for this heading cell.
setHeadingCellStyle($style, $colNum)
Sets the
CSS style for this heading cell. The cell inherits all style attributes that are
defined in the Table component and overrides any attributes that are set by this
method.
addHeadingCellStyle($style, $colNum)
This
method is the same as setHeadingCellStyle except that it appends the new style
information to the end of the current HeadingCell Style definition, rather than
overwriting it.
setHeadingCellID($id, $colNum)
Sets the CSS
ID for the heading cell. This can be used to uniquely identify the cell for the
purpose of applying SCC attributes or manipulating the cell via DHTML.
Set Row/Column Priority:
setRowPriority($rowPriority = TRUE)
By
default, if an attribute is set for a row and a column, the cell where they
intersect will take on the column attribute. This method can be used to change
the Row/Column precedence.
It takes one optional boolean argument. If the
argument is omitted or if it equals TRUE, then Row attributes will have priority
over Column attributes. If it is set to FALSE, then the opposite will be
true.
setColPriority($colPriority = TRUE)
By
default, Column attributes thake precedence over Row attributes. If that default
behaviour has been changed, this method can be used to restore it.
It
takes one optional boolean argument. If the argument is omitted or if it equals
TRUE, then Column attributes will have priority over Row attributes. If it is
set to FALSE, then the opposite will be true. Note that setColPriority(FALSE) is
equivalent to setRowPriority().
Set Column Attributes:
setColAttrib($attribute, $value,
$colNum)
This method can be used to set any attribute for a
column - for example setColumnAttrib("width", 80, 2). The first parameter is a
string containing the name of the HTML Table attribute to be set. The second
parameter is the value associated with that attribute, which can vary in type.
The last parameter is the zero-based index of the column.
By default,
columns take precedence over rows. This means that if an attribute is set for a
row and a column, the cell where they intersect will take on the attribute
setting of the column - unless rowPriority has been set or the attribute is also
set for the Cell (which always takes precedence of rows and columns).
setColWidth($colWidth, $colNum = NULL)
This
method can be used to set the width of the column indicated by the $colNum
parameter. Column width can be given in pixels or percentages.
If the
second parameter is omitted, then the width given by $colWidth is applied to all
of the columns. QikTable does no checking to prevent invalid values (i.e.,
applying a width of 50% each of the 3 columns in a table).
setColAlign($align, $colNum = NULL)
This
method can be used to set the alignment of the contents of the column indicated
by the $colNum parameter. The first parameter should be a string indicating the
alignment (i.e., "left", "right", "center").
If the second parameter is
omitted, then the alignment given by the first parameter is applied to all of
the columns.
setColVAlign($align, $colNum = NULL)
This
method can be used to set the vertical alignment of the contents of the column
indicated by the $colNum parameter. The first parameter should be a string
indicating the vertical alignment (i.e., "top", "bottom", "middle").
If
the second parameter is omitted, then the vertical alignment given by the first
parameter is applied to all columns.
setColColor($color, $colNum = NULL)
Sets the
background color for the indicated column. $color can be any named color (i.e.,
"red", "blue", etc.) or in hex notation (i.e., "#663399","#99CCFF",
etc.).
If the second parameter is omitted, then the background color
given by the first parameter is applied to all columns.
setColBackground($background, $colNum =
NULL)
Sets the background image for the column. The first
parameter should be the URL of an image file. Support for this function varies
between browsers.
If the second parameter is omitted, then the background
given by the first parameter is applied to all columns.
setColClass($class, $colNum = NULL)
This
method sets the CSS class for the column.
If the second parameter is
omitted, then the CSS class is applied to all columns.
setColStyle($style, $colNum = NULL)
Sets the
CSS style for this column. The column inherits all style attributes that are
defined in lower level components (i.e., Table, Contents, and Row - if
rowPriority is FALSE) and overrides any attributes that are set by this
method.
If the second parameter is omitted, then the style given by the
first parameter is applied to all columns.
addColStyle($style, $colNum)
This method is
the same as setColStyle except that it appends the new style information to the
end of the current Column Style definition, rather than overwriting
it.
The second parameter, $colNum, is required. This method cannot be
used to add style information to all columns (use addContentStyle
instead).
Set Row Attributes:
setRowAttrib($attribute, $value,
$rowNum)
This method can be used to set any attribute for a
row - for example setRowAttrib("align", "left", 2). The first parameter is a
string containing the name of the HTML Table attribute to be set. The second
parameter is the value associated with that attribute, which can vary in type.
The last parameter is the zero-based index of the row.
setRowAlign($align, $rowNum = NULL)
This
method can be used to set the alignment of the contents of the row indicated by
the $rowNum parameter. The first parameter should be a string indicating the
alignment (i.e., "left", "right", "center").
If the second parameter is
omitted, then the alignment given by the first parameter is applied to all
rows.
setRowVAlign($align, $rowNum = NULL)
This
method can be used to set the vertical alignment of the contents of the row
indicated by the $rowNum parameter. The first parameter should be a string
indicating the alignment (i.e., "top", "bottom", "middle").
If the second
parameter is omitted, then the alignment given by the first parameter is applied
to all rows.
setRowColor($color, $rowNum = NULL)
Sets the
background color for the indicated row. $color can be any named color (i.e.,
"red", "blue", etc.) or in hex notation (i.e., "#663399","#99CCFF",
etc.).
If the second parameter is omitted, then the background color
given by the first parameter is applied to all rows.
setRowBackground($background, $rowNum =
NULL)
Sets the background image for the row. The first
parameter should be the URL of an image file. Support for this function varies
between browsers.
If the second parameter is omitted, then the background
given by the first parameter is applied to all rows.
setRowClass($class, $rowNum = NULL)
This
method sets the CSS class for the row.
If the second parameter is
omitted, then the CSS class is applied to all rows.
setRowStyle($style, $rowNum = NULL)
Sets the
CSS style for this row. The row inherits all style attributes that are defined
in lower level components (i.e., Table, Contents, and Column - if rowPriority is
TRUE) and overrides any attributes that are set by this method.
If the
second parameter is omitted, then the style given by the first parameter is
applied to all rows.
addRowStyle($style, $rowNum)
This method is
the same as setRowStyle except that it appends the new style information to the
end of the current style definition for the row, rather than overwriting
it.
The second parameter, $rowNum, is required. This method cannot be
used to add style information to all rows (use addContentStyle instead).
Set Heading Attributes:
setHeadingAttrib($attribute, $value)
This
method can be used to set any attribute for the Heading section of the table -
for example setHeadingAttrib("bgcolor", "white"). The first parameter is a
string containing the name of the HTML Table attribute to be set. The second
parameter is the value associated with that attribute, which can vary in
type.
setHeadingAlign($headingAlign)
This
determines how the headings will be aligned with respect to the columns of the
table (i.e., "left", "right", "center").
setHeadingVAlign($headingVAlign)
This
determines how the headings will be vertically aligned within the cells of the
heading row (i.e., "top", "bottom", "middle").
setHeadingColor($color)
This method can be
used to set the background color for the headings. Standard color names can be
used or the colors can be entered in hex notation (i.e., #FFFFFF, #9900FF,
etc.).When not called or called with a NULL argument, the background color of
the headings will be the same as the underlying table.
setHeadingBackground($background)
This method
can be used to specify the URL of an image file to be used as a background for
the headings. Typically, this takes precedence over the background color.
Support for this varies between browsers.
setHeadingClass($className)
This method sets
the CSS class for the headings.
setHeadingStyle($style)
Sets the CSS style
for this Heading area. The headings inherit all style attributes that are
assigned to the Table and overrides any attributes that are set by this
method.
addHeadingStyle($style)
This method is the
same as setHeadingStyle except that it appends the new style information to the
end of the current Heading Style definition, rather than overwriting it.
Set Content Attributes:
setContentAttrib($attribute, $value)
This
method can be used to set any attribute for a content area of the table - for
example setContentAttrib("align", "right"). The first parameter is a string
containing the name of the HTML Table attribute to be set. The second parameter
is the value associated with that attribute, which can vary in type.
setContentAlign($align)
This determines how
the content in the body of the table will be aligned with respect to the table's
columns (i.e., "left", "right", "center").
setContentVAlign($align)
This determines how
the contents will be vertically aligned within the cells of the table body
(i.e., "top", "bottom", "middle").
setContentColor($color)
This method can be
used to set the background color for the body content. Standard color names can
be used or the colors can be entered in hex notation (i.e., #FFFFFF, #9900FF,
etc.).If not called or called with a NULL argument, the background color of the
content will be the same as the underlying table.
setContentBackground($background)
This method
can be used to specify the URL of an image file to be used as a background for
the table's content. Typically, this takes precedence over the background color.
Support for this varies between browsers.
setContentClass($className)
This method sets
the CSS class for the content area of the table.
setContentStyle($style)
Sets the CSS style
for the table's contents. All style attributes defined in the Table are
inherited, then this method overrides any of the same elements.
addContentStyle($style)
This method is the
same as setContentStyle except that it appends the new style information to the
end of the current Content Style definition, rather than overwriting it.
Clear Attributes:
Any property that has been set
using any of the above methods can be cleared using one of the clear methods.
The clear methods remove all reference to the attribute, rather than just
setting it to NULL, 0 or an empty string.
The clear methods only work on
attributes that have been set at the same level as the clear method. For
example, if the method setTableColor("blue") is called, every cell in the table
will have a blue background. calling clearCellColor() for a specific cell will
not remove the blue background. It will only remove a background that has been
set with setCellColor().
clearTableAttribs()
This method clears ALL
the attributes that have been set for the table as a whole. It has no effect on
attributes that have been set for rows, columns, cells, etc.
clearTableAttrib($attribute)
This method
clears the specified attribute that has been set for the table as a whole.
clearBorder()
This method clears the border
attribute of the table.
clearCellSpacing()
This method clears the
cell spacing attribute of the table.
clearCellPadding()
This method clears the
cell padding attribute of the table.
clearTableWidth()
This method clears the
width attribute of the table.
clearTableAlign()
This method clears the
alignment attribute of the table.
clearTableColor()
This method clears the
background color of the table. The color of the table will be the same as the
color of the page it is on.
clearTableBackground()
This method clears the
background image of the table.
clearTableClass()
This method clears the CSS
class associated with the table.
clearTableID()
This method clears the CSS ID
associated with the table.
clearTableStyle()
This method clears the CSS
style associated with the table.
clearCellAttribs($rowNum, $colNum)
This
method clears ALL the attributes that have been set for the cell indicated by
$rowNum, $colNum. It has no effect on attributes that have been set for the
table, rows, columns, etc.
clearCellAttrib($attribute, $rowNum,
$colNum)
This method clears the specified attribute that has
been set for the cell indicated by $rowNum, $colNum. It has no effect on an
attribute that has been set for the table, row, column, etc.
clearCellAlign($rowNum, $colNum)
This method
clears the alignment attribute that was set with setCellAlign($cellAlign,
$rowNum, $colNum).
clearCellVAlign($rowNum, $colNum)
This method
clears the vertical alignment attribute that was set with
setCellVAlign($cellVAlign, $rowNum, $colNum).
clearCellColor($rowNum, $colNum)
This method
clears the background color that was set with setCellColor($color, $rowNum,
$colNum).
clearCellBackground($rowNum, $colNum)
This
method clears the background image that was set with
setCellBackground($background, $rowNum, $colNum).
clearCellClass($rowNum, $colNum)
This method
clears the CSS class that was set with setCellClass($className, $rowNum,
$colNum).
clearCellStyle($rowNum, $colNum)
This method
clears the CSS style that was set with setCellStyle($style, $rowNum,
$colNum).
clearCellID($rowNum, $colNum)
This method
clears the CSS ID that was set with setCellID($id, $rowNum, $colNum).
clearHeadingCellAttribs($colNum)
This method
clears ALL the attributes that have been set for the heading cell indicated by
$colNum. It has no effect on attributes that have been set for the heading area
as a whole.
clearHeadingCellAttrib($attribute,
$colNum)
This method clears a specific attribute that has
been set for the heading cell indicated by $colNum. It has no effect on an
attribute that has been set for the heading area as a whole.
clearHeadingCellAlign($colNum)
This method
clears the alignment attribute that was set with setHeadingCellAlign($cellAlign,
$colNum).
clearHeadingCellVAlign($colNum)
This method
clears the vertical alignment attribute that was set with
setHeadingCellVAlign($cellVAlign, $colNum).
clearHeadingCellColor($colNum)
This method
clears the background color that was set with setHeadingCellColor($color,
$colNum).
clearHeadingCellBackground($colNum)
This
method clears the background image that was set with
setHeadingCellBackground($background, $colNum).
clearHeadingCellClass($colNum)
This method
clears the CSS class that was set with setHeadingCellClass($className,
$colNum).
clearHeadingCellStyle($colNum)
This method
clears the CSS style that was set with setHeadingCellStyle($style,
$colNum).
clearHeadingCellID($colNum)
This method
clears the CSS ID that was set with setHeadingCellID($id, $colNum).
clearColAttribs($colNum)
This method clears
ALL the attributes that have been set for the column indicated by $colNum. It
has no effect on attributes that have been set for the table, rows, cells,
etc.
clearColAttrib($attribute, $colNum)
This
method clears a specific attribute that has been set for the column indicated by
$colNum. It has no effect on an attribute that has been set for the table, row,
cell, etc.
clearColWidth($colNum)
This method clears the
width attribute that was set with setColWidth($colWidth, $colNum).
clearColAlign($colNum)
This method clears the
alignment attribute that was set with setColAlign($align, $colNum).
clearColVAlign($colNum)
This method clears
the vertical alignment attribute that was set with setColVAlign($VAlign,
$colNum).
clearColColor($colNum)
This method clears the
background color that was set with setColColor($color, $colNum).
clearColBackground($colNum)
This method
clears the background image that was set with setColBackground($background,
$colNum).
clearColClass($colNum)
This method clears the
CSS class that was set with setColClass($className, $colNum).
clearColStyle($colNum)
This method clears the
CSS style that was set with setColStyle($style, $colNum).
clearRowAttribs($rowNum)
This method clears
ALL the attributes that have been set for the row indicated by $rowNum. It has
no effect on attributes that have been set for the table, columns, cells,
etc.
clearRowAttrib($attribute, $rowNum)
This
method clears a specific attribute that has been set for the row indicated by
$rowNum. It has no effect on attributes that have been set for the table,
columns, cells, etc.
clearRowAlign($rowNum)
This method clears the
alignment attribute that was set with setRowAlign($align, $rowNum).
clearRowVAlign($rowNum)
This method clears
the vertical alignment attribute that was set with setRowVAlign($VAlign,
$rowNum).
clearRowColor($rowNum)
This method clears the
background color that was set with setRowColor($color, $rowNum).
clearRowBackground($rowNum)
This method
clears the background image that was set with setRowBackground($background,
$rowNum).
clearRowClass($rowNum)
This method clears the
CSS class that was set with setRowClass($className, $rowNum).
clearRowStyle($rowNum)
This method clears the
CSS style that was set with setRowStyle($style, $rowNum).
clearHeadingAttribs()
This method clears ALL
the attributes that have been set for the heading area. It has no effect on
attributes that have been set for a specific heading cell.
clearHeadingAttrib($attribute)
This method
clears a specific attribute that has been set for the heading area. It has no
effect on attributes that have been set for a specific heading cell.
clearHeadingAlign()
This method clears the
alignment attribute that was set with setHeadingAlign($align).
clearHeadingVAlign()
This method clears the
vertical alignment attribute that was set with setHeadingVAlign($VAlign).
clearHeadingColor()
This method clears the
background color that was set with setHeadingColor($color).
clearHeadingBackground()
This method clears
the background image that was set with setHeadingBackground($background).
clearHeadingClass()
This method clears the
CSS class that was set with setHeadingClass($className).
clearHeadingStyle()
This method clears the
CSS style that was set with setHeadingStyle($style).
clearContentAttribs()
This method clears ALL
the attributes that have been set for the content area of the table. It has no
effect on attributes that have been set for the table, rows, cells, etc.
clearContentAttrib($attribute)
This method
clears a specific attribute that has been set for the content area of the table.
It has no effect on attributes that have been set for the table, rows, cells,
etc.
clearContentAlign()
This method clears the
alignment attribute that was set with setContentAlign($align).
clearContentVAlign()
This method clears the
vertical alignment attribute that was set with setContentVAlign($VAlign).
clearContentColor()
This method clears the
background color that was set with setContentColor($color).
clearContentBackground()
This method clears
the background image that was set with setContentBackground($background).
clearContentClass()
This method clears the
CSS class that was set with setContentClass($className).
clearContentStyle()
This method clears the
CSS style that was set with
setContentStyle($style).