Docs For Class TreeNav

Description

This class tries to build a tree navigational widget.

definetly not done.

author: Walter A. Boring IV <waboring@newsblob.com>

Located in /widgets/TreeNav.inc (line 25)

Container
   |
   --BaseWidget
      |
      --TreeNav

Method Summary

TreeNav TreeNav ([int $width = 760])

void build_img_td ()

void build_innertable ()

void build_link_td ( $nav)

void build_spacer_td ()

void push ( $url, $text, [ $selected = FALSE])

void push_blank ([ $num = 1])

void push_text ( $text, [ $selected = FALSE])

string render ([int $indent_level = 1], [int $output_debug = 0])

void set_selected (string $text)

Variables

Inherited Variables

Inherited from BaseWidget

BaseWidget::$title
BaseWidget::$width
BaseWidget::$_image_prefix

Methods

Constructor TreeNav (line 34)

Constructor for this class It just sets the width for the widget.

TreeNav TreeNav ([int $width = 760])

int $width: - the width of the widget

build_img_td (line 70)

build the image seperator td

void build_img_td ()

build_innertable (line 121)

build all of the idividual nav elements.

void build_innertable ()

build_link_td (line 86)

build the link td.

void build_link_td ( $nav)

$nav

build_spacer_td (line 103)

build a spacer td.

void build_spacer_td ()

push (line 41)

void push ( $url, $text, [ $selected = FALSE])

$url
$text
$selected

Redefinition of:

Container::push(): Same as add().

push_blank (line 46)

void push_blank ([ $num = 1])

$num

push_text (line 51)

void push_text ( $text, [ $selected = FALSE])

$text
$selected

render (line 156)

function that will render the widget.

return: the raw html output.

string render ([int $indent_level = 1], [int $output_debug = 0])

int $indent_level: - the indentation level for the container.
int $output_debug: - the output debug flag to maintain compatibility w/ the API.

Redefinition of:

Container::render(): This function is compatible with the rest of the phpHtmllib API spec.

set_selected (line 62)

Set this text as the selected item

void set_selected (string $text)

string $text: - the text item selected.

Inherited Methods

Inherited From BaseWidget

BaseWidget::get_align()
BaseWidget::get_css()
BaseWidget::get_javascript()
BaseWidget::get_title()
BaseWidget::get_width()
BaseWidget::set_align()
BaseWidget::set_image_path_prefix()
BaseWidget::set_title()
BaseWidget::set_width()

Inherited From Container

Container::Container()
Container::add()
Container::add_reference()
Container::count_content()
Container::get_element()
Container::get_indent_flag()
Container::push()
Container::push_reference()
Container::render()
Container::reset_content()
Container::set_collapse()
Container::set_indent_flag()