The weblocks-tree-widget Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The weblocks-tree-widget Reference Manual

This is the weblocks-tree-widget Reference Manual, version 0.3.7, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:30:43 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

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)


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

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
Source

weblocks-tree-widget.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 weblocks-tree-widget.asd

Location

weblocks-tree-widget.asd

Systems

weblocks-tree-widget (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 weblocks-tree-widget/package.lisp

Parent

weblocks-tree-widget (system)

Location

package.lisp

Packages

weblocks-tree-widget


Previous: , Up: Lisp files   [Contents][Index]

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
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 weblocks-tree-widget

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Exported definitions   [Contents][Index]

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
InitargValue
:allow-pagination-pnil
:allow-delete-pnil
:allow-select-pnil
:allow-operations-pnil

Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

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
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)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   W  
Index Entry  Section

F
File, Lisp, weblocks-tree-widget.asd: The weblocks-tree-widget<dot>asd file
File, Lisp, weblocks-tree-widget/package.lisp: The weblocks-tree-widget/package<dot>lisp file
File, Lisp, weblocks-tree-widget/weblocks-tree-widget.lisp: The weblocks-tree-widget/weblocks-tree-widget<dot>lisp file

L
Lisp File, weblocks-tree-widget.asd: The weblocks-tree-widget<dot>asd file
Lisp File, weblocks-tree-widget/package.lisp: The weblocks-tree-widget/package<dot>lisp file
Lisp File, weblocks-tree-widget/weblocks-tree-widget.lisp: The weblocks-tree-widget/weblocks-tree-widget<dot>lisp file

W
weblocks-tree-widget.asd: The weblocks-tree-widget<dot>asd file
weblocks-tree-widget/package.lisp: The weblocks-tree-widget/package<dot>lisp file
weblocks-tree-widget/weblocks-tree-widget.lisp: The weblocks-tree-widget/weblocks-tree-widget<dot>lisp file

Jump to:   F   L   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   E   F   G   I   J   M   R   T   V  
Index Entry  Section

(
(setf tree-view-field-current-row-info): Internal generic functions
(setf tree-view-field-current-row-info): Internal generic functions

A
action-links-reader: Exported functions

E
expand-branches: Internal functions

F
Function, action-links-reader: Exported functions
Function, expand-branches: Internal functions
Function, get-children-values: Internal functions
Function, get-items-tree-levels-count: Internal functions
Function, get-subtree-of-item: Internal functions
Function, implode: Internal functions
Function, join: Internal functions
Function, tree->list-of-objects: Internal functions
Function, tree-branches-advanced-presentation-field-value-wt: Internal functions
Function, tree-branches-presentation-field-value-wt: Internal functions
Function, tree-view-body-row-wt: Internal functions
Function, value-with-context: Internal functions

G
Generic Function, (setf tree-view-field-current-row-info): Internal generic functions
Generic Function, row-expanded-p: Internal generic functions
Generic Function, tree-data: Exported generic functions
Generic Function, tree-data-expanded: Internal generic functions
Generic Function, tree-view-field-current-row-info: Internal generic functions
get-children-values: Internal functions
get-items-tree-levels-count: Internal functions
get-subtree-of-item: Internal functions

I
implode: Internal functions

J
join: Internal functions

M
Method, (setf tree-view-field-current-row-info): Internal generic functions
Method, row-expanded-p: Internal generic functions
Method, tree-data: Exported generic functions
Method, tree-data-expanded: Internal generic functions
Method, tree-view-field-current-row-info: Internal generic functions

R
row-expanded-p: Internal generic functions
row-expanded-p: Internal generic functions

T
tree->list-of-objects: Internal functions
tree-branches-advanced-presentation-field-value-wt: Internal functions
tree-branches-presentation-field-value-wt: Internal functions
tree-data: Exported generic functions
tree-data: Exported generic functions
tree-data-expanded: Internal generic functions
tree-data-expanded: Internal generic functions
tree-view-body-row-wt: Internal functions
tree-view-field-current-row-info: Internal generic functions
tree-view-field-current-row-info: Internal generic functions

V
value-with-context: Internal functions

Jump to:   (  
A   E   F   G   I   J   M   R   T   V  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   C   E   S  
Index Entry  Section

C
current-row-info: Internal classes

E
expand-all-items-p: Exported classes
expanded-items: Exported classes

S
Slot, current-row-info: Internal classes
Slot, expand-all-items-p: Exported classes
Slot, expanded-items: Exported classes
Slot, straight-column-captions: Exported classes
straight-column-captions: Exported classes

Jump to:   C   E   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   P   S   T   W  
Index Entry  Section

C
Class, tree-branches-presentation: Exported classes
Class, tree-scaffold: Internal classes
Class, tree-view: Exported classes
Class, tree-view-field: Internal classes
Class, tree-widget: Exported classes

P
Package, weblocks-tree-widget: The weblocks-tree-widget package

S
System, weblocks-tree-widget: The weblocks-tree-widget system

T
tree-branches-presentation: Exported classes
tree-scaffold: Internal classes
tree-view: Exported classes
tree-view-field: Internal classes
tree-widget: Exported classes

W
weblocks-tree-widget: The weblocks-tree-widget system
weblocks-tree-widget: The weblocks-tree-widget package

Jump to:   C   P   S   T   W