Docs For Class NavTable

Description

This builds a navigational table widget that has a title, any # of subtitles and then navigational links.

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

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

Container
   |
   --BaseWidget
      |
      --NavTable

Method Summary

NavTable NavTable (string $title, [string $subtitle = NULL], [mixed $width = "100%"])

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

void add_blank ([int $num = 1])

void add_heading (string $title)

void add_text (string $text)

void push ( $url, $text, [ $title = NULL], [ $target = NULL])

void push_blank ([ $num = 1])

void push_heading ( $title)

void push_text ( $text)

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

void set_subtitle ( $subtitle)

TDtag _build_subtitle ()

void _render_text (array() $val)

void _render_url (array() $val)

Variables

Inherited Variables

Inherited from BaseWidget

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

Methods

Constructor NavTable (line 60)

the constructor for this class.

NavTable NavTable (string $title, [string $subtitle = NULL], [mixed $width = "100%"])

string $title: - the title for the widget.
string $subtitle: - the subtitle if any.
mixed $width: - the width of the widget. can be a % or an int.

add (line 84)

this function adds an entry to the navtable.

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

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

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

Redefinition of:

Container::add(): add content onto content stack

add_blank (line 107)

This lets you add a blank line between 2 links

void add_blank ([int $num = 1])

int $num: - the # of blank lines to insert

add_heading (line 145)

This adds a new heading in the nav.

It will look just like the sub title area

void add_heading (string $title)

string $title: - the text in the heading

add_text (line 126)

this adds a text item in the nav

void add_text (string $text)

string $text: - the text to display

push (line 97)

depricated version of add()

deprecated: - use add() instead

void push ( $url, $text, [ $title = NULL], [ $target = NULL])

$url
$text
$title
$target

Redefinition of:

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

push_blank (line 117)

depricated version of add_blank()

deprecated: - use add_blank() instead

void push_blank ([ $num = 1])

$num

push_heading (line 154)

depricated version of add_heading()

deprecated: - use add_heading() instead

void push_heading ( $title)

$title

push_text (line 135)

depricated version of add_text()

deprecated: - use add_text() instead

void push_text ( $text)

$text

render (line 270)

Render the Navtable and its content.

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

void set_subtitle ( $subtitle)

$subtitle

_build_subtitle (line 191)

this function builds the subtitle td to hold the...subtitle!

return: object

TDtag _build_subtitle ()

_render_text (line 246)

render a text row.

void _render_text (array() $val)

array() $val: - the item to render.

_render_url (line 219)

render a url row.

void _render_url (array() $val)

array() $val: - the item to render.

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