Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
GridColumn Class Reference
Inheritance diagram for GridColumn:
GridBodyElement BaseSignoffStatusColumn FileGenreGridColumn FileNameGridColumn FileSignoffGridColumn ItemSelectionGridColumn ListbuilderGridColumn UploaderUserGroupGridColumn SignoffOnSignoffGridColumn SignoffStatusFromFileGridColumn MultilingualListbuilderGridColumn

Public Member Functions

 getCellActions ($request, $row, $position=GRID_ACTION_POSITION_DEFAULT)
 
getCellProvider ()
 
 getLocalizedTitle ()
 
 getTemplate ()
 
 getTitle ()
 
 GridColumn ($id= '', $title=null, $titleTranslated=null, $template= 'controllers/grid/gridCell.tpl', $cellProvider=null, $flags=array())
 
 setTemplate ($template)
 
 setTitle ($title)
 
 setTitleTranslated ($titleTranslated)
 
- Public Member Functions inherited from GridBodyElement
 addFlag ($flag, $value=true)
 
getCellProvider ()
 
 getFlag ($flag)
 
 getFlags ()
 
 getId ()
 
 GridBodyElement ($id= '', $cellProvider=null, $flags=array())
 
 hasFlag ($flag)
 
 setCellProvider (&$cellProvider)
 
 setId ($id)
 

Public Attributes

 $_template
 
 $_title
 
 $_titleTranslated
 
- Public Attributes inherited from GridBodyElement
 $_cellProvider
 
 $_flags
 
 $_id
 

Detailed Description

Represents a column within a grid. It is used to configure the way cells within a column are displayed (cell provider) and can also be used to configure a editing strategy (not yet implemented). Contains all column- specific configuration (e.g. column title).

Definition at line 25 of file GridColumn.inc.php.

Member Function Documentation

GridColumn::getCellActions (   $request,
  $row,
  $position = GRID_ACTION_POSITION_DEFAULT 
)

Get cell actions for this column.

NB: Subclasses have to override this method to actually provide cell-specific actions. The default implementation returns an empty array.

Parameters
$rowGridRow The row for which actions are being requested.
Returns
array An array of LinkActions for the cell.

Definition at line 134 of file GridColumn.inc.php.

& GridColumn::getCellProvider ( )
See Also
GridBodyElement::getCellProvider()

Definition at line 112 of file GridColumn.inc.php.

GridColumn::getLocalizedTitle ( )

Get the translated column title

Returns
string

Definition at line 88 of file GridColumn.inc.php.

References $_template.

GridColumn::getTemplate ( )

get the column's cell template

Returns
string

Definition at line 97 of file GridColumn.inc.php.

GridColumn::getTitle ( )

Get the column title

Returns
string

Definition at line 64 of file GridColumn.inc.php.

GridColumn::GridColumn (   $id = '',
  $title = null,
  $titleTranslated = null,
  $template = 'controllers/grid/gridCell.tpl',
  $cellProvider = null,
  $flags = array() 
)

Constructor

Definition at line 47 of file GridColumn.inc.php.

References $_title.

GridColumn::setTemplate (   $template)

set the column's cell template

Parameters
$templatestring

Definition at line 105 of file GridColumn.inc.php.

GridColumn::setTitle (   $title)

Set the column title (already translated)

Parameters
$titlestring

Definition at line 72 of file GridColumn.inc.php.

GridColumn::setTitleTranslated (   $titleTranslated)

Set the column title (already translated)

Parameters
$titlestring

Definition at line 80 of file GridColumn.inc.php.

Member Data Documentation

string GridColumn::$_template

the controller template for the cells in this column

Definition at line 42 of file GridColumn.inc.php.

Referenced by getLocalizedTitle().

string GridColumn::$_title

the column title i18n key

Definition at line 30 of file GridColumn.inc.php.

Referenced by GridColumn().

string GridColumn::$_titleTranslated

the column title (translated)

Definition at line 36 of file GridColumn.inc.php.


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