Class BaseWidget

Description

this is the base widget class, that all widgets are based off of. It provides some basic members and methods

Located in Program_Root/widgets/BaseWidget.inc (line 21)

Container
   |
   --BaseWidget
Direct descendents
Class Description
ActiveTab This class is used for creating a tab panel of content where the tabs can be switched on the fly w/ JS, thereby eliminating a page turn to see the other tab's content.
FooterNav Use this class to render footer navigation that is displayed at the bottom of a page.
ImageThumbnailWidget This widget creates a N by x visual table of thumbnails.
InfoTable This is a widget class that can build and render data in a nicely formated table with a title, column headers and data
NavTable This builds a navigational table widget that has a title, any # of subtitles and then navigational links.
TextCSSNav This class builds a simple text navigational widget.
SVGGraph This is the base Graph class for doing SVG graphs
RoundTitleTable This builds a table widget that has a nice rounded title, a subtitle area and any amount of data.
TextNav This class builds a simple text navigational widget.
TreeNav This class tries to build a tree navigational widget.
VerticalCSSNavTable This class builds a nice table that conains clickable cells.
DataList This object is the base class that can be
CSSContainer This class is a container for CSSBuilder objects. It is meant to make the theming of many CSSBuilder objects easy to manage.
Variable Summary
string $title
string $width
Method Summary
string get_align ()
string get_css ()
string get_javascript ()
string get_title ()
string get_width ()
void set_align (string $align)
void set_title (string $title)
void set_width (string $width)
Variables
string $title = '' (line 35)

The title of the table.

  • access: public
string $width = "100%" (line 42)

the width of the widget

  • access: public

Inherited Variables

Inherited from Container

Container::$_flags
Methods
get_align (line 145)

This gets the alignment value for the outer table

  • return:

    - the alignment

string get_align ()
get_css (line 80)

This function provides the mechanism to build and return the css needed by this widget

  • return:

    the raw css

string get_css ()
get_javascript (line 69)

Function for returning the raw javascript that is required for this widget.

  • return:

    - the raw javascript

string get_javascript ()

Redefined in descendants as:
get_title (line 102)

Function for accessing the title of this widget

  • return:

    - the title

string get_title ()
get_width (line 125)

Function for getting the current widget width setting.

  • return:

    - the width

string get_width ()
set_align (line 135)

This function sets the align attribute for the outer table.

void set_align (string $align)
  • string $align:

    - $align - the align value


Redefined in descendants as:
set_title (line 92)

Set the title for the widget.

this is just a generic title string that can be used however the child class wants to use it.

void set_title (string $title)
  • string $title:

    - $title


Redefined in descendants as:
set_width (line 115)

Set the width for the widget.

this is meant to be the overall width expected to be used to control the generated html.

void set_width (string $width)
  • string $width:

    - $width (ie. 80, 100%)


Redefined in descendants as:

Inherited Methods

Inherited From Container

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

Documention generated on Thu, 31 Jul 2003 18:32:18 -0700 by phpDocumentor 1.2.0