Open Journal Systems  3.3.0
ItemSelectionGridColumn Class Reference
Inheritance diagram for ItemSelectionGridColumn:
GridColumn GridBodyElement

Public Member Functions

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

Data Fields

 $_selectName
 
- Data Fields inherited from GridColumn
 $_template
 
 $_title
 
 $_titleTranslated
 
- Data Fields inherited from GridBodyElement
 $_cellProvider
 
 $_flags
 
 $_id
 

Detailed Description

Implements a column with checkboxes to select grid items.

Definition at line 17 of file ItemSelectionGridColumn.inc.php.

Constructor & Destructor Documentation

◆ __construct()

ItemSelectionGridColumn::__construct (   $selectName)

Constructor

Parameters
$selectNamestring The name of the form parameter to which the selected files will be posted.

Definition at line 31 of file ItemSelectionGridColumn.inc.php.

Member Function Documentation

◆ getSelectName()

ItemSelectionGridColumn::getSelectName ( )

Get the select name.

Returns
string

Definition at line 49 of file ItemSelectionGridColumn.inc.php.

References $_selectName.

◆ getTemplateVarsFromRow()

ItemSelectionGridColumn::getTemplateVarsFromRow (   $row)

Method expected by ColumnBasedGridCellProvider to render a cell in this column.

See also
ColumnBasedGridCellProvider::getTemplateVarsFromRowColumn()

Definition at line 63 of file ItemSelectionGridColumn.inc.php.

Field Documentation

◆ $_selectName

string ItemSelectionGridColumn::$_selectName

Definition at line 23 of file ItemSelectionGridColumn.inc.php.

Referenced by getSelectName().


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