Class Grid-View-Field

A field class representing a column in the grid
view.

Part of:

package weblocks, class datagrid-select-field, class datagrid-drilldown-field, class table-view-field, class grid-view-field-order-by-mixin

Direct Superclass

grid-view-field-order-by-mixinThis class is used in inline and mixin grid
field for ordering options.
table-view-fieldA field class representing a column in the table
view.

Direct Subclass

datagrid-drilldown-fieldA field used to render drilldown control.
datagrid-select-fieldA field used to render select control.

Slot

allow-sorting-p
If set to true, the field will be allowed to be sorted (and otherwise if set to nil). If this slot is unbound (the default), the value will be obtained from 'grid-view-allow-sorting-p'.
Initargs::allow-sorting-p; Accessors:grid-view-field-allow-sorting-p.
hidep
A predicate that determines whether the field is to be hidden from the user. If set to true, the field will not be rendered.
Initargs::hidep; Accessors:view-field-hide-p.
label
A human readable label that will be used to render the field. By default this value is set to a humanized form of 'slot-name'.
Initargs::label; Accessors:view-field-label.
order-by
If set to a symbol or a list of symbols, this slot will be used to build an order-by path that is later passed to the backend store for ordering the entires of the grid. If this slot is unbound (the default), the 'slot-name' slot of the field will be used instead.
Initargs::order-by; Accessors:grid-view-field-order-by.
prefix-fn
A function called prior to rendering the field. The function should expect the view object, the field object, the object being rendered, and any additional arguments passed to the view.
Initargs::prefix-fn; Accessors:view-field-prefix-fn.
presentationInitform:(make-instance 'text-presentation).
reader
If this slot is bound to a function object, the function will be called with the object being rendered as argument, and its return value will be used as the value of the field. If this slot is not bound to a function object but another value, the value will be used to render the value of the field as a convinience. If the slot is not bound, 'slot-value' will be used.
Initargs::reader; Accessors:view-field-reader.
slot-name
The name of the slot that this field represents. This value can be null, in which case the field does not correspond to any slot.
Initargs::slot-name; Accessors:view-field-slot-name.
suffix-fn
A function called after rendering the field. The function should expect the view object, the field object, the object being rendered, and any additional arguments passed to the view.
Initargs::suffix-fn; Accessors:view-field-suffix-fn.

Direct Method

render-view-field-headerRenders a table header cell.

Other Method

render-view-fieldRenders a given view field. This function should
render appropriate structural markup, and call r...
render-view-field-header-valueRenders a table header cell value.