Class: DataColumnComponent

Source Location: /framework/template/components/data/data_table.inc.php

Class Overview

Component
   |
   --DataColumnComponent

run-time component for the Data:Column tag

Variables

Methods

Inherited Variables

Class: Component

Component::$children
Component::$id
Component::$IsDynamicallyRendered
Component::$parent

Inherited Methods

Class: Component

Component::addChild(): Adds a reference to a child component to this component, using it's ID attribute as the child array key
Component::findChild(): Returns a child component given it's ID.
Component::findChildByClass(): Returns the first child component matching the supplied WACT_TEMPLATE Component PHP class name
Component::findParentByClass(): Recursively searches through parents of this component searching for a given WACT_TEMPLATE component PHP class name
Component::getChild(): Same as find child, except raises error if child is not found
Component::getServerId(): Returns the ID of the component, as defined in the template tags ID attribute
Component::render(): Outputs the component, rendering any child components as well This method will only ever be called on components that support Dynamic rendering.
Component::setChildDataSource(): set the data source of a child component, or raise an error if the child is not found.

Class Details

run-time component for the Data:Column tag

author:

Jason E. Sweat <jsweat_php AT yahoo DOT com>

Class Variables

$attribs =

var:	column cell attributes
access:	private

Type:

string

$colCssClassFilter =

var:	class filter
access:	private

Type:

row

$footerFuncts = array()

var:	list of the custom footer functions
access:	private

Type:

array

$group = false

var:	this columns data:group component, if defined
access:	private

Type:

DataGroupComponent

$headAttribs =

var:	header cell attributes
access:	private

Type:

string

$headerFunct = false

var:	name of the custom header function
access:	private

Type:

string

$heading = false

var:	output as table heading
access:	private

Type:

prefered

$label = false

var:	for column heading
access:	private

Type:

text

$renderFunct = false

var:	name of the custom render function
access:	private

Type:

string

$visible = true

var:	controls visibility
access:	private

Type:

boolean

Class Methods

method addFooterFunct

add a footer render function for this column

void addFooterFunct(
mixed
$funct)

API Tags:

access:

public

method clearFooters

remove all footer render functions for this column

void clearFooters(
)

API Tags:

access:

public

method getFooterCount

add a footer render function for this column

void getFooterCount(
)

API Tags:

access:

public

method header

render the header for this column

void header(
DataSource
&$TabDataSource, DataSource
&$TplDataSource, string
$key, [boolean
$grpHead = false], [mixed
$firstPass = true])

API Tags:

access:

protected

Parameters:

DataSource	&$TabDataSource	the table data space
DataSource	&$TplDataSource	the template data space
string	$key	the column id
boolean	$grpHead	does this table require group headings

method hide

disable visibility for this column

void hide(
)

API Tags:

access:

public

method isVisible

is visibility for enabled this column

void isVisible(
)

API Tags:

access:

public

method openTableRow

opens a table row

void openTableRow(
DataSource
&$DataSource)

API Tags:

access:

public

Parameters:

DataSource

&$DataSource

the template data space

method outputTd

output as a td cell

void outputTd(
)

API Tags:

access:

public

method outputTh

output as a th cell

void outputTh(
)

API Tags:

access:

public

method registerCssClassFilter

void registerCssClassFilter(
string
&$filter, DataColumnComponent
1)

API Tags:

access:

protected

Parameters:

DataColumnComponent	1
string	&$filter	column name identifier

method registerGroup

void registerGroup(
DataColumnComponent
&$group)

API Tags:

access:

protected

Parameters:

DataColumnComponent

&$group

method render

render the cell

void render(
DataSource
&$TabDataSource, string
&$TplDataSource, mixed
$value)

API Tags:

access:

protected

Overrides Component::render() (Outputs the component, rendering any child components as well This method will only ever be called on components that support Dynamic rendering.)

Parameters:

DataSource	&$TabDataSource	the template data space
string	&$TplDataSource	the value

method renderFooter

render a footer cell

void renderFooter(
integer
$count, DataSource
&$TabDataSource, DataSource
&$TplDataSource)

API Tags:

access:

protected

Parameters:

integer	$count	count the number of the footer to render
DataSource	&$TabDataSource	the table data space
DataSource	&$TplDataSource	the template data space

method setAttrib

set column cell attributes

void setAttrib(
string
$attribs)

API Tags:

access:

public

Parameters:

string

$attribs

the cell attributes

method setHeaderAttrib

set header attributes

void setHeaderAttrib(
string
$attribs)

API Tags:

access:

public

Parameters:

string

$attribs

method setHeaderFunct

set custom header function for this column

void setHeaderFunct(
mixed
$funct)

API Tags:

access:

public

method setLabel

set column heading

void setLabel(
string
$label)

API Tags:

access:	public
todo:	Is this used?

Parameters:

string

$label

heading

method setRenderFunct

set render function for this column

void setRenderFunct(
mixed
$funct)

API Tags:

access:

public

method show

enable visibility for this column

void show(
)

API Tags:

access:

public

Documentation generated on Sun, 28 Nov 2004 19:45:23 -0800 by phpDocumentor 1.2.3