Docs For Class atkTableRendererGrouped

Home

Documentation home

Atk index

Docs For Class atkTableRendererGrouped [ package: atk ]

Class: atkTableRendererGrouped

Source Location: /utils/class.atktablerenderergrouped.inc

Class atkTableRendererGrouped

Class Overview

Renders table with row based groups. A grouped table is a table with some rows grouped together. They are visually folded and can be expanded by clicking.

This feature can be used to organise (long) tables where you only want to see a portion of logically grouped rows.

By specifying which rows form a group the renderer can fold the rows so they are invisible. A group header row is displayed so, by clicking on it the visibility of the rows in the group is toggled. Please note that you can mix normal rows with grouped rows. See the data format example below.

Use the following data format as the first argument to the render method. Format:

$data = array(
array('headercol1', 'headercol2'), // header cannot be grouped, rendered as normal row
array('a1', 'b1'), // normal row
array('a2', 'b2'), // normal row
array(
'type' => 'group', // set this so the renderer knows it's a group
'id' => 'groupname1', // name of the group (unique), used as html id attribute
'collapsed' => true, // should the group be collapsed initially? optional, default is true
'header' => 'My Group', // the header row to display, use array format like a normal row or a string
'rows' => array( // the rows to be grouped together
array('a3', 'b3'),
array('a4', 'b4'),
array('a5', 'b5'),
)
array('a6', 'b6'), // normal row
),
array('footercol1', 'footercol2'), // cannot be grouped, normal row
)

Located in /utils/class.atktablerenderergrouped.inc [line 66]

Wiki documentation

atkTableRenderer
   |
   --atkTableRendererGrouped

Author(s):

Edgar van Ispelen <edgar@ibuildings.nl>

Information Tags:

Properties

$m_currentRow

Methods

[ Top ]

Inherited from parent

Inherited Properties	Inherited Methods
Inherited From atkTableRenderer atkTableRenderer::$m_cellalignment atkTableRenderer::$m_cellclass atkTableRenderer::$m_colalignment atkTableRenderer::$m_colclass atkTableRenderer::$m_defaultalignment atkTableRenderer::$m_defaultclass atkTableRenderer::$m_flags atkTableRenderer::$m_maxWidth atkTableRenderer::$m_rowalignment atkTableRenderer::$m_rowclass atkTableRenderer::$m_span atkTableRenderer::$m_style atkTableRenderer::$m_tableMatrix	Inherited From atkTableRenderer atkTableRenderer::atkTableRenderer() Constructs a new table renderer atkTableRenderer::getAlignment() Gets the alignment for a specific cell atkTableRenderer::getClass() Determines the class to be set for a specific cell atkTableRenderer::getSpan() Gets the spanning for a specific cell atkTableRenderer::registerStyle() Registers a style with the page. atkTableRenderer::render() Render a table. atkTableRenderer::setAlignment() Set the alignment for a particular cell. atkTableRenderer::setClass() Set the class for a particular cell. atkTableRenderer::setColAlignment() Set the alignment for an entire column. atkTableRenderer::setColClass() Set the class for an entire column. atkTableRenderer::setColSpan() Set the colspan for a cel atkTableRenderer::setDefaultAlignment() Set the default alignment for all cells in the table. atkTableRenderer::setDefaultClass() Set the default class for all cells in the table. atkTableRenderer::setFlag() Sets a flag on this object. Allowed: TBL_HEADER, TBL_FOOTER, TBL_ALTERNATE and TBL_DATA atkTableRenderer::setRowAlignment() Set the alignment for an entire row. atkTableRenderer::setRowClass() Set the class for an entire row. atkTableRenderer::setRowSpan() Set the rowspan for a cel atkTableRenderer::setTableStyle() Sets the table style class and registers it in the result page atkTableRenderer::_alignmentStr() Gets the alignmentstring for an alignment flag atkTableRenderer::_classStr() Constructs the html class attribute string using a classname atkTableRenderer::_getIdStr() Gets the cell id string if available. atkTableRenderer::_getMaxCols() Gets the maximum number of columns in a row atkTableRenderer::_getRowClassStr() Gets the styleclass for a rownumber Supports alternating rowclasses if TBL_ALTERNATE is set atkTableRenderer::_getTableStyleStr() Gets the table style attribute component atkTableRenderer::_renderBody() Renders the body of the table. The body contains all rows except the header and footer rows. Surrounds the body with tbody tags. atkTableRenderer::_renderCell() Renders one cell in the table. atkTableRenderer::_renderFillingCell() Renders a filling cell used to display a correct two-dimensional table. atkTableRenderer::_renderFooter() Renders one footer row. atkTableRenderer::_renderHeader() Renders one header row. atkTableRenderer::_renderRow() Renders one row in the table. atkTableRenderer::_renderTable() Renders the table. atkTableRenderer::_renderValue() Renders the value inside one cell. atkTableRenderer::_setSpan() Sets spanning on a specifc column. atkTableRenderer::_spanStr() Gets the span string for a cell

