Docs For 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 24)

Container
   |
   --BaseWidget

Direct descendents

Class	Description
TabControlWidget	This class is used for creating a tab control panel.
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.
DataList	This object is the base class that can be
TextNav	This class builds a simple text navigational widget.
TextCSSNav	This class builds a simple text navigational widget.
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.
ImageThumbnailWidget	This widget creates a N by x visual table of thumbnails.
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
NavTable	This builds a navigational table widget that has a title, any # of subtitles and then navigational links.
TabWidget	This class implements the Qualys Tab object.
TabList	This class implements a set of multiple tabs holding data objects
RoundTitleTable	This builds a table widget that has a nice rounded title, a subtitle area and any amount of data.
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.
SVGGraph	This is the base Graph class for doing SVG graphs
ErrorBoxWidget	This class is for displaying a standardized look and feel for an 'error' display.
TreeNav	This class tries to build a tree navigational widget.
InfoTable	This is a widget class that can build and render data in a nicely formated table with a title, column headers and data
FooterNav	Use this class to render footer navigation that is displayed at the bottom of a page.
VerticalCSSNavTable	This class builds a nice table that conains clickable cells.
CalendarTable	This is a widget class that can build and render calendar data in a nicely formated table.

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

The title of the table.

access: public

string $width = "100%" (line 45)

the width of the widget

access: public

mixed $_image_prefix = PHPHTMLLIB_WIGDET_IMAGEPATH (line 73)

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

This gets the alignment value for the outer table

return: - the alignment

string get_align ()

get_css (line 93)

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

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

Function for accessing the title of this widget

return: - the title

string get_title ()

Redefined in descendants as:

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

get_width (line 138)

Function for getting the current widget width setting.

return: - the width

string get_width ()

set_align (line 148)

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

This function is used to set the image path prefix.

void set_image_path_prefix (string $path)

string $path

set_title (line 105)

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

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