Class we_ui_layout_HTMLPage

Description

Class to build a HTML page

Located in /ui/layout/HTMLPage.php (line 30)

we_core_AbstractObject
   |
   --we_ui_abstract_AbstractElement
      |
      --we_ui_layout_HTMLPage
Direct descendents
Class Description
we_app_HomePage Basic Class for Home Page View of App
we_ui_layout_Dialog Base Class for Dialog Windows
Variable Summary
string $_bodyHTML
string $_charset
string $_doctype
array $_inlineCSS
array $_inlineJS
mixed $_isTopFrame
string $_title
Method Summary
static void getInstance ()
void __construct ()
void addBodyAttribute (string $name, string $value)
void addHTML (string $html)
void addInlineCSS (string $css)
void addInlineJS (string $js)
string getBodyHTML ()
string getCharset ()
string getDoctype ()
string getFramesetHTML ()
unknown getIsTopFrame ()
unknown isTopFrame ()
void setBodyAttributes (array $bodyAttributes)
void setBodyHTML (string $bodyHTML)
void setCharset (string $charset)
void setDoctype (string $doctype)
void setFramesetHTML (string $frameset)
void setIsTopFrame (unknown_type $isTopFrame)
string _renderHTML ()
void _willRenderHTML ()
Variables
string $_bodyAttributes = array() (line 92)

array with attributes to insert in the body tag

  • access: protected
string $_bodyHTML = '' (line 71)

string with innerHTML of the <body> Tag

  • access: protected
string $_charset = '' (line 78)

string with name of charset

  • access: protected
string $_doctype = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">' (line 85)

string with doctype tag

  • access: protected
mixed $_framesetHTML = '' (line 57)
  • access: protected
array $_inlineCSS = array() (line 50)

array that holds internal css code to include into page

  • access: protected
array $_inlineJS = array() (line 64)

array that holds internal js code to include into page

  • access: protected
mixed $_isTopFrame = false (line 94)
  • access: protected
string $_title = 'webEdition (c) 2008 living-e AG (http://www.living-e.com)' (line 43)

title tag

  • access: protected

Redefinition of:
we_ui_abstract_AbstractElement::$_title
title attribute or title tag

Redefined in descendants as:

Inherited Variables

Inherited from we_ui_abstract_AbstractElement

we_ui_abstract_AbstractElement::$_class
we_ui_abstract_AbstractElement::$_CSSFiles
we_ui_abstract_AbstractElement::$_disabled
we_ui_abstract_AbstractElement::$_height
we_ui_abstract_AbstractElement::$_hidden
we_ui_abstract_AbstractElement::$_id
we_ui_abstract_AbstractElement::$_JSFiles
we_ui_abstract_AbstractElement::$_lang
we_ui_abstract_AbstractElement::$_left
we_ui_abstract_AbstractElement::$_overflow
we_ui_abstract_AbstractElement::$_position
we_ui_abstract_AbstractElement::$_style
we_ui_abstract_AbstractElement::$_top
we_ui_abstract_AbstractElement::$_width
Methods
static method getInstance (line 132)
  • access: public
static void getInstance ()
Constructor __construct (line 112)

Constructor

  • access: public
void __construct ()

Redefinition of:
we_core_AbstractObject::__construct()
Constructor

Redefined in descendants as:
addBodyAttribute (line 199)

adds body attribute

  • access: public
void addBodyAttribute (string $name, string $value)
  • string $name: name of attribute
  • string $value: value of attribute
addElement (line 155)

adds an element to the page. The elements HTML will be added to the innerHTML of the body tag

  • access: public
void addElement (we_ui_abstract_AbstractElement $elem)
addHTML (line 102)

adds HTML Code to innerHTML of body tag

  • access: public
void addHTML (string $html)
  • string $html
addInlineCSS (line 170)

adds CSS code to the page Will be inserted into the header section of the page using the <style> tag

  • access: public
void addInlineCSS (string $css)
  • string $css: CSS code to add
addInlineJS (line 185)

adds JavaScript code to the page Will be inserted into the header section of the page using the <script> tag

  • access: public
void addInlineJS (string $js)
  • string $js: JavaScript code to add
getBodyAttributes (line 350)

Retrieve body attributes as an associative array

  • access: public
array getBodyAttributes ()
getBodyHTML (line 360)

Retrieve innerHTML of body tag

  • access: public
string getBodyHTML ()
getCharset (line 370)

Retrieve charset of page

  • access: public
string getCharset ()
getDoctype (line 380)

Retrieve doctype tag of page

  • access: public
string getDoctype ()
getFramesetHTML (line 390)

Retrieve frameset HTML

  • access: public
string getFramesetHTML ()
getIsTopFrame (line 464)
  • access: public
unknown getIsTopFrame ()
isTopFrame (line 472)
  • access: public
unknown isTopFrame ()
setBodyAttributes (line 401)

set body attributes

  • access: public
void setBodyAttributes (array $bodyAttributes)
  • array $bodyAttributes
setBodyHTML (line 412)

set innerHTML of body tag

  • access: public
void setBodyHTML (string $bodyHTML)
  • string $bodyHTML
setCharset (line 423)

set charset of page

  • access: public
void setCharset (string $charset)
  • string $charset
setDoctype (line 434)

set doctype tag of page

  • access: public
void setDoctype (string $doctype)
  • string $doctype
setFrameset (line 456)

set frameset for page

  • access: public
void setFrameset (we_ui_layout_Frameset $frameset)
setFramesetHTML (line 445)

Set frameset HTML of page

  • access: public
void setFramesetHTML (string $frameset)
  • string $frameset
setIsTopFrame (line 480)
  • access: public
void setIsTopFrame (unknown_type $isTopFrame)
  • unknown_type $isTopFrame
_renderHTML (line 210)

renders and returns the HTML code of the page will be called from getHTML()

  • access: protected
string _renderHTML ()

Redefinition of:
we_ui_abstract_AbstractElement::_renderHTML()
Renders and returns HTML of ui element

Redefined in descendants as:
_willRenderHTML (line 341)

called before _renderHTML() is called for HTMLDocuments we don't need to do anything here, so we overwrite it with an empty function

  • access: protected
void _willRenderHTML ()

Redefinition of:
we_ui_abstract_AbstractElement::_willRenderHTML()
called before _renderHTML() is called

Redefined in descendants as:

Inherited Methods

Inherited From we_ui_abstract_AbstractElement

we_ui_abstract_AbstractElement::addCSSFile()
we_ui_abstract_AbstractElement::addCSSFiles()
we_ui_abstract_AbstractElement::addJSFile()
we_ui_abstract_AbstractElement::addJSFiles()
we_ui_abstract_AbstractElement::computeJSURL()
we_ui_abstract_AbstractElement::getClass()
we_ui_abstract_AbstractElement::getCSSFiles()
we_ui_abstract_AbstractElement::getDisabled()
we_ui_abstract_AbstractElement::getHeight()
we_ui_abstract_AbstractElement::getHidden()
we_ui_abstract_AbstractElement::getHTML()
we_ui_abstract_AbstractElement::getId()
we_ui_abstract_AbstractElement::getJSFiles()
we_ui_abstract_AbstractElement::getJSHTML()
we_ui_abstract_AbstractElement::getLang()
we_ui_abstract_AbstractElement::getLeft()
we_ui_abstract_AbstractElement::getOverflow()
we_ui_abstract_AbstractElement::getPosition()
we_ui_abstract_AbstractElement::getStyle()
we_ui_abstract_AbstractElement::getTitle()
we_ui_abstract_AbstractElement::getTop()
we_ui_abstract_AbstractElement::getWidth()
we_ui_abstract_AbstractElement::setClass()
we_ui_abstract_AbstractElement::setDisabled()
we_ui_abstract_AbstractElement::setHeight()
we_ui_abstract_AbstractElement::setHidden()
we_ui_abstract_AbstractElement::setId()
we_ui_abstract_AbstractElement::setLang()
we_ui_abstract_AbstractElement::setLeft()
we_ui_abstract_AbstractElement::setOverflow()
we_ui_abstract_AbstractElement::setPosition()
we_ui_abstract_AbstractElement::setStyle()
we_ui_abstract_AbstractElement::setTitle()
we_ui_abstract_AbstractElement::setTop()
we_ui_abstract_AbstractElement::setWidth()
we_ui_abstract_AbstractElement::_didRenderHTML()
we_ui_abstract_AbstractElement::_getBooleanAttribs()
we_ui_abstract_AbstractElement::_getComputedClassAttrib()
we_ui_abstract_AbstractElement::_getComputedStyleAttrib()
we_ui_abstract_AbstractElement::_getNonBooleanAttribs()
we_ui_abstract_AbstractElement::_renderHTML()
we_ui_abstract_AbstractElement::_willRenderHTML()

Inherited From we_core_AbstractObject

we_core_AbstractObject::__construct()

Documentation generated on Mon, 01 Sep 2008 11:35:40 +0200 by phpDocumentor 1.4.0