Docs For Class BaseWidget

## Class BaseWidget

Description

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

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

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

    Container
       |
       --BaseWidget

Direct descendents

Class | Description
--- | ---
SVGGraph | This is the base Graph class for doing SVG graphs
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.
ButtonPanel | This class defines a bottom button panel for a dialog box window It is a BaseWidget child with a specific css style class and border This row is separated by vertical top line
CSSContainer | This class is a container for CSSBuilder objects. It is meant to make the theming of many CSSBuilder objects easy to manage.
DialogWidget | This is a base class for building generic Dialogs with messages and buttons.
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.
RoundTitleTable | This builds a table widget that has a nice rounded title, a subtitle area and any amount of data.
TabControlWidget | This class is used for creating a tab control panel.
TabWidget | This class implements the Qualys Tab object.
TabList | This class implements a set of multiple tabs holding data objects
TextCSSNav | This class builds a simple text navigational widget.
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
ProgressWidget | This widget will display a progress bar without requiring a page turn to get the updated status from the web server.
ProgressBoxWidget | This class builds a nice box that contains a title a ProgressWidget and some description text for each progress percentage.
ErrorBoxWidget | This class is for displaying a standardized look and feel for an 'error' display.

Variable Summary
string $title
string $width
mixed $_image_prefix
Method Summary
string get_align ()
string get_css ()
string get_javascript ()
string get_title ()
string get_width ()
void set_align (string $align)
void set_image_path_prefix (string $path)
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

mixed $_image_prefix = '/phphtmllib/images/widgets' (line 70)

The image path prefix.

If an image lives on the server in /images/foo/blah.jpg then this prefix should be /images/foo

Methods
get_align (line 155)

This gets the alignment value for the outer table

- return: - the alignment

string get_align ()
get_css (line 90)

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

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

- return: - the raw javascript

string get_javascript ()

Redefined in descendants as:

- ActiveTab::get_javascript() : This function MUST be called AFTER ALL content has been added, in order for the js to work properly

get_title (line 112)

Function for accessing the title of this widget

- return: - the title

string get_title ()

Redefined in descendants as:

- TabList::get_title() : Return the title
- DefaultGUIDatalist::get_title() : Check to see if we should show the title

get_width (line 135)

Function for getting the current widget width setting.

- return: - the width

string get_width ()
set_align (line 145)

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:

- DefaultGUIDatalist::set_align() : this function is used to set the overall alignment of the widget
- ListAction::set_align() : this function is used to set the overall alignment of the widget

set_image_path_prefix (line 166)

This function is used to set the image path prefix.

void set_image_path_prefix (string $path)

- string $path

set_title (line 102)

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:

- SVGGraph::set_title() : This method sets the title for the graph

set_width (line 125)

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:

- SVGGraph::set_width() : This method sets the width of the graph

#### Inherited Methods

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:05:33 -0700 by phpDocumentor 1.3.0RC3