Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct ($overrideRowTemplate, $nonOrderableItemMessage=null) | |
addRowOrderAction ($row) | |
fetchUIElements ($request, $grid) | |
getInitializedRowInstance ($args) | |
getNonOrderableItemMessage () | |
getOverrideRowTemplate (&$gridRow) | |
gridInitialize ($args) | |
isOrderActionNecessary () | |
setNonOrderableItemMessage ($nonOrderableItemMessage) | |
setOptions ($request, $grid) | |
setOverrideRowTemplate ($overrideRowTemplate) | |
Public Member Functions inherited from GridFeature | |
__construct ($id) | |
addOptions ($options) | |
fetchGrid ($args) | |
fetchRow ($args) | |
fetchRows ($args) | |
getGridDataElements ($args) | |
getGridRangeInfo ($args) | |
getId () | |
getInitializedCategoryRowInstance ($args) | |
getJSClass () | |
getOptions () | |
getRequestArgs ($args) | |
loadData ($args) | |
saveSequence ($args) | |
setGridDataElements ($args) | |
setId ($id) | |
Data Fields | |
$_nonOrderableItemMessage | |
$_overrideRowTemplate | |
Data Fields inherited from GridFeature | |
$_id | |
$_options | |
Base class for grid widgets ordering functionality.
Definition at line 19 of file OrderItemsFeature.inc.php.
OrderItemsFeature::__construct | ( | $overrideRowTemplate, | |
$nonOrderableItemMessage = null |
|||
) |
Constructor.
$overrideRowTemplate | boolean This feature uses row actions and it will force the usage of the gridRow.tpl. If you want to use a different grid row template file, set this flag to false and make sure to use a template file that adds row actions. |
$nonOrderableItemMessage | string optional A translated message to be used when user tries to move a non orderable grid item. |
Reimplemented in OrderGridItemsFeature.
Definition at line 41 of file OrderItemsFeature.inc.php.
References setNonOrderableItemMessage(), and setOverrideRowTemplate().
OrderItemsFeature::addRowOrderAction | ( | $row | ) |
Add grid row order action.
$row | GridRow |
$actionPosition | int |
$rowTemplate | string |
Definition at line 169 of file OrderItemsFeature.inc.php.
References getOverrideRowTemplate().
Referenced by OrderCategoryGridItemsFeature\getInitializedCategoryRowInstance(), and getInitializedRowInstance().
OrderItemsFeature::fetchUIElements | ( | $request, | |
$grid | |||
) |
Reimplemented from GridFeature.
Definition at line 110 of file OrderItemsFeature.inc.php.
References PKPTemplateManager\getManager(), getNonOrderableItemMessage(), and isOrderActionNecessary().
OrderItemsFeature::getInitializedRowInstance | ( | $args | ) |
Reimplemented from GridFeature.
Reimplemented in OrderCategoryGridItemsFeature.
Definition at line 133 of file OrderItemsFeature.inc.php.
References addRowOrderAction().
OrderItemsFeature::getNonOrderableItemMessage | ( | ) |
Get non orderable item message.
Definition at line 87 of file OrderItemsFeature.inc.php.
References $_nonOrderableItemMessage.
Referenced by fetchUIElements().
OrderItemsFeature::getOverrideRowTemplate | ( | & | $gridRow | ) |
Get override row template flag.
$gridRow | GridRow |
Definition at line 65 of file OrderItemsFeature.inc.php.
References $_overrideRowTemplate.
Referenced by addRowOrderAction().
OrderItemsFeature::gridInitialize | ( | $args | ) |
Reimplemented from GridFeature.
Definition at line 143 of file OrderItemsFeature.inc.php.
References isOrderActionNecessary().
OrderItemsFeature::isOrderActionNecessary | ( | ) |
Return if this feature will use a grid level order action. Default is true, override it if needed.
Definition at line 194 of file OrderItemsFeature.inc.php.
Referenced by fetchUIElements(), and gridInitialize().
OrderItemsFeature::setNonOrderableItemMessage | ( | $nonOrderableItemMessage | ) |
Set non orderable item message.
$nonOrderableItemMessage | string Message already translated. |
Definition at line 79 of file OrderItemsFeature.inc.php.
Referenced by __construct().
OrderItemsFeature::setOptions | ( | $request, | |
$grid | |||
) |
Reimplemented from GridFeature.
Definition at line 98 of file OrderItemsFeature.inc.php.
References GridFeature\addOptions().
OrderItemsFeature::setOverrideRowTemplate | ( | $overrideRowTemplate | ) |
Set override row template flag.
$customRowTemplate | boolean |
Definition at line 56 of file OrderItemsFeature.inc.php.
Referenced by __construct().
string OrderItemsFeature::$_nonOrderableItemMessage |
Definition at line 30 of file OrderItemsFeature.inc.php.
Referenced by getNonOrderableItemMessage().
boolean OrderItemsFeature::$_overrideRowTemplate |
Definition at line 24 of file OrderItemsFeature.inc.php.
Referenced by getOverrideRowTemplate().