Inherited Properties

Inherited Methods

Inherited From atkTableRenderer

atkTableRenderer::$m_cellalignment

atkTableRenderer::$m_cellclass

atkTableRenderer::$m_colalignment

atkTableRenderer::$m_colclass

atkTableRenderer::$m_defaultalignment

atkTableRenderer::$m_defaultclass

atkTableRenderer::$m_flags

atkTableRenderer::$m_maxWidth

atkTableRenderer::$m_rowalignment

atkTableRenderer::$m_rowclass

atkTableRenderer::$m_span

atkTableRenderer::$m_style

atkTableRenderer::$m_tableMatrix

Inherited From atkTableRenderer

atkTableRenderer::atkTableRenderer()

Constructs a new table renderer

atkTableRenderer::getAlignment()

Gets the alignment for a specific cell

atkTableRenderer::getClass()

Determines the class to be set for a specific cell

atkTableRenderer::getSpan()

Gets the spanning for a specific cell

atkTableRenderer::registerStyle()

Registers a style with the page.

atkTableRenderer::render()

Render a table.

atkTableRenderer::setAlignment()

Set the alignment for a particular cell.

atkTableRenderer::setClass()

Set the class for a particular cell.

atkTableRenderer::setColAlignment()

Set the alignment for an entire column.

atkTableRenderer::setColClass()

Set the class for an entire column.

atkTableRenderer::setColSpan()

Set the colspan for a cel

atkTableRenderer::setDefaultAlignment()

Set the default alignment for all cells in the table.

atkTableRenderer::setDefaultClass()

Set the default class for all cells in the table.

atkTableRenderer::setFlag()

Sets a flag on this object. Allowed: TBL_HEADER, TBL_FOOTER, TBL_ALTERNATE and TBL_DATA

atkTableRenderer::setRowAlignment()

Set the alignment for an entire row.

atkTableRenderer::setRowClass()

Set the class for an entire row.

atkTableRenderer::setRowSpan()

Set the rowspan for a cel

atkTableRenderer::setTableStyle()

Sets the table style class and registers it in the result page

atkTableRenderer::_alignmentStr()

Gets the alignmentstring for an alignment flag

atkTableRenderer::_classStr()

Constructs the html class attribute string using a classname

atkTableRenderer::_getIdStr()

Gets the cell id string if available.

atkTableRenderer::_getMaxCols()

Gets the maximum number of columns in a row

atkTableRenderer::_getRowClassStr()

Gets the styleclass for a rownumber Supports alternating rowclasses if TBL_ALTERNATE is set

atkTableRenderer::_getTableStyleStr()

Gets the table style attribute component

atkTableRenderer::_renderBody()

Renders the body of the table. The body contains all rows except the header and footer rows. Surrounds the body with tbody tags.

atkTableRenderer::_renderCell()

Renders one cell in the table.

atkTableRenderer::_renderFillingCell()

Renders a filling cell used to display a correct two-dimensional table.

atkTableRenderer::_renderFooter()

Renders one footer row.

atkTableRenderer::_renderHeader()

Renders one header row.

atkTableRenderer::_renderRow()

Renders one row in the table.

