| checkbox-presentation | Treats values as predicates and presents them as a checkbox. |
|---|---|
| choices-presentation-mixin | |
| composite | A composite widget is simply a container for other widgets. The 'widgets' slot accessible with ... |
| data-scaffold | Data scaffold. |
| data-view | A view designed to present data to the user. |
| data-view-field | A field class of the data view. |
| dataform | A class that represents a dataform widget. By default this widget renders the data object with a ... |
| datagrid | Represents a sortable, pagable table. This widget is inspired by ASP.NET's datagrid control. |
| datagrid-drilldown-field | A field used to render drilldown control. |
| dropdown-presentation | |
| excerpt-presentation | Presents a large amount of text as an HTML paragraph. |
| flash | A widget that allows displaying a message that disappears on the following request. It is usefu... |
| form-presentation | A base class for all presentations that output form constructs. All form presentations should d... |
| form-scaffold | Form scaffold. |
| form-view | A view designed to interact with the user via input forms. |
| form-view-field | A field class of the form view. |
| form-view-field-writer-mixin | A writer slot mixin |
| grid-scaffold | Grid scaffold. |
| grid-view | A view designed to present sequences of object in a grid to the user. This view inherits from t... |
| grid-view-field | A field class representing a column in the grid view. |
| grid-view-field-order-by-mixin | This class is used in inline and mixin grid field for ordering options. |
| gridedit | A widget based on the 'datagrid' that enhances it with user interface to add, remove, and modif... |
| inline-view-field | Inline fields are fields that are rendered as part of the view. |
| input-presentation | A default presentation for forms renders an input field. |
| integer-parser | A parser designed to parse strings into integers. |
| keyword-parser | A parser designed to parse strings into keywords. |
| mixin-form-view-field | A field class of the form view. |
| mixin-view-field | Mixin fields render a field with another view. |
| navigation | The navigation widget can act as a menu controls, a tabbed control, etc. It contains a list of ... |
| object-id-parser | A parser designed to convert an object id into an object instance. |
| pagination | The pagination widget can be used to provide UI to break up large amount of data into pages. |
| paragraph-presentation | Presents a large amount of text as an HTML paragraph. |
| parser | |
| password-presentation | A presentation for passwords. |
| predicate-parser | A parser designed to parse strings into predicates. |
| predicate-presentation | A default presentation that renders values as predicates, where nil is treated as false, and an... |
| radio-presentation | |
| scaffold | Base class to be used for scaffolds. |
| symbol-parser | A parser designed to parse strings into symbols. |
| table-scaffold | Table scaffold. |
| table-view | A view designed to present sequences of object in a table to the user. |
| table-view-field | A field class representing a column in the table view. |
| text-parser | A default parser for forms. Simply returns strings obtained from the request. |
| text-presentation | A default presentation that renders values as text. |
| textarea-presentation | Present values in a text area HTML control. |
| us-state-parser | A parser designed to parse strings into a US state. |
| us-state-presentation | |
| view | A meta description of the user interface. |
| view-field | Contains a meta description of a given field in the view. |
| widget | Base class for all widget objects. |
| widget-class | A metaclass used for all widget classes. A custom metaclass is necessary to specialize 'slot-... |
| *application-public-dependencies* | A list of dependencies on scripts and/or stylesheets that will persist throughout the whole appli... |
|---|---|
| *cancel-control-name* | The name of the control responsible for cancellation of form submission. |
| *current-navigation-url* | Always contains a navigation URL at the given point in rendering cycle. This is a special variabl... |
| *custom-view-field-argument-compilers* | A hash map of keywords, each mapped to a compilation function. When a keyword is encountered ... |
| *default-cascade-delete-mixins-p* | Default value for 'gridedit-cascade-delete-mixins-p'. See its documentation for more details. |
| *default-store* | The default store to which objects are persisted. |
| *dropdown-welcome-message* | A welcome message used by dropdowns as the first entry. |
| *form-default-error-summary-threshold* | When the number of fields in a form is longer than this threshold, an error summary is rendered a... |
| *invalid-input-message* | This message will be passed to 'format' along with the humanized name of the field and humanized ... |
| *isearch-input-delay* | Delay in seconds after keystrokes a client should wait before it sends an isearch request. |
| *isearch-max-input-length* | Maximum input length allowed in an isearch. |
| *max-password-length* | Default maximum for the length of the password field |
| *max-raw-input-length* | Default maximum allowed input length for input fields. |
| *max-textarea-input-length* | Maximum number of characters that can be entered before the server complains. |
| *pagination-items-per-page* | Default number of items visible on a page. |
| *public-files-path* | Must be set to a directory on the filesystem that contains public files that should be available ... |
| *render-empty-sequence-string* | The default string used by the table view to signify that there is no information available. |
| *required-field-message* | This message will be passed to 'format' along with the humanized name of the field to inform user... |
| *submit-control-name* | The name of the control responsible for form submission. |
| *text-data-cutoff-threshold* | In the excerpt mode, the number of characters to be rendered before the text is cut off and an el... |
| *textarea-cols* | Default number of columns rendered in textarea |
| *textarea-rows* | Default number of rows rendered in textarea |
| *us-states* | A alist of us state names and their abbreviations. |
| *use-suggest-for-us-states* | If true, suggest snippet will be used to render us-state types in forms. A simple dropdown will b... |
| *webapp-description* | The description of the web application. Please note, this description will be used for the compos... |
| *weblocks-output-stream* | Output stream for Weblocks framework created for each request and available to code executed with... |
| add-get-param-to-url | Based on Edi's code in URL-REWRITE but uses & instead of & which is more appropriate for our ... |
|---|---|
| ajax-request-p | Detects if the current request was initiated via AJAX by looking for 'X-Requested-With' http head... |
| alist->plist | Converts an alist to plist. |
| answer | Returns control to location saved in 'continuation', which may be a callee widget or the continua... |
| append-custom-fields | Appends 'custom-fields' to the end of custom fields that are already defined in 'args'. |
| articlize | Prepends a word with a proper indefinite article. Returns 'an apple' for 'apple' and 'a table' fo... |
| asdf-system-directory | Computes the directory in which the .asdf file for a given ASDF system resides. |
| attributize-presentation | Attributizes presentation name. |
| class-visible-slots | Converts 'cls' to class object if it is a name, and calls 'class-visible-slots-impl'. |
| compute-public-files-path | Computes the directory of public files. The function uses the following protocol: it finds the ca... |
| consonantp | Checks if a character is a consonant. |
| count-view-fields | Counts the number of fields in a given view. |
| current-pane-widget | Accepts a navigation object and returns the widget that represents its currently selected pane. |
| datagrid-clear-selection | Clears selected items. |
| datagrid-data | Returns the items in the grid. If 'datagrid-on-query' is not nil, calls the function designated b... |
| datagrid-data-count | Returns the number of items in the grid. This function works similarly to datagrid-data in princi... |
| datagrid-item-selected-p | Checks if an item in the datagrid is marked as selected. |
| datagrid-select-item | Marks an item in the datagrid as selected. |
| datagrid-selection-empty-p | Returns true if no items are selected, nil otherwise. 'selection-or-grid' should either be a data... |
| datagrid-sort-direction | The current sort direction in a given datagrid. |
| datagrid-sort-path | The current sort path in a given datagrid. |
| datagrid-sort-slot | The current sort slot in a given datagrid. |
| defwebapp | Sets the application name (the *webapp-name* variable). 'name' must be a symbol. This symbol will... |
| do-choice | |
| do-confirmation | |
| do-dialog | |
| do-information | |
| do-modal | |
| do-page | |
| drop-last | Returns a copy of the list without the last element. |
| entity-class-name | A helper function that generates a class name from an entity name and a suffix. |
| field-info-field | |
| field-info-object | |
| find-slot-dsd | Returns a direct-slot-definition object of a slot with 'slot-name' in 'class'. |
| find-slot-esd | Returns an effective-slot-definition object of a slot with 'slot-name' in 'class'. |
| find-view | Finds a view. If 'view' is a symbol, looks up the appropriate view object. If 'view' is a view ob... |
| find-widget-by-path | |
| flash-message | Add a 'msg' to a list of messages to show on this request in the 'flash' object. |
| form-field-intermediate-value | Returns an intermediate value for 'slot-name' from 'intermediate-values'. The second value is tru... |
| get-object-view-fields | Returns a list of 'field-info' structures. If 'include-invisible-p' is set to true, fields declar... |
| gridedit-delete-items | |
| gridedit-reset-state | Resets the state of the gridedit. This function should be used by 'gridedit-create-new-item-widge... |
| hash-keys | Returns all keys in the hashtable. |
| highlight-regex-matches | This function highlights regex matches in text by wrapping them in HTML 'string' tag. The complex... |
| init-navigation | A helper function to create a navigation widget ex: (init-navigation “test1” (make-instance ... |
| initial-request-p | Returns true if the request is the first request for the session. |
| insert-after | Destructively inserts 'newelt' into 'list' after 'index'. |
| inspect-typespec | Converts 'typespec' into a representation suitable for further inspection. Returns two values. Th... |
| intersperse | Intersperses a list with a delimeter. If 'last' is specified, it will be used for the last delim... |
| make-action | Coverts a function into an action that can be rendered into HTML. A unique, hard to guess string ... |
| make-action-url | Accepts action code and returns a URL that can be used to render the action. Used, among others, ... |
| make-isearch-regex | Create a regular expression from the user's input that tries to be faithful to Emacs' isearch. |
| make-navigation | Instantiates 'navigation' widget via 'make-instance' and forwards it along with 'args' to 'init-n... |
| make-slot-writer | Returns a function that accepts a value and object and stores the value transformed by 'slot-read... |
| map-mixin-fields | |
| map-view-fields | Acts like mapcar for view fields. FN should expect a structure of type field-info. |
| mapstores | Maps a function over existing stores in the order in which they were defined. Returns NIL. |
| ninsert | |
| object-id-slot-name | Returns the slot name of the slot that holds the unique identifier of 'obj'. This information is ... |
| object-store | Returns the store for the object by calling 'class-store'. |
| obtain-presentation-choices | Accepts a 'choices-presentation-mixin' and an object being rendered and returns a list as specifi... |
| obtain-view-field-value | Obtains the view field value of object. See documentation for 'reader' slot of 'field' for more d... |
| page-title | Generates a page title from the application name, application description, and current navigation... |
| pagination-page-count | Returns the total number of pages necessary to present the data managed by a given pagination wid... |
| pagination-page-item-range | Returns a range of items that belong to a currently selected page. This function returns two valu... |
| pane-exists-p | Given a navigation object and a name determines if there is a pane with the specified name. |
| persist-objects | Persists all objects in 'objects' sequence into 'store'. |
| pluralize | Pluralizes word. Converts 'thing' to 'things'. |
| proper-indefinite-article | Returns a proper indefinite article for a word. Returns 'an' for 'apple' and 'a' for 'table'. |
| proper-number-form | Turns 'singular-word' into proper number form. If 'number' is 1, leaves 'singular-word' as is, ot... |
| public-file-relative-path | Constructs a relative path to a public file from the “/pub” directory. 'type' - currently either... |
| public-files-relative-paths | A helper function that returns a list of paths for files provided in 'args'. Each argument must b... |
| pure-request-p | Detects if the current request is declared as 'pure', i.e. affects no widgets or internal applica... |
| refresh-request-p | Determines if a request is a result of the user invoking a browser refresh function. Note that a ... |
| remove-keyword-parameter | Removes a keyword parameter from a parameter-list. (remove-keyword-parameter '(1 2 3 :a 1 :b 2 :c... |
| remove-keyword-parameters | Removes all parameters with keys in 'keywords' from 'parameter-list'. |
| remove-parameter-from-uri | Removes the given parameter from a URI. |
| render-button | Renders a button in a form. 'name' - name of the html control. The name is attributized before b... |
| render-checkbox | Renders a checkbox in a form. 'name' - name of the html control. The name is attributized before... |
| render-close-button | Renders a close button. If the user clicks on the close button, 'close-action' is called back. If... |
| render-dropdown | Renders a dropdown HTML element (select). 'name' - the name of html control. The name is attribu... |
| render-extra-tags | Renders extra tags to get around CSS limitations. 'tag-class' is a string that specifies the clas... |
| render-isearch | Renders an input bar with 'input-name' that calls back 'isearch-fn' in delayed manner. This is us... |
| render-link | Renders an action into an href link. If 'ajaxp' is true (the default), the link will be rendered ... |
| render-object-view | A helper function that finds the view and calls 'render-object-view-impl'. |
| render-password | Renders a password in a form. 'name' - name of the html control. The name is attributized before ... |
| render-radio-buttons | Renders a group of radio buttons. 'name' - name of radio buttons. 'selections' - a list of selec... |
| render-suggest | Renders a block that provides functionality similar to google-suggest. 'input-name' - the 'name'... |
| render-textarea | Renders a textarea in a form. 'name' - name of the html control. The name is attributized before ... |
| render-widget | Renders a widget ('render-widget-body') wrapped in a header ('with-widget-header'). If 'inlinep' ... |
| request-parameter | Get parameter 'name' from the request. If the request was submitted via GET method, the parameter... |
| request-parameters | Get parameters alist from the request. If the request was submitted via GET method, the parameter... |
| request-parameters-for-object-view | Returns request parameters taking into account a particular view of an object. This function is n... |
| request-uri-path | Returns the path component of the request URI. The path component does not include the domain nam... |
| reset-current-pane | Sets the current pane to the first available pane in the list. |
| server-type | |
| server-version | |
| singularize | Singularizes word. Converts 'things' to 'thing'. |
| slot-value-by-path | Retrieves a value of a slot from a hierarchy of objects. A nil on the path is ignored. ex: (slo... |
| stable-set-difference | Returns a list of element of 'list-1' that do not appear in 'list-2'. |
| start-weblocks | Starts weblocks framework hooked into Hunchentoot server. Set ':debug' keyword to true in order f... |
| stop-weblocks | Stops weblocks. Closes all stores declared via 'defstore'. |
| string-invert-case | |
| string-remove-left | If string 'str' starts with 'suffix', remove 'suffix' from the start of 'str'. |
| string-remove-right | If string 'str' ends with 'suffix', remove 'suffix' from the end of 'str'. |
| string-whitespace-p | Returns true if every character in a string is a whitespace character, nil otherwise. |
| symbol-status | Returns a status of 'symbol' in its package (internal, external, etc.) |
| text-input-present-p | Returns true if the text input is to be considered non-empty. |
| vowelp | Checks if a character is a vowel. |
| widget-dirty-p | Returns true if the widget 'w' has been marked dirty. |
| attributize-name | Convert objects to a format suitable for serialization (in particular for markup languages like H... |
|---|---|
| class-id-slot-name | Must return the symbol that identifies the slot name which represents the unique ID of the class ... |
| class-store | Returns the store where objects of class name should be persisted. This function should be used b... |
| class-visible-slots-impl | Returns a list of 'standard-direct-slot-definition' objects for a class and its subclasses. Slots... |
| composite-widgets | |
| dataform-data-view | |
| dataform-form-view | |
| dataform-submit-action | Called when the user invokes a submit action on a dataform widget. The default implementation upd... |
| datagrid-render-item-ops-bar | This function is responsible for rendering item-ops bar for the datagrid. Specialize this functio... |
| datagrid-render-mining-bar | This function renders the data mining bad for the data grid (including selection controls, search... |
| datagrid-render-pagination-widget | This function is responsible for rendering the pagination widget for the datagrid. |
| find-widget-by-path* | Returns a widget object located at 'path', where 'path' is a list of widget names starting from r... |
| generate-scaffold-view | Generates and returns a scaffold view of a given scaffold type for a given object class. Scaffold... |
| generate-scaffold-view-field | Generates a sensible view field from a direct slot definition. Specialize this function to genera... |
| gridedit-add-item | If 'on-add-item' is specified, simply calls 'on-add-item'. Otherwise, if 'data' is a sequence, ad... |
| gridedit-create-drilldown-widget | The default implementation creates a dataform that allows editing an existing entry. Specialize t... |
| gridedit-create-new-item-widget | The default implementation creates a dataform that allows adding a new entry. Note, in order for ... |
| gridedit-delete-item | Called by 'gridedit-delete-items' to delete a single item. The default implementation deletes the... |
| handle-client-request | This method handles each request as it comes in from the server. It is a hunchentoot handler and ... |
| humanize-name | Convert objects to a human-readable string suitable for presentation. Default implementations bea... |
| mark-dirty | Default implementation adds a widget to a list of dirty widgets. Normally used during an AJAX req... |
| mixin-form-view-field-persist-p | |
| navigation-default-pane | Must return the name of the default pane for the navigation object. The default implementation re... |
| object-class-name | Returns an object's class name (i.e. “Employee”). This method is be used to present the name of a... |
| object-id | Returns a value that uniquely identifies an object in memory or in a backend store. The default i... |
| pagination-render-total-item-count | This function is responsible for rendering the total number of items if 'show-total-items' is set... |
| parse-view-field-value | Parse a string 'value' obtained from a request using a specified 'parser' and save it into an app... |
| parser-class-name | Given a type of the parser, returns its class name. Default implementation adds '-parser' to the ... |
| parser-error-message | |
| presentation-choices-default-label-key | Default key for choice labels. See 'presentation-choices-label-key' for more details. |
| presentation-choices-default-value-key | Default key for choice values. See 'presentation-choices-value-key' for more details. |
| presentation-class-name | Given a type of the presentation, returns its class name. Default implementation adds '-presentat... |
| print-view-field-value | Converts a value to a textual representation. Specialize this function to change the way a value ... |
| render-dataform | Renders the dataform widget in its current state. Normally called by 'render-widget-body'. Overri... |
| render-dataform-data | Renders the dataform widget when it's in ':data' state. Normally called by 'render-dataform'. Ove... |
| render-dataform-form | Renders the dataform widget when it's in ':form' state. Normally called by 'render-dataform'. Ove... |
| render-datagrid-table-body | Renders the actual data of the datagrid without any controls before or after. This function is us... |
| render-form-view-buttons | Renders buttons specified view 'buttons' slot of the 'form-view' object. By default, this method ... |
| render-navigation-body | Renders the body of the navigation widget. Unlike 'render-widget-body', which in case of navigati... |
| render-object-view-impl | Renders 'obj' using 'view'. |
| render-page-body | Renders the body of the page (exluding the <body> tag). The default implementation wraps the alre... |
| render-table-view-body-row | Renders the rows in the 'tbody' element of the table. The default implementation uses 'render-tab... |
| render-table-view-header-row | Renders the row in the 'thead' element of the table. The default implementation uses 'render-view... |
| render-validation-summary | Renders a summary of validation errors on top of the form. This function can be redefined to rend... |
| render-view-field | Renders a given view field. This function should render appropriate structural markup, and call r... |
| render-view-field-header | Renders a table header cell. |
| render-view-field-header-value | Renders a table header cell value. |
| render-view-field-value | Renders 'value' obtained from 'field' using 'presentation'. If this function requires a textual r... |
| render-widget-body | A generic function that renders a widget in its current state. In order to actually render the wi... |
| scaffold-class-name | Given a scaffold 'type', converts it to the class name of the scaffold. Default implementation ad... |
| scaffold-view-field-type | Given a scaffold object, returns its view field type. Default implementation removes '-scaffold' ... |
| scaffold-view-type | Given a scaffold object, returns its view type. Default implementation removes '-scaffold' from t... |
| typespec->form-view-field-parser | Converts a typespec to a parser argument. See 'typespec->view-field-presentation' for more inform... |
| typespec->view-field-presentation | Expects a scaffold type, a typespec and the typespec's arguments arguments (obtained via 'inspect... |
| update-object-view-from-request | Parses view fields from request into a given object. The 'form-view-field-parser' slot of each fi... |
| validate-form-view-field | Called by 'validate-object-form-view' during form deserialization to validate a form view field. ... |
| validate-object-form-view | Called by the framework during form deserialization to validate a form view. Default implementati... |
| view-argument-quoting-strategy | A quoting strategy for an argument of a given name. Possible values are :quote, in which case... |
| view-class-name | Given a view 'type', converts it to the class name of the view. Default implementation adds '-vie... |
| view-default-field-type | Given 'view-type' and 'field-type', returns the type of the fields of the view. Default implement... |
| view-field-class-name | Given a type of the field, returns its class name. Default implementation adds '-view-field' to t... |
| widget-continuation | |
| widget-css-classes | Returns a string that represents applicable CSS classes for 'widget'. Normally includes the class... |
| widget-name | |
| widget-prefix-fn | |
| widget-public-dependencies | Whenever a widget is rendered by weblocks in a non-AJAX request, this function is called to deter... |
| widget-rendered-p | |
| widget-suffix-fn | |
| with-navigation-header | Renders the header of the navigation widget. Unlike 'with-widget-header', which in case of the na... |
| with-table-view-body-row | Used by table view to render body rows. Specialize this function to modify HTML around a given ro... |
| with-table-view-header | Table specific header responsible for rendering table, thead, and tbody HTML. |
| with-table-view-header-row | Used by table view to render header rows. This functions calls 'render-table-view-header-row' to ... |
| with-view-header | Renders header and footer around the body of the view. Specialize this function to customize rend... |
| with-widget-header | Renders a header and footer for the widget and calls 'body-fn' within it. Specialize this functio... |
| defstore | A macro that helps define a store. A global variable 'name' is defined, and 'open-store' is calle... |
|---|---|
| defview | A macro used to easily define user interface views in a declarative manner. |
| defview-anon | A macro used to easily define anonymous user interface views in a declarative manner. |
| defwidget | A macro used to define new widget classes. Behaves exactly as defclass, except adds 'widget-class... |
| do-place | Expands to code that sets 'callee' as the widget in 'place', saves the continuation, and returns ... |
| extract-view-property-from-type | Helper macro to obtain view properties from typespecs. |
| insert-at | Destructively inserts 'newelt' into 'list' before 'index'. |
| request-hook | Allows access to a series of hooks exposed by 'handle-client-request'. scope - the scope of the ... |
| root-composite | Expands to code that can be used as a place to access to the root composite. |
| safe-apply | Apply 'fn' if it isn't nil. Otherwise return nil. |
| safe-funcall | Funcall 'fn' if it isn't nil. Otherwise return nil. |
| with-extra-tags | A macro used to wrap html into extra tags necessary for hacking CSS formatting. The macro wraps t... |
| with-flow | Eases the burden of creating flows. Instead of using 'do-place' in the body, one can use 'yield',... |
| with-html | A wrapper around cl-who with-html-output macro. |
| with-html-form | Transforms to cl-who (:form) with standard form code (AJAX support, actions, etc.) |
| with-javascript | Places 'source' between script and CDATA elements. Used to avoid having to worry about special ch... |