Docs For Class TextNav

## Class TextNav

Description

This class builds a simple text navigational widget.

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

Located in /widgets/TextNav.inc (line 24)

    Container
       |
       --BaseWidget
          |
          --TextNav

Method Summary
TextNav TextNav ([int $width = 760])
void add (string $url, string $text, [string $width = 100], [string $target = NULL])
void add_blank ([int $num = 1])
void add_text (string $text)
void build_img_td ()
void build_nav_td (array $nav, int $count)
void push (mixed $url, mixed $text, [mixed $width = 100])
void push_blank ([mixed $num = 1])
void push_text (mixed $text)
string render ([int $indent_level = 1], int $output_debug)
Variables

#### Inherited Variables

Inherited from BaseWidget

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

Methods
Constructor TextNav (line 34)

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

TextNav TextNav ([int $width = 760])

- int $width: - the width of the widget

add (line 86)

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 $width = 100], [string $target = NULL])

- string $url: - the url for the link
- string $text: - the link text
- string $width: - the width of the cell
- string $target: - the target for the url

Redefinition of:

Container::add()
  add content onto content stack

add_blank (line 107)

This lets you add a blank entry between 2 links

void add_blank ([int $num = 1])

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

add_text (line 126)

this adds a text item in the nav

void add_text (string $text)

- string $text: - the text to display

build_img_td (line 174)

build the image seperator td

void build_img_td ()
build_nav_td (line 147)

build a td for the link.

void build_nav_td (array $nav, int $count)

- array $nav: - the nav array entry
- int $count: - the column # this entry is

push (line 97)

depricated version of add()

- deprecated: - use add() instead

void push (mixed $url, mixed $text, [mixed $width = 100])

Redefinition of:

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

push_blank (line 117)

depricated version of add_blank()

- deprecated: - use add_blank() instead

void push_blank ([mixed $num = 1])
push_text (line 135)

depricated version of add_text()

- deprecated: - use add_text() instead

void push_text (mixed $text)
render (line 50)

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.

#### 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:34 -0700 by phpDocumentor 1.3.0RC3