Class Sequence-View-Field

An abstract view field class representing a slot of
an item in a sequence of items. This class should be subclassed by
view fields for views that represent sequences of data.

Part of:

package weblocks, class inline-view-field, class table-view-field, class view-field-sorting-mixin

Direct Superclass

inline-view-fieldInline fields are fields that are rendered as part
of the view.
view-field-sorting-mixinThis is a class that can be mixed into field
definitions in order to provide functionality nece...

Direct Subclass

table-view-fieldA field class representing a column in the table
view.

Slot

allow-sorting-p
If set to true (default), the field will be allowed to be sorted.
Initform:t, Initargs::allow-sorting-p; Accessors:view-field-sorting-mixin-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 sequence. If this slot is unbound (the default), the 'slot-name' slot of the field will be used instead.
Initargs::order-by; Accessors:view-field-sorting-mixin-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.

Other Method

dependenciesReturn a list of dependencies for a particular
object.

Whenever a widget is rendered by webl...