Open Journal Systems  3.3.0
GridColumn.inc.php
1 <?php
2 
21 define('COLUMN_ALIGNMENT_LEFT', 'left');
22 define('COLUMN_ALIGNMENT_CENTER', 'center');
23 define('COLUMN_ALIGNMENT_RIGHT', 'right');
24 
25 import('lib.pkp.classes.controllers.grid.GridBodyElement');
26 
27 class GridColumn extends GridBodyElement {
29  var $_title;
30 
33 
35  var $_template;
36 
46  function __construct($id = '', $title = null, $titleTranslated = null,
47  $template = null, $cellProvider = null, $flags = array()) {
48 
49  // Use default template if none specified
50  if ($template === null) $template = 'controllers/grid/gridCell.tpl';
51 
52  parent::__construct($id, $cellProvider, $flags);
53 
54  $this->_title = $title;
55  $this->_titleTranslated = $titleTranslated;
56  $this->_template = $template;
57  }
58 
59  //
60  // Setters/Getters
61  //
66  function getTitle() {
67  return $this->_title;
68  }
69 
74  function setTitle($title) {
75  $this->_title = $title;
76  }
77 
82  function setTitleTranslated($titleTranslated) {
83  $this->_titleTranslated = $titleTranslated;
84  }
85 
90  function getLocalizedTitle() {
91  if ( $this->_titleTranslated ) return $this->_titleTranslated;
92  return __($this->_title);
93  }
94 
99  function getTemplate() {
100  return $this->_template;
101  }
102 
107  function setTemplate($template) {
108  $this->_template = $template;
109  }
110 
114  function getCellProvider() {
115  if (is_null(parent::getCellProvider())) {
116  // provide a sensible default cell provider
117  import('lib.pkp.classes.controllers.grid.ArrayGridCellProvider');
118  $cellProvider = new ArrayGridCellProvider();
119  $this->setCellProvider($cellProvider);
120  }
121 
122  return parent::getCellProvider();
123  }
124 
136  function getCellActions($request, $row, $position = GRID_ACTION_POSITION_DEFAULT) {
137  // The default implementation returns an empty array
138  return array();
139  }
140 }
141 
142 
GridColumn\setTitle
setTitle($title)
Definition: GridColumn.inc.php:83
GridColumn
The GridColumn class represents a column within a grid. It is used to format the data presented in a ...
Definition: GridColumn.inc.php:27
GridColumn\$_title
$_title
Definition: GridColumn.inc.php:32
GridColumn\__construct
__construct($id='', $title=null, $titleTranslated=null, $template=null, $cellProvider=null, $flags=array())
Definition: GridColumn.inc.php:55
GridColumn\getCellProvider
getCellProvider()
Definition: GridColumn.inc.php:123
GridColumn\getTitle
getTitle()
Definition: GridColumn.inc.php:75
GridColumn\$_titleTranslated
$_titleTranslated
Definition: GridColumn.inc.php:38
GridColumn\$_template
$_template
Definition: GridColumn.inc.php:44
GridColumn\getTemplate
getTemplate()
Definition: GridColumn.inc.php:108
GridBodyElement\setCellProvider
setCellProvider($cellProvider)
Definition: GridBodyElement.inc.php:118
GridColumn\setTemplate
setTemplate($template)
Definition: GridColumn.inc.php:116
GridColumn\getCellActions
getCellActions($request, $row, $position=GRID_ACTION_POSITION_DEFAULT)
Definition: GridColumn.inc.php:145
ArrayGridCellProvider
Base class for a cell provider that can retrieve labels from arrays.
Definition: ArrayGridCellProvider.inc.php:18
GridColumn\getLocalizedTitle
getLocalizedTitle()
Definition: GridColumn.inc.php:99
GridBodyElement
Base class for grid body elements.
Definition: GridBodyElement.inc.php:16
GridColumn\setTitleTranslated
setTitleTranslated($titleTranslated)
Definition: GridColumn.inc.php:91