Docs For Class MyLayoutPage

## Class MyLayoutPage

Description

This is an example Child of the PageWidget

class to show how to build a simple application or system wide layout simple to manage and maintain

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

Located in /examples/MyLayoutPage.inc (line 29)

    HTMLPageClass
       |
       --PageWidget
          |
          --MyLayoutPage

Direct descendents

Class | Description
--- | ---
| A simple Page Layout object child.
Form2Page | A simple Page Layout object child.
Form3Page | A simple Page Layout object child. this came from Example 3.
Form4Page | This demonstrates the power of the master-slave relationship between two list elements

Method Summary
MyLayoutPage MyLayoutPage (string $title, [- $render_type = HTML])
void body_content ()
HTMLTag content_block ()
HTMLtag footer_block ()
HTMLtag header_block ()
HTMLTag left_block ()
void main_block (TABLEtag 0)
Variables

#### Inherited Variables

Inherited from PageWidget

> PageWidget::$_allow_permissions_checks
> PageWidget::$_enable_debug
> PageWidget::$_permissions_error_width
> PageWidget::$_permission_box
> PageWidget::$_perm_options
> PageWidget::$_title_text

Inherited from HTMLPageClass

> HTMLPageClass::$_favicon
> HTMLPageClass::$_html_attributes
> HTMLPageClass::$_html_render_type
> HTMLPageClass::$_indent_style
> HTMLPageClass::$_widget_css_auto
> HTMLPageClass::$_widget_js_auto
> HTMLPageClass::$_xml_encoding

Methods
Constructor MyLayoutPage (line 40)

This is the constructor.

MyLayoutPage MyLayoutPage (string $title, [- $render_type = HTML])

- string $title: - $title - the title for the page and the titlebar object.
- - $render_type: string - The render type (HTML, XHTML, etc. )

body_content (line 59)

This builds the main content for the page.

void body_content ()

Redefinition of:

PageWidget::body_content()
  This function is meant to be overridden by the child class.

content_block (line 150)

this function returns the contents of the right block. It is already wrapped in a TD

- return: object

HTMLTag content_block ()

Redefined in descendants as:

- Form1Page::content_block()
- Form2Page::content_block()
- Form3Page::content_block()
- Form4Page::content_block()

footer_block (line 165)

This function is responsible for building the footer block for every page.

- return: object.

HTMLtag footer_block ()
header_block (line 94)

This function is responsible for building the header block that lives at the top of every page.

- return: object.

HTMLtag header_block ()
left_block (line 133)

this function returns the contents of the left block. It is already wrapped in a TD

- return: object

HTMLTag left_block ()
main_block (line 109)

We override this method to automatically break up the main block into a left block and a right block

void main_block (TABLEtag 0)

- TABLEtag 0: object.

#### Inherited Methods

Inherited From PageWidget

> PageWidget::PageWidget()
> PageWidget::allow_permissions_checks()
> PageWidget::body_content()
> PageWidget::enable_debug()
> PageWidget::frameset()
> PageWidget::get_title()
> PageWidget::head_content()
> PageWidget::head_javascript()
> PageWidget::permission()
> PageWidget::render()
> PageWidget::set_permissions_message()
> PageWidget::_build_permission_box()
> PageWidget::_check_permissions()
> PageWidget::_has_permission()
> PageWidget::_set_perms()

Inherited From HTMLPageClass

> HTMLPageClass::HTMLPageClass()
> HTMLPageClass::add()
> HTMLPageClass::add_css_link()
> HTMLPageClass::add_head_content()
> HTMLPageClass::add_head_css()
> HTMLPageClass::add_head_js()
> HTMLPageClass::add_js_link()
> HTMLPageClass::add_reference()
> HTMLPageClass::build_doctype()
> HTMLPageClass::get_html_attributes()
> HTMLPageClass::push()
> HTMLPageClass::push_css_link()
> HTMLPageClass::push_head_content()
> HTMLPageClass::push_head_js()
> HTMLPageClass::push_js_link()
> HTMLPageClass::push_reference()
> HTMLPageClass::render()
> HTMLPageClass::set_body_attributes()
> HTMLPageClass::set_charset()
> HTMLPageClass::set_encoding()
> HTMLPageClass::set_favicon()
> HTMLPageClass::set_favicon_flag()
> HTMLPageClass::set_frameset()
> HTMLPageClass::set_html_attributes()
> HTMLPageClass::set_language()
> HTMLPageClass::set_refresh()
> HTMLPageClass::set_text_debug()
> HTMLPageClass::set_title()
> HTMLPageClass::_build_content_type_tag()
> HTMLPageClass::_build_head()
> HTMLPageClass::_create_body()
> HTMLPageClass::_frameset_wrap_body()

Documentation generated on Thu, 1 Sep 2005 17:06:07 -0700 by phpDocumentor 1.3.0RC3