Class Quickform

A widget based on dataform designed to quickly
present forms. Use 'make-quickform' for easy configuration.

Part of:

package weblocks, class dataform

Direct Superclass

dataformA class that represents a dataform widget. By default this widget
renders the data object with a ...

Slot

allow-close-p
If set to true (the default), and 'on-close' isn't nil, renders a close button.
Initform:t, Initargs::allow-close-p; Accessors:dataform-allow-close-p.
class-store
Store where user data is being kept.
Initargs::class-store; Reader:login-class-store.
continuation
Stores the continuation object for widgets that were invoked via one of the do-* functions ('do-page', etc.). When 'answer' is called on a widget, this value is used to resume the computation.
Accessors:widget-continuation.
data
A data object to hold the registration information. Must match the view if provied. If not provided, a CLOS object will be generated holding the values of the input fields in the view in the corresponding slots.
Initargs::data; Reader:login-data.
data-view
View object used to render 'data' object into information view. If 'data-view' isn't provided, the scaffold view will be used by default.
Initargs::data-view; Accessors:dataform-data-view.
dom-class
The DOM class (CSS class) of an object. Set this to a string if you'd like to add an additional CSS class to the ones generated from the class hierarchy by default.
Initargs::dom-class; Accessors:dom-class.
dom-id
The DOM id of an object. Can be a symbol, a string or nil. When accessed through the 'dom-id' accessor, will always become a string. Use ensure-dom-id or widget-name (for widgets) to access its underlying implementation.
Initargs::dom-id.
form-view
View object used to render 'data' object into form view. If 'form-view' isn't provided, the scaffold view will be used by default.
Initargs::form-view; Accessors:dataform-form-view.
intermediate-form-values
If user enters form values and validation fails, these values are stored in this variable so the form isn't lost while the user fixes errors.
on-cancel
A function that accepts one paramets: a registration widget. It is called when the registration was cancelled.
Initargs::on-cancel; Accessors:login-on-cancel.
on-close
An optional callback function with one argument (the dataform widget). Called when the user clicks on the close button. Note that the close button is only rendered if 'allow-close-p' is true.
Initargs::on-close; Accessors:dataform-on-close.
on-success
A function that accepts two paramets: a registration widget and a CLOS object that contains information obtained from the user. It is called when the registration was successful.
Initargs::on-success; Accessors:login-on-success.
propagate-dirty
A list of widget paths (see 'find-widget-by-path') or widgets each of which will be made dirty when this widget is made dirty via a POST request. This slot allows setting up dependencies between widgets that will make multiple widgets update automatically during AJAX requests.
Initargs::propagate-dirty; Accessors:widget-propagate-dirty.
renderedp
This slot holds a boolean flag indicating whether the widget has been rendered at least once. Because marking unrendered widgets as dirty may cause JS problems, 'mark-dirty' will use this flag to determine the status of a widget.
Accessors:widget-rendered-p.
ui-state
A state of the dataedit control. The values of this slot may differ depending on concrete implementation of dataedit. Generally NIL means normal state, :add means render a widget to add a new item, and :drilldown means drill down on an existing item.
Initargs::ui-state; Accessors:dataedit-ui-state.
validation-errors
An association list of slot names and validation errors that occurred during the previous form submission.
widget-prefix-fn
A function called prior to rendering the widget body. The function should expect the widget as well as any additional arguments passed to the widget.
Initargs::widget-prefix-fn; Accessors:widget-prefix-fn.
widget-suffix-fn
A function called after rendering the widget body. The function should expect the widget as well as any additional arguments passed to the widget.
Initargs::widget-suffix-fn; Accessors:widget-suffix-fn.

Direct Method

dataform-submit-actionCalled when the user invokes a submit action on a dataform
widget. The default implementation upd...
per-class-dependenciesReturn a list of dependencies for an object of a
particular class. For widgets, this method is ...

Other Method

composite-widgets
dataedit-item-widget-dataReturns the item held by the dataedit-item-widget.
dataform-data-view
dataform-form-view
dom-classesReturns a string that represents all applicable CSS
classes for an object (usually a widget). Nor...
dom-idProvides a consistent interface to identifying widgets
by their DOM id. Returns a string or nil i...
ensure-dom-idEnsure that the object has a 'dom-id' and return
it. 'dom-id' is lazily generated on first read...
find-widget-by-path*Returns a widget object located at 'path', where 'path' is a list
of widget names starting from r...
mark-dirtyDefault implementation adds a widget to a list of dirty
widgets. Normally used during an AJAX req...
render-dataformRenders the dataform widget in its current state. Normally called
by 'render-widget-body'. Overri...
render-dataform-dataRenders the dataform widget when it's in ':data'
state. Normally called by 'render-dataform'. Ove...
render-dataform-data-buttonsRender the buttons and links appearing with the
data view on a dataform.
render-dataform-formRenders the dataform widget when it's in ':form'
state. Normally called by 'render-dataform'. Ove...
render-widget-bodyA generic function that renders a widget in its current state. In
order to actually render the wi...
setfdom-id
setfwidget-name
setfwidget-parent
widget-nameAn interface to the DOM id of a widget. Provides
access to the underlying implementation, can r...