The weblocks-tree-widget Reference Manual

Table of Contents

The weblocks-tree-widget Reference Manual

This is the weblocks-tree-widget Reference Manual, version 0.3.7, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Apr 28 13:18:49 2020 GMT+0.

1 Introduction

Weblocks tree widget, a tree based on weblocks gridedit widget.

To use it override tree-data method, see method documentation.
Sample code is 

(make-instance 'tree-widget 
   :view (defview nil (:type tree)
     (data 
      :present-as tree-branches))
   :data-class 'webapp-cls)

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 weblocks-tree-widget

Author

Olexiy Zamkoviy <olexiy.z@gmail.com>

License

LLGPL

Description

A tree widget for weblocks

Version

0.3.7

Dependencies

• weblocks
• yaclml
• alexandria

Source

weblocks-tree-widget.asd (file)

Components

• package.lisp (file)
• weblocks-tree-widget.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 weblocks-tree-widget.asd

Location

weblocks-tree-widget.asd

Systems

weblocks-tree-widget (system)

3.1.2 weblocks-tree-widget/package.lisp

Parent

weblocks-tree-widget (system)

Location

package.lisp

Packages

weblocks-tree-widget

3.1.3 weblocks-tree-widget/weblocks-tree-widget.lisp

Dependency

package.lisp (file)

Parent

weblocks-tree-widget (system)

Location

weblocks-tree-widget.lisp

Exported Definitions

• action-links-reader (function)
• tree-branches-presentation (class)
• tree-data (method)
• tree-view (class)
• tree-widget (class)

Internal Definitions

• expand-branches (function)
• get-children-values (function)
• get-items-tree-levels-count (function)
• get-subtree-of-item (function)
• implode (function)
• join (function)
• row-expanded-p (method)
• tree->list-of-objects (function)
• tree-branches-advanced-presentation-field-value-wt (function)
• tree-branches-presentation-field-value-wt (function)
• tree-data-expanded (method)
• tree-scaffold (class)
• tree-view-body-row-wt (function)
• tree-view-field (class)
• tree-view-field-current-row-info (method)
• (setf tree-view-field-current-row-info) (method)
• value-with-context (function)

4 Packages

Packages are listed by definition order.

4.1 weblocks-tree-widget

Source

package.lisp (file)

Use List

• weblocks-util
• weblocks
• common-lisp

Exported Definitions

• action-links-reader (function)
• tree-branches-presentation (class)
• tree-data (generic function)
• tree-data (method)
• tree-view (class)
• tree-widget (class)

Internal Definitions

• expand-branches (function)
• get-children-values (function)
• get-items-tree-levels-count (function)
• get-subtree-of-item (function)
• implode (function)
• join (function)
• row-expanded-p (generic function)
• row-expanded-p (method)
• tree->list-of-objects (function)
• tree-branches-advanced-presentation-field-value-wt (function)
• tree-branches-presentation-field-value-wt (function)
• tree-data-expanded (generic function)
• tree-data-expanded (method)
• tree-scaffold (class)
• tree-view-body-row-wt (function)
• tree-view-field (class)
• tree-view-field-current-row-info (generic function)
• tree-view-field-current-row-info (method)
• (setf tree-view-field-current-row-info) (method)
• (setf tree-view-field-current-row-info) (generic function)
• value-with-context (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Functions

Function: action-links-reader TREE FORM-VIEW &key ADDING-ALLOWED-P EDITING-ALLOWED-P DELETING-ALLOWED-P COLLAPSE-ALLOWED-P EXPAND-ALLOWED-P MAKE-NEW-ITEM STORE

Package

weblocks-tree-widget

Source

weblocks-tree-widget.lisp (file)

5.1.2 Generic functions

Generic Function: tree-data OBJ

Package

weblocks-tree-widget

Methods

Method: tree-data (OBJ tree-widget)

Should return (list (list :item #<store-object> :children (list (list :item #<store-object>) ...)) ...)

Source

weblocks-tree-widget.lisp (file)

5.1.3 Classes

Class: tree-branches-presentation ()

Package

weblocks-tree-widget

Source

weblocks-tree-widget.lisp (file)

Direct superclasses

html-presentation (class)

Direct methods

render-view-field-value (method)

Direct slots

Slot: straight-column-captions

Initargs

:straight-column-captions

Initform

t

Class: tree-view ()

Package

weblocks-tree-widget

Source

weblocks-tree-widget.lisp (file)

Direct superclasses

table-view (class)

Direct methods

• render-object-view-impl (method)
• with-table-view-header-row (method)
• with-table-view-body-row (method)

Class: tree-widget ()

Package

weblocks-tree-widget

Source

weblocks-tree-widget.lisp (file)

Direct superclasses

gridedit (class)

Direct methods

• tree-data-expanded (method)
• widget-translation-table (method)
• widget-translation-table (method)
• render-widget-body (method)
• dataedit-create-new-item-widget (method)
• dataedit-add-items-flow (method)
• row-expanded-p (method)
• tree-data (method)
• render-dataseq-body (method)
• dataseq-render-mining-bar (method)
• per-class-dependencies (method)

Direct slots

Slot: expand-all-items-p

Initargs

:expand-all-items-p

Initform

t

Slot: expanded-items

Direct Default Initargs

Initarg	Value
:allow-pagination-p	nil
:allow-delete-p	nil
:allow-select-p	nil
:allow-operations-p	nil

5.2 Internal definitions

5.2.1 Functions

Function: expand-branches TREE EXPANDABLE-P

Package

weblocks-tree-widget

Source

weblocks-tree-widget.lisp (file)

Function: get-children-values PARENT CHILDREN

Package

weblocks-tree-widget

Source

weblocks-tree-widget.lisp (file)

Function: get-items-tree-levels-count ITEMS &optional LEVELS-COUNT

Package

weblocks-tree-widget

Source

weblocks-tree-widget.lisp (file)

Function: get-subtree-of-item TREE ITEM &key TEST

Returns subtree in which item is the value of :item key

Package

weblocks-tree-widget

Source

weblocks-tree-widget.lisp (file)

Function: implode GLUE-OR-PIECES &optional PIECES

Package

weblocks-tree-widget

Source

weblocks-tree-widget.lisp (file)

Function: join GLUE-OR-PIECES &optional PIECES

Package

weblocks-tree-widget

Source

weblocks-tree-widget.lisp (file)

Function: tree->list-of-objects TREE

Recursively transforms tree items to list of objects

Package

weblocks-tree-widget

Source

weblocks-tree-widget.lisp (file)

Function: tree-branches-advanced-presentation-field-value-wt &key VALUE LEVEL LASTP SINGLE-CHILD-P LASTP-MAP LEVELS-LEFT STRAIGHT-COLUMN-CAPTIONS HAS-CHILDREN-P &allow-other-keys

This is additional tree template which uses utf-8 symbols for displaying branches

Package

weblocks-tree-widget

Source

weblocks-tree-widget.lisp (file)

Function: tree-branches-presentation-field-value-wt &key VALUE LEVEL LASTP SINGLE-CHILD-P LASTP-MAP LEVELS-LEFT STRAIGHT-COLUMN-CAPTIONS &allow-other-keys

Standard tree template uses ascii symbols for displaying tree branches

Package

weblocks-tree-widget

Source

weblocks-tree-widget.lisp (file)

Function: tree-view-body-row-wt &key PREFIX SUFFIX ROW-CLASS CONTENT CHILDREN-CONTENT

Package

weblocks-tree-widget

Source

weblocks-tree-widget.lisp (file)

Function: value-with-context VARIABLE &rest CONTEXT

Package

weblocks-tree-widget

Source

weblocks-tree-widget.lisp (file)

5.2.2 Generic functions

Generic Function: row-expanded-p WIDGET OBJ

Package

weblocks-tree-widget

Methods

Method: row-expanded-p (WIDGET tree-widget) OBJ

Source

weblocks-tree-widget.lisp (file)

Generic Function: tree-data-expanded WIDGET

Package

weblocks-tree-widget

Methods

Method: tree-data-expanded (WIDGET tree-widget)

Extracts children of expanded items.
Extracts means calls children function if :children is not a list. We receive tree with items user can see in web interface

Source

weblocks-tree-widget.lisp (file)

Generic Function: tree-view-field-current-row-info OBJECT

Generic Function: (setf tree-view-field-current-row-info) NEW-VALUE OBJECT

Package

weblocks-tree-widget

Methods

Method: tree-view-field-current-row-info (TREE-VIEW-FIELD tree-view-field)

automatically generated reader method

Source

weblocks-tree-widget.lisp (file)

Method: (setf tree-view-field-current-row-info) NEW-VALUE (TREE-VIEW-FIELD tree-view-field)

automatically generated writer method

Source

weblocks-tree-widget.lisp (file)

5.2.3 Classes

Class: tree-scaffold ()

Package

weblocks-tree-widget

Source

weblocks-tree-widget.lisp (file)

Direct superclasses

table-scaffold (class)

Class: tree-view-field ()

Package

weblocks-tree-widget

Source

weblocks-tree-widget.lisp (file)

Direct superclasses

table-view-field (class)

Direct methods

• tree-view-field-current-row-info (method)
• tree-view-field-current-row-info (method)

Direct slots

Slot: current-row-info

Readers

tree-view-field-current-row-info (generic function)

Writers

(setf tree-view-field-current-row-info) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types