OpenMediaVault  0.6 (Kralizec)
The open network attached storage solution
 All Classes Functions Variables Groups Pages
OMV::workspace::grid::Panel Class Reference

Detailed Description

This file is part of OpenMediaVault.

License:
http://www.gnu.org/licenses/gpl.html GPL Version 3
Author
Volker Theile volke.nosp@m.r.th.nosp@m.eile@.nosp@m.open.nosp@m.media.nosp@m.vaul.nosp@m.t.org

OpenMediaVault is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

OpenMediaVault is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with OpenMediaVault. If not, see http://www.gnu.org/licenses/.

OMV.grid.Panel An enhanced grid panel. This grid provides 'Add', 'Edit' and 'Delete' buttons in the toolbar by default. The basic delete functionality is also implemented, simply overwrite the 'doDeletion' and 'afterDeletion' functions to implement fit your requirements. To implement the 'Add' and 'Edit' functionality overwrite the 'onAdd' and 'onEdit' callback functions. A paging toolbar which is displayed at the bottom of the grid can be displayed also. It is also possible to reload the grid automatically at a given interval.

Parameters
hideTopToolbarTRUE to hide the toolbar at the top of the grid. Defaults to FALSE.
hidePagingToolbarTRUE to hide the paging toolbar at the bottom of the grid. Defaults to TRUE.
hideAddButtonHide the 'Add' button in the top toolbar. Defaults to FALSE.
hideEditButtonHide the 'Edit' button in the top toolbar. Defaults to FALSE.
hideDeleteButtonHide the 'Delete' button in the top toolbar. Defaults to FALSE.
hideUpButtonHide the 'Up' button in the top toolbar. Defaults to TRUE.
hideDownButtonHide the 'Down' button in the top toolbar. Defaults to TRUE.
hideApplyButtonHide the 'Apply' button in the top toolbar. Defaults to TRUE.
hideRefreshButtonHide the 'Refresh' button in the top toolbar. Defaults to TRUE.
addButtonTextThe button text. Defaults to 'Add'.
editButtonTextThe button text. Defaults to 'Edit'.
deleteButtonTextThe button text. Defaults to 'Delete'.
upButtonTextThe button text. Defaults to 'Up'.
downButtonTextThe button text. Defaults to 'Down'.
applyButtonTextThe button text. Defaults to 'Save'.
refreshButtonTextThe button text. Defaults to 'Refresh'.
deletionConfirmRequiredSet to TRUE to force the user to confirm the deletion request. Defaults to TRUE.
deletionWaitMsgThe message displayed during the deletion process.
modeThe mode how to retrieve the data displayed in the grid panel. This can be 'local' or 'remote' which means the data is requested via RPC. Defaults to 'remote'.
rememberSelectedTRUE to reselect the previous selected rows after the grid content has been reloaded/refreshed. Defaults to FALSE.

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