Public Member Functions | |
| __construct ($id='', $cellProvider=null, $flags=array()) | |
| addFlag ($flag, $value=true) | |
| getCellProvider () | |
| getFlag ($flag) | |
| getFlags () | |
| getId () | |
| hasFlag ($flag) | |
| setCellProvider ($cellProvider) | |
| setId ($id) | |
Data Fields | |
| $_cellProvider | |
| $_flags | |
| $_id | |
Detailed Description
Base class for grid body elements.
Definition at line 16 of file GridBodyElement.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| GridBodyElement::__construct | ( | $id = '', |
|
$cellProvider = null, |
|||
$flags = array() |
|||
| ) |
Constructor
Reimplemented in QueriesGridRow, StageParticipantGridRow, AuthorGridRow, ChapterGridCategoryRow, FileNameGridColumn, and QueryNotesGridRow.
Definition at line 44 of file GridBodyElement.inc.php.
Member Function Documentation
◆ addFlag()
| GridBodyElement::addFlag | ( | $flag, | |
$value = true |
|||
| ) |
Add a layout flag
- Parameters
-
$flag string $value mixed optional
Definition at line 102 of file GridBodyElement.inc.php.
◆ getCellProvider()
| GridBodyElement::getCellProvider | ( | ) |
Get the cell provider
- Returns
- GridCellProvider
Reimplemented in GridColumn.
Definition at line 110 of file GridBodyElement.inc.php.
References $_cellProvider.
◆ getFlag()
| GridBodyElement::getFlag | ( | $flag | ) |
Get a single layout flag
- Parameters
-
$flag string
- Returns
- mixed
Definition at line 82 of file GridBodyElement.inc.php.
◆ getFlags()
| GridBodyElement::getFlags | ( | ) |
Get all layout flags
- Returns
- array
Definition at line 73 of file GridBodyElement.inc.php.
References $_flags.
◆ getId()
| GridBodyElement::getId | ( | ) |
Get the element id
- Returns
- string
Definition at line 57 of file GridBodyElement.inc.php.
References $_id.
Referenced by StageParticipantGridRow\getRequestArgs(), CategoryGridRow\initialize(), ReviewFormElementGridRow\initialize(), SubmissionChecklistGridRow\initialize(), GenreGridRow\initialize(), NavigationMenuItemsGridRow\initialize(), StaticPageGridRow\initialize(), CustomBlockGridRow\initialize(), NavigationMenusGridRow\initialize(), UserGroupGridRow\initialize(), AnnouncementTypeGridRow\initialize(), LanguageGridRow\initialize(), ReviewFormGridRow\initialize(), ContextGridRow\initialize(), CategoryGridCategoryRow\initialize(), SeriesGridRow\initialize(), UserGridRow\initialize(), PluginGridRow\initialize(), ReviewerGridRow\initialize(), QueriesGridRow\initialize(), StageParticipantGridRow\initialize(), QueryNotesGridRow\initialize(), AuthorGridRow\initialize(), ChapterGridCategoryRow\initialize(), and LibraryFileGridRow\initialize().
◆ hasFlag()
| GridBodyElement::hasFlag | ( | $flag | ) |
Check whether a layout flag is set to true.
- Parameters
-
$flag string
- Returns
- boolean
Definition at line 92 of file GridBodyElement.inc.php.
◆ setCellProvider()
| GridBodyElement::setCellProvider | ( | $cellProvider | ) |
Set the cell provider
- Parameters
-
$cellProvider GridCellProvider
Definition at line 118 of file GridBodyElement.inc.php.
Referenced by GridCategoryRow\__construct(), PublicationFormatGridCategoryRow\__construct(), and GridColumn\getCellProvider().
◆ setId()
| GridBodyElement::setId | ( | $id | ) |
Set the element id
- Parameters
-
$id string
Definition at line 65 of file GridBodyElement.inc.php.
Referenced by LibraryFileGridCategoryRow\initialize().
Field Documentation
◆ $_cellProvider
| GridCellProvider GridBodyElement::$_cellProvider |
a cell provider for cells inside this element
Definition at line 39 of file GridBodyElement.inc.php.
Referenced by getCellProvider().
◆ $_flags
| array GridBodyElement::$_flags |
flags that can be set by the handler to trigger layout options in the element or in cells inside of it.
Definition at line 33 of file GridBodyElement.inc.php.
Referenced by getFlags().
◆ $_id
| string GridBodyElement::$_id |
identifier of the element instance - must be unique among all instances within a grid.
Definition at line 24 of file GridBodyElement.inc.php.
Referenced by getId().
The documentation for this class was generated from the following file:
