Class Navigation

The navigation widget can act as a menu controls, a
tabbed control, etc. It contains a list of section names and widgets
associated with those sections, and allows the user to select a
particular section which it then renders.

Part of:

package weblocks, class widget

Direct Superclass

widgetBase class for all widget objects.

Slot

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.
current-pane
A name that identifies currently selected entry.
Initargs::current-pane.
name
A name of the widget used in rendering CSS classes. If the name is not provided it will be generated automatically with 'generate-widget-id'.
Initform:(generate-widget-id), Initargs::name; Accessors:widget-name.
panes
An association list of names and widgets. The names will act as menu entries and attributized names will go into the URL. When a particular entry is clicked, its corresponding pane will be rendered.
Initargs::panes; Accessors:navigation-panes.
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.
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

find-widget-by-path*Returns a widget object located at 'path', where 'path' is a list
of widget names starting from r...
navigation-default-paneMust return the name of the default pane for the navigation
object. The default implementation re...
render-navigation-bodyRenders the body of the navigation widget. Unlike
'render-widget-body', which in case of navigati...
render-widget-bodyA generic function that renders a widget in its current state. In
order to actually render the wi...
with-navigation-headerRenders the header of the navigation widget. Unlike
'with-widget-header', which in case of the na...

Other Method

composite-widgets
mark-dirtyDefault implementation adds a widget to a list of dirty
widgets. Normally used during an AJAX req...
widget-css-classesReturns a string that represents applicable CSS
classes for 'widget'. Normally includes the class...