JavaScript Editor Javascript validator     Web page editor 


Structures_DataGrid_Renderer_HTMLSortForm -- Multiple fields sorting form rendering driver


This driver renders a form (using HTML_QuickForm) so that the user can select several fields and directions to sort the datagrid by.

Supported operations modes

This driver supports the following operation modes:

Table 62-1. Supported operations modes of this driver

Container Supportyes
Output Bufferingyes
Direct Renderingno
Object Preservingno


This driver accepts the following options:

Table 62-2. Options for this driver

OptionTypeDescriptionDefault Value
buildFooterboolWhether to build the footer.true
buildHeaderboolWhether to build the header.true
defaultCellValuestringWhat value to put by default into empty cells.null
defaultColumnValuesarrayPer-column default cell value. This is an array of the form: array(fieldName => value, ...).array()
directionStylestringWhether to render the direction form elements as 'select' or 'radio' elements'select'
encodingstringThe content encoding. If the mbstring extension is present the default value is set from mb_internal_encoding(), otherwise it is ISO-8859-1.'ISO-8859-1'
excludeVarsarrayVariables to be removed from the generated HTTP queries.array()
extraVarsarrayVariables to be added to the generated HTTP queries.array()
fillWithEmptyRowsboolEnsures that all pages have the same number of rows.false
hideColumnLinksarrayBy default sorting links are enabled on all columns. With this option it is possible to disable sorting links on specific columns. This is an array of the form: array(fieldName, ...). This option only affects drivers that support sorting.array()
numberAlignboolWhether to right-align numeric values.true
onMovestringName of a Javascript function to call on onclick/onsubmit events when the user is either paging or sorting the data. This function receives a single object argument of the form: { page: <page>, sort: [{field: <field>, direction: <direction>}, ...], data: <user_data> }. Remark: setting this option doesn't remove the href attribute, you should return false from your handler function to void it (eg: for AJAX, etc..).null
onMoveDatastringUser data passed in the "data" member of the object argument passed to onMove. No JSON serialization is performed, this is assigned as a raw string to the "data" attribute. It's up to you to add quotes, slashes, etc...''
sortFieldsNumintHow many fields the user will be able to sort by. This has no effect if the backend does not support sorting by multiple fields.3
textAscendingstringLabel for the ASC direction'Ascending'
textChoosestringWhat to display in the select box when no field is selected (first option)'Choose...'
textDescendingstringLabel for the DESC direction'Descending'
textSortBystringLabel for the first field'Sort by:'
textSubmitstringLabel for the submit button'Submit'
textThenBystringLabel for the second and following fields'Then by:'


JavaScript Editor Javascript validator     Web page editor