Docs For Class VerticalCSSNavTable

## Class VerticalCSSNavTable

Description

This class builds a nice table that conains clickable cells.

--------------------- | TITLE | --------------------- | SUBTITLE | --------------------- | link 1 | --------------------- | link 2 | ---------------------

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

Located in /widgets/VerticalCSSNavTable.inc (line 36)

    Container
       |
       --BaseWidget
          |
          --VerticalCSSNavTable

Variable Summary
string $_subtitle
TABLEtag $_table
Method Summary
VerticalCSSNavTable VerticalCSSNavTable (mixed $title, [mixed $subtitle = ""], [int $width = "100%"])
void add (string $url, string $text, [string $title = ""], [string $target = ""])
void add_text (string $text)
string get_subtitle ()
string render ([int $indent_level = 1], int $output_debug)
void set_subtitle (string $subtitle)
Container _build_links ()
void _build_subtitle ()
void _build_title ()
Variables
string $_subtitle = "" (line 43)

the subtitle if any

TABLEtag $_table = NULL (line 51)

Holds the outer table object

- var: object

#### Inherited Variables

Inherited from BaseWidget

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

Methods
Constructor VerticalCSSNavTable (line 61)

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

VerticalCSSNavTable VerticalCSSNavTable (mixed $title, [mixed $subtitle = ""], [int $width = "100%"])

- int $width: - the width of the widget

add (line 122)

this function adds a clickable link.

It automatically adds the link based on $url, with $text as the viewable text.

void add (string $url, string $text, [string $title = ""], [string $target = ""])

- string $url: - the url for the link
- string $text: - the link text
- string $title: - the title text
- string $target: - the link target

Redefinition of:

Container::add()
  add content onto content stack

add_text (line 133)

this adds a text item in the nav

void add_text (string $text)

- string $text: - the text to display

get_subtitle (line 105)

This function returns the current subtitle.

- return: - the subtitle

string get_subtitle ()
render (line 77)

function that will render the widget.

- return: the raw html output.

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

- 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_subtitle (line 95)

This sets the subtitle

void set_subtitle (string $subtitle)

- string $subtitle: - the subtitle

_build_links (line 171)

This function is used to build the links to click on

Container _build_links ()
_build_subtitle (line 151)

This function builds the subtitle if needed.

void _build_subtitle ()
_build_title (line 142)

This function builds the title tr

void _build_title ()

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

Documentation generated on Thu, 1 Sep 2005 17:06:35 -0700 by phpDocumentor 1.3.0RC3