tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

MINOR: Updated GridField documentation

Browse Source
This commit is contained in:
Andrew O'Neil 2012-03-12 10:49:31 +13:00 committed by Ingo Schommer
parent a73c8bcbf0
commit 24815ce020
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/en/topics/grid-field.md
View File

@ -101,17 +101,21 @@ This component will add a header to the grid with sort buttons. It will detect
### GridFieldFilterHeader ### GridFieldFilterHeader
This component will add a header row with a text field filter for each column, letting you filter the results with text searches. It will detect which columns are filterable and only provide sort controls on those columns. This component will add a header row with a text field filter for each column, letting you filter the results with text searches. It will detect which columns are filterable and only provide filter controls on those columns.
### GridFieldPaginator ### GridFieldPaginator
This component will limit output to a fixed number of items per page add a footer row with pagination controls. The constructor takes 1 argument: the number of items per page. This component will limit output to a fixed number of items per page add a footer row with pagination controls. The constructor takes 1 argument: the number of items per page.
### GridFieldAction ### GridFieldDeleteButton
TODO Describe component, including GridFieldEditButton/GridFieldDeleteAction TODO Describe component
### GridFieldAddExistingAutocompleter ### GridFieldEditButton
Adds a edit button to each row of the table. This needs another component to provide an edit interface - see GridFieldDetailForm for use within the CMS.
### GridFieldRelationAdd
This class is is responsible for adding objects to another object's has_many and many_many relation, This class is is responsible for adding objects to another object's has_many and many_many relation,
as defined by the `[api:RelationList]` passed to the GridField constructor. as defined by the `[api:RelationList]` passed to the GridField constructor.
@ -130,15 +134,17 @@ Often used alongside `[api:GridFieldAddExistingAutocompleter]` to add existing r
### GridFieldDetailForm ### GridFieldDetailForm
TODO Describe component, including how it relates to GridFieldEditButton. Point to GridFieldConfig_RelationEditor for easier defaults. Provides add and edit forms for use within the CMS. This allows editing of the linked records.
This only provides the actual add/edit forms, GridFieldEditButton is required to provide a button to link to the edit form,
and GridFieldToolbarHeader is required to provide an add button.
### GridFieldToolbarHeader ### GridFieldToolbarHeader
TODO Adds a title bar to the top of the GridField, with optional "New" button. The New button doesn't provide any functionality with this component alone - see GridFieldDetailForm.
### GridFieldExportButton ### GridFieldExportButton
TODO Adds an "Download as CSV" button. This will save the current List shown in the GridField as CSV. Takes the
## Extending GridField with custom components ## Extending GridField with custom components