Docs For Class TextCSSNav

Description

This class builds a simple text navigational widget.

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

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

Container
   |
   --BaseWidget
      |
      --TextCSSNav

Variable Summary

mixed $_highlight_selected

mixed $_query_prefix

mixed $_selected

Method Summary

TextCSSNav TextCSSNav ([ $highlight_selected = FALSE], int $width)

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

void add_blank ([int $num = 1])

void add_text (string $text)

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

void push_blank ([ $num = 1])

void push_text ( $text)

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

void set_prefix (string $prefix)

Atag _build_link (array $nav, the $class, $cnt)

Container _build_links ()

Variables

mixed $_highlight_selected = FALSE (line 33)

Flag to tell us that we can highlight (css) the selected link.

This is off by default

mixed $_query_prefix = "" (line 47)

the prefix for the query string var

so we can have multiple widgets on the same page and have them operate independantly

mixed $_selected = 0 (line 39)

Holds which one is auto selected

Inherited Variables

Inherited from BaseWidget

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

Methods

Constructor TextCSSNav (line 57)

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

TextCSSNav TextCSSNav ([ $highlight_selected = FALSE], int $width)

int $width: - the width of the widget
$highlight_selected

add (line 103)

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 = ""], [ $selected = FALSE])

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

Redefinition of:

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

add_blank (line 125)

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

this adds a text item in the nav

void add_text (string $text)

string $text: - the text to display

push (line 115)

depricated version of add()

deprecated: - use add() instead

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

$url
$text
$title
$target

Redefinition of:

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

push_blank (line 135)

depricated version of add_blank()

deprecated: - use add_blank() instead

void push_blank ([ $num = 1])

$num

push_text (line 153)

depricated version of add_text()

deprecated: - use add_text() instead

void push_text ( $text)

$text

render (line 71)

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_prefix (line 86)

This method is used to set the prefix for

the widget so someone can have multiple widgets on the same page and have them operate independantly

void set_prefix (string $prefix)

string $prefix: - the prefix for the query var

_build_link (line 213)

This method actually builds an individual link

return: object

Atag _build_link (array $nav, the $class, $cnt)

array $nav: the link information
the $class: css class to use
$cnt

_build_links (line 164)

This function is used to build the links to click on

Container _build_links ()

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