AnewtGridColumn Class Reference

A grid column for the AnewtGridRenderer. More...

List of all members.

Public Member Functions

 __construct ($column_id, $title=null, $order=null, $visible=null)
 Constructs a new AnewtGridColumn.
 add_cell_renderer ($cell_renderer)
 Add a cell renderer to this column.
 cell_renderer ($cell_renderer_id=null)
 Return the specified cell renderer.
 cell_renderers ()
 Return all AnewtGridCellRenderer instances associated with this column.

Public Attributes

 $id
 The id of this grid column.

Private Member Functions

 _n_cell_renderers ()
 Returns the number of cell renderers in this column.

Private Attributes

 $_cell_renderers = array()
 list of cell renderers


Detailed Description

A grid column for the AnewtGridRenderer.

This is merely an object to hold some column-related properties, as well as a list of AnewtGridCellRenderer instances that do the actual rendering of data.

Definition at line 16 of file column.lib.php.


Constructor & Destructor Documentation

AnewtGridColumn::__construct ( column_id,
title = null,
order = null,
visible = null 
)

Constructs a new AnewtGridColumn.

Parameters:
$column_id A string id to use for this column. This string can be used afterwards to show, hide or highlight the column.
$title A string that will be used in the header row as the title for this column (optional).
$order The order of this column (optional, defaults to null). Usually you won't need this. The default order is the order in which the columns are added to the grid.
$visible Initial visibility for this column (optional). Usually you won't need this, but it can be useful if you're using the same grid renderer for different views on the same type of data.

Definition at line 42 of file column.lib.php.


Member Function Documentation

AnewtGridColumn::add_cell_renderer ( cell_renderer  ) 

Add a cell renderer to this column.

Parameters:
$cell_renderer A AnewtGridCellRenderer instance.
See also:
AnewtGridCellRenderer

Definition at line 72 of file column.lib.php.

AnewtGridColumn::cell_renderer ( cell_renderer_id = null  ) 

Return the specified cell renderer.

If no name is given, the first cell renderer instance is returned.

Parameters:
$cell_renderer_id Name of the cell renderer (optional).
Returns:
A AnewtGridCellRenderer instance
See also:
AnewtGridCellRenderer

Definition at line 95 of file column.lib.php.

AnewtGridColumn::cell_renderers (  ) 

Return all AnewtGridCellRenderer instances associated with this column.

Returns:
Array of AnewtGridCellRenderer instances
See also:
AnewtGridCellRenderer

Definition at line 114 of file column.lib.php.

AnewtGridColumn::_n_cell_renderers (  )  [private]

Returns the number of cell renderers in this column.

Returns:
The number of cell renderers.
See also:
AnewtGridCellRenderer

Definition at line 129 of file column.lib.php.


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

Generated on Sun Aug 2 22:54:37 2009 for Anewt by  doxygen 1.5.9