atkTableRenderer::_renderTable()

Renders the table.

atkTableRenderer::_renderValue()

Renders the value inside one cell.

atkTableRenderer::_setSpan()

Sets spanning on a specifc column.

atkTableRenderer::_spanStr()

Gets the span string for a cell

[ Top ]

Property Summary

unknown_type

$m_currentRow

Used in counting rows

[ Top ]

Method Summary

atkTableRendererGrouped	atkTableRendererGrouped()	Constructor
int	getAlignment()	Overloading extension of parent::getAlignment() Adds special rule for groupheaders.
int	_getMaxCols()	Gets the maximum number of columns in a row.
bool	_isCollapsedGroup()	Checks if the group should be displayed collapsed or expanded
bool	_isGroup()	Determine if the data is a row group
string	_renderBody()	Renders the body of the table. The body contains all rows except the header and footer rows. Surrounds the body with tbody tags.
string	_renderRowGroup()	Renders a group of rows
string	_renderRowGroupHeader()	Renders the header of a group

[ Top ]

Properties

unknown_type $m_currentRow = 0 [line 74]

Used in counting rows

API Tags:

Access:

private

[ Top ]

Methods

Constructor atkTableRendererGrouped [line 85]

atkTableRendererGrouped atkTableRendererGrouped(
[int
$flags = 0], [string
$style = ''], [string
$module = ''] 
)

Constructor

Parameters:

int	$flags:	flags to set on this object (see setFlag)
string	$style:	stylesheet file (basename) to use like: 'recordlist'.
string	$module:	module name to register style with

API Tags:

Access:

public

[ Top ]

getAlignment [line 299]

int getAlignment(
string|int
$row, int
$col 
)

Overloading extension of parent::getAlignment() Adds special rule for groupheaders.

Parameters:

string\|int	$row:	rownumber or name
int	$col:	column number

API Tags:

Return:	alignment flag
Access:	protected

Redefinition of:

atkTableRenderer::getAlignment(): Gets the alignment for a specific cell

[ Top ]

_getMaxCols [line 268]

int _getMaxCols(
aray
$data 
)

Gets the maximum number of columns in a row.

Parameters:

aray

$data:

table data

API Tags:

Return:	max number of rows
Access:	protected

Redefinition of:

atkTableRenderer::_getMaxCols(): Gets the maximum number of columns in a row

[ Top ]

_isCollapsedGroup [line 219]

bool _isCollapsedGroup(
array
$group 
)

Checks if the group should be displayed collapsed or expanded

Parameters:

array

$group:

group data

API Tags:

Return:

true if the group should be displayed collapsed, false otherwise

[ Top ]

_isGroup [line 154]

bool _isGroup(
array
$entry 
)

Determine if the data is a row group

Parameters:

array

$entry:

data

API Tags:

Return:	true if it is a group false otherwise
Access:	protected

[ Top ]

_renderBody [line 103]

string _renderBody(
array
$data, [int
$rowOffset = 0] 
)

Renders the body of the table. The body contains all rows except the header and footer rows. Surrounds the body with tbody tags.

Parameters:

array	$data:	all body rows
int	$rowOffset:	how many header rows are drawn before the body

API Tags:

Return:	html table body
Access:	protected

Redefinition of:

atkTableRenderer::_renderBody(): Renders the body of the table. The body contains all rows except the header and footer rows. Surrounds the body with tbody tags.

[ Top ]

_renderRowGroup [line 233]

string _renderRowGroup(
array
$group, int
$rowOffset, int
$headerWidth 
)

Renders a group of rows

Parameters:

array	$group:	data of the group
int	$rowOffset:	how many real rows there were before
int	$headerWidth:	number of columns the header has to span

API Tags:

Return:	html of the header and group
Access:	protected

[ Top ]

_renderRowGroupHeader [line 171]

string _renderRowGroupHeader(
array
$group, int
$width 
)

Renders the header of a group

Parameters:

array	$group:	group data to show header of
int	$width:	span of the header cell

API Tags:

Return:	html of the header
Access:	protected

[ Top ]