Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct () | |
addAction ($action, $position=GRID_ACTION_POSITION_DEFAULT) | |
getActions ($position=GRID_ACTION_POSITION_DEFAULT) | |
& | getData () |
getGridId () | |
getIsModified () | |
getRequestArgs () | |
getTemplate () | |
hasActions () | |
initialize ($request, $template=null) | |
setData (&$data) | |
setGridId ($gridId) | |
setIsModified ($isModified) | |
setRequestArgs ($requestArgs) | |
setTemplate ($template) | |
Public Member Functions inherited from GridBodyElement | |
__construct ($id='', $cellProvider=null, $flags=array()) | |
addFlag ($flag, $value=true) | |
getCellProvider () | |
getFlag ($flag) | |
getFlags () | |
getId () | |
hasFlag ($flag) | |
setCellProvider ($cellProvider) | |
setId ($id) | |
Data Fields | |
$_actions = array(GRID_ACTION_POSITION_DEFAULT => array()) | |
$_data | |
$_gridId | |
$_isModified | |
$_requestArgs | |
$_template | |
Data Fields inherited from GridBodyElement | |
$_cellProvider | |
$_flags | |
$_id | |
GridRow implements a row of a Grid. See GridHandler for general information about grids.
Each Grid is populated with data that is displayed in a series of rows. Each row is implemented using a GridRow, which knows how to describe the data it represents, and can present and manage row actions such as Edit and Delete operations.
For general information on grids, see GridHandler.
Definition at line 29 of file GridRow.inc.php.
GridRow::__construct | ( | ) |
GridRow::addAction | ( | $action, | |
$position = GRID_ACTION_POSITION_DEFAULT |
|||
) |
Add an action
$action | mixed a single action |
$position | string the position of the action |
Reimplemented in ListbuilderGridRow.
Definition at line 179 of file GridRow.inc.php.
Referenced by SwordDepositPointsGridRow\initialize(), PLNStatusGridRow\initialize(), CategoryGridRow\initialize(), GenreGridRow\initialize(), NavigationMenusGridRow\initialize(), UserGroupGridRow\initialize(), IssueGridRow\initialize(), ReviewFormElementGridRow\initialize(), SectionGridRow\initialize(), StaticPageGridRow\initialize(), SubmissionChecklistGridRow\initialize(), CustomBlockGridRow\initialize(), NavigationMenuItemsGridRow\initialize(), AnnouncementTypeGridRow\initialize(), ReviewFormGridRow\initialize(), LanguageGridRow\initialize(), SubscriptionTypesGridRow\initialize(), CategoryGridCategoryRow\initialize(), SubscriptionsGridRow\initialize(), ContextGridRow\initialize(), IssueGalleyGridRow\initialize(), TocGridRow\initialize(), UserGridRow\initialize(), PluginGridRow\initialize(), ReviewerGridRow\initialize(), QueriesGridRow\initialize(), EventLogGridRow\initialize(), StageParticipantGridRow\initialize(), ArticleGalleyGridRow\initialize(), QueryNotesGridRow\initialize(), AuthorGridRow\initialize(), LibraryFileGridRow\initialize(), and SubmissionFilesGridRow\initialize().
GridRow::getActions | ( | $position = GRID_ACTION_POSITION_DEFAULT | ) |
Get all actions for a given position within the controller
$position | string the position of the actions |
Definition at line 169 of file GridRow.inc.php.
& GridRow::getData | ( | ) |
Get the data element(s) for this controller
Definition at line 131 of file GridRow.inc.php.
References $_data.
Referenced by SelectableSubmissionFileListCategoryGridRow\getCategoryLabel(), PluginCategoryGridRow\getCategoryLabel(), TocGridCategoryRow\getCategoryLabel(), StageParticipantGridCategoryRow\getCategoryLabel(), CategoryGridRow\initialize(), IssueGridRow\initialize(), NavigationMenuItemsGridRow\initialize(), NavigationMenusGridRow\initialize(), UserGroupGridRow\initialize(), AnnouncementTypeGridRow\initialize(), ReviewFormGridRow\initialize(), LanguageGridRow\initialize(), ContextGridRow\initialize(), SubscriptionsGridRow\initialize(), SubscriptionTypesGridRow\initialize(), CategoryGridCategoryRow\initialize(), IssueGalleyGridRow\initialize(), UserGridRow\initialize(), ReviewerGridRow\initialize(), PluginGridRow\initialize(), StageParticipantGridRow\initialize(), EventLogGridRow\initialize(), LibraryFileGridCategoryRow\initialize(), ArticleGalleyGridRow\initialize(), and SubmissionFilesGridRow\initialize().
GridRow::getGridId | ( | ) |
Get the grid id
Definition at line 97 of file GridRow.inc.php.
References $_gridId.
Referenced by GenreGridRow\initialize(), SubmissionChecklistGridRow\initialize(), LanguageGridRow\initialize(), SubscriptionsGridRow\initialize(), SubscriptionTypesGridRow\initialize(), and UserGridRow\initialize().
GridRow::getIsModified | ( | ) |
Get the modified flag for the row
Definition at line 147 of file GridRow.inc.php.
References $_isModified.
GridRow::getRequestArgs | ( | ) |
Get the grid request parameters.
Reimplemented in StageParticipantGridRow, AuthorGridRow, ArticleGalleyGridRow, QueriesGridRow, and QueryNotesGridRow.
Definition at line 115 of file GridRow.inc.php.
References $_requestArgs.
Referenced by IssueGalleyGridRow\__construct(), CategoryGridRow\initialize(), SubscriptionTypesGridRow\initialize(), SubscriptionsGridRow\initialize(), IssueGalleyGridRow\initialize(), and UserGridRow\initialize().
GridRow::getTemplate | ( | ) |
Get the row template - override base implementation to provide a sensible default.
Definition at line 189 of file GridRow.inc.php.
References $_template.
GridRow::hasActions | ( | ) |
Get whether this row has any actions or not.
Definition at line 155 of file GridRow.inc.php.
GridRow::initialize | ( | $request, | |
$template = null |
|||
) |
Initialize a row instance.
Subclasses can override this method.
$request | PKPRequest |
$template | string |
Reimplemented in LibraryFileGridRow, AuthorGridRow, QueryNotesGridRow, ArticleGalleyGridRow, EventLogGridRow, LibraryFileGridCategoryRow, StageParticipantGridRow, QueriesGridRow, PluginGridRow, ReviewerGridRow, TocGridRow, UserGridRow, IssueGalleyGridRow, SubscriptionsGridRow, SubscriptionTypesGridRow, ContextGridRow, CategoryGridCategoryRow, AnnouncementTypeGridRow, LanguageGridRow, ReviewFormGridRow, IssueGridRow, SectionGridRow, NavigationMenuItemsGridRow, NavigationMenusGridRow, GenreGridRow, ReviewFormElementGridRow, UserGroupGridRow, SubmissionChecklistGridRow, AuthorReviewerGridRow, CustomBlockGridRow, StaticPageGridRow, CategoryGridRow, PLNStatusGridRow, SwordDepositPointsGridRow, ListbuilderGridRow, and SubmissionFilesGridRow.
Definition at line 212 of file GridRow.inc.php.
References setTemplate().
GridRow::setData | ( | & | $data | ) |
Set the data element(s) for this controller
$data | mixed |
Definition at line 123 of file GridRow.inc.php.
GridRow::setGridId | ( | $gridId | ) |
GridRow::setIsModified | ( | $isModified | ) |
Set the modified flag for the row
$isModified | boolean |
Definition at line 139 of file GridRow.inc.php.
GridRow::setRequestArgs | ( | $requestArgs | ) |
Set the grid request parameters.
$requestArgs | array |
Definition at line 106 of file GridRow.inc.php.
Referenced by IssueGalleyGridRow\__construct(), and UserGroupGridRow\initialize().
GridRow::setTemplate | ( | $template | ) |
Set the controller template
$template | string |
Definition at line 197 of file GridRow.inc.php.
Referenced by ListbuilderGridRow\initialize(), and initialize().
array GridRow::$_actions = array(GRID_ACTION_POSITION_DEFAULT => array()) |
row actions, the first key represents the position of the action in the row template, the second key represents the action id.
Definition at line 63 of file GridRow.inc.php.
mixed GridRow::$_data |
the GridRow::$_gridId |
boolean GridRow::$_isModified |
true if the row has been modified
Definition at line 53 of file GridRow.inc.php.
Referenced by getIsModified().
array GridRow::$_requestArgs |
Definition at line 35 of file GridRow.inc.php.
Referenced by getRequestArgs().
string GridRow::$_template |