Class: HTMLDocument

Source Location: /html/HTMLDocument.class.php

Class Overview

ABSTObject
   |
   --ABSTHTMLTag
      |
      --HTMLDocument

Creating HTML-Documents

Author(s):

Daniel Plücken <daniel@debakel.net>

Version:

0.2.23

Copyright:

Copyright (c) 2003 Daniel Plücken <daniel@debakel.net>
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Inherited Variables

Class: ABSTHTMLTag

ABSTHTMLTag::$blur
ABSTHTMLTag::$click
ABSTHTMLTag::$focus
ABSTHTMLTag::$freestyle
ABSTHTMLTag::$id
ABSTHTMLTag::$mousemove
ABSTHTMLTag::$mouseout
ABSTHTMLTag::$mouseover
ABSTHTMLTag::$mouseup
ABSTHTMLTag::$name
ABSTHTMLTag::$no_format
ABSTHTMLTag::$other_attributes
ABSTHTMLTag::$style_class

Inherited Methods

Class: ABSTHTMLTag

ABSTHTMLTag::getId(): Returns the value of this tag's "id"-attribute.
ABSTHTMLTag::getName(): Returns the value of this tag's "name"-attribute.
ABSTHTMLTag::HTMLTag(): The Constructor let the script die, cause this is an abstract class!
ABSTHTMLTag::idExists(): Stores all used ids and makes sure that every id in the document is unique. It should called in every get method of classes in the packages forms and html.
ABSTHTMLTag::setAttributes(): This method allows to set the attributes of the tag that are not handled by other methods.
ABSTHTMLTag::setFreeStyle(): Set the value of style definitions that are not handled by implemented methods.
ABSTHTMLTag::setId(): Stores the value of this item's "id"-attribute.
ABSTHTMLTag::setName(): Stores the value of this tag's "name"-attribute.
ABSTHTMLTag::setNoFormat(): Stores that the HTML-elements should not format by "\r\n" in the source.
ABSTHTMLTag::setOnBlur(): Sets the value of the blur-attribute of this html-tag.
ABSTHTMLTag::setOnClick(): Sets the value of the click-attribute of this html-tag.
ABSTHTMLTag::setOnFocus(): Sets the value of the focus-attribute of this html-tag.
ABSTHTMLTag::setOnMouseMove(): Sets the value of the mousemove-attribute of this html-tag.
ABSTHTMLTag::setOnMouseOut(): Sets the value of the mouseout-attribute of this html-tag.
ABSTHTMLTag::setOnMouseOver(): Sets the value of the mouseover-attribute of this html-tag.
ABSTHTMLTag::setOnMouseUp(): Sets the value of the mouseup-attribute of this html-tag.
ABSTHTMLTag::setStyle(): Set the value of the class-attribute of this tag.

Class: ABSTObject

ABSTObject::printComplexData(): Prints out the more complex data by the given array.
ABSTObject::printPrimitiveData(): Prints out the primitive data by the given arrays.
ABSTObject::printStructure(): Prints out the Structure of this Object.
ABSTObject::same(): Checks whether the passed object reference points to this object.
ABSTObject::sameReferences(): Compares two references whether they points to the same object

Class Details

[line 67]
Creating HTML-Documents

Tags:

author:	Daniel Plücken <daniel@debakel.net>
version:	0.2.23
copyright:	Copyright (c) 2003 Daniel Plücken <daniel@debakel.net> This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
license:	GNU Lesser General Public License

[ Top ]

Class Variables

$background =

[line 185]

Stores the value of the background-attribute of the body-tag. For using a background image.

Type:

integer

[ Top ]

$behaviour = "Transitional"

[line 213]

Valid values for example are "Final", "Strict", "Transitional" or "Frameset". The standard value is "Transitional".

If "Frameset" is set as value, the body-tag will not be add!

Type:

string

[ Top ]

$behindbody =

[line 99]

The space between </body> and </html>.

Tags:

access:

public

Type:

string

[ Top ]

$bgcolor =

[line 126]

Stores the value of the bgcolor-attribute of the body-tag to set the backgroundcolor of the Site.

Type:

integer

[ Top ]

$body =

[line 92]

The content of this HTML-document.

Tags:

access:

private

Type:

string

[ Top ]

$contenttype = "HTML"

[line 205]

Valid values for example are "HTML", "XHTML", "SVG" or "MathML". The standard value is "HTML".

Type:

string

[ Top ]

$docforms =

[line 110]

Type:

mixed

[ Top ]

$docitems =

[line 108]

Type:

mixed

[ Top ]

$doctables =

[line 109]

Type:

mixed

[ Top ]

$doctype = "html"

[line 198]

Valid values for example are "html", "math" or "svg". The standard value is "html".

Type:

string

[ Top ]

$head =

[line 85]

Tags:

access:

private

Type:

string

[ Top ]

$include_doctype = true

[line 220]

Stores wether the doctype definition should include to the document or not.

Type:

boolean

[ Top ]

$leftmargin = 0

[line 132]

Stores the value of the leftmargin-attribute of the body-tag.

Type:

integer

[ Top ]

$marginheight = 0

[line 150]

Stores the value of the marginheight-attribute of the body-tag.

Type:

integer

[ Top ]

$marginwidth = 0

[line 144]

Stores the value of the marginwidth-attribute of the body-tag.

Type:

integer

[ Top ]

$meta =

[line 73]

Tags:

access:

private

Type:

array

[ Top ]

$mode = HTML_STANDARD_MODE

[line 106]

Class variable to switch the mode of the document between quirk and standard.

Type:

integer

[ Top ]

$noformat = false

[line 231]

Stores whether the document should be formatted by the PlainTextFormatter or not.

Tags:

access:

private

Type:

boolean

[ Top ]

$onblur =

[line 164]

Stores the javascript order that should execute when the browser leaves the document.

var string $onblur

Type:

mixed

[ Top ]

$onload =

[line 157]

Stores the javascript order that should execute when the browser loads the document.

Type:

string

[ Top ]

$onresize =

[line 178]

Stores the javascript order that should execute when the document will be resized.

var string $onresize

Type:

mixed

[ Top ]

$onscroll =

[line 171]

Stores the javascript order that should execute when the document will be scrolled.

var string $onscroll

Type:

mixed

[ Top ]

$text =

[line 119]

Stores the value of the text-attribute of the body-tag.

Type:

integer

[ Top ]

$title =

[line 80]

The title of this document.

Tags:

access:

private

Type:

string

[ Top ]

$topmargin = 0

[line 138]

Stores the value of the topmargin-attribute of the body-tag.

Type:

integer

[ Top ]

$version = 4.01

[line 191]

Standard is 4.01.

Type:

double

[ Top ]

Class Methods

constructor HTMLDocument [line 252]

HTMLDocument HTMLDocument(
[$title
$title = ""], [$head
$head = ""], [$body
$body = ""], [$behindbody
$behindbody = ""], [$meta_char
$meta_char = "ISO-8859-1"])

Constructor.

Tags:

version:	1.1
since:	0.1.0
access:	public

Parameters:

$title	$title	The title of the document.
$head	$head	Javascripts, stylesheets etc.
$body	$body	The content of the document.
$behindbody	$behindbody	For example javascripts after the closing body-tag.
$meta_char	$meta_char	The value of the meta-charset of this document.

[ Top ]

method get [line 865]

string get(
)

Returns a generated string based on the attributes of this HTML-Object.

Tags:

version:	1.31
since:	0.1.0
access:	public

[ Top ]

method getBackground [line 744]

string getBackground(
)

Returns the body's background-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

[ Top ]

method getBGColor [line 618]

string getBGColor(
)

Returns the current body's bgcolor-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

[ Top ]

method getBody [line 576]

string getBody(
)

Returns the current body's content of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

[ Top ]

method getHead [line 562]

string getHead(
)

Returns the current head's content of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

[ Top ]

method getLeftMargin [line 632]

string getLeftMargin(
)

Returns the current body's leftmargin-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

[ Top ]

method getMarginHeight [line 674]

string getMarginHeight(
)

Returns the current body's marginheight text-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

[ Top ]

method getMarginWidth [line 660]

string getMarginWidth(
)

Returns the current body's marginwidth-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

[ Top ]

method getMode [line 590]

integer getMode(
)

Returns the current document's mode (standard or quirk).

Tags:

version:	1.0
since:	0.2.21
access:	public

[ Top ]

method getOnBlur [line 702]

string getOnBlur(
)

Returns the body's onblur-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

[ Top ]

method getOnLoad [line 688]

string getOnLoad(
)

Returns the current body's onload-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

[ Top ]

method getOnResize [line 730]

string getOnResize(
)

Returns the body's onresize-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

[ Top ]

method getOnScroll [line 716]

string getOnScroll(
)

Returns the body's onscroll-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

[ Top ]

method getPHPSource [line 787]

string getPHPSource(
)

Generates the sourcecode to build this object and returns it.

Tags:

version:	1.01
since:	0.1.0
access:	public

[ Top ]

method getText [line 604]

string getText(
)

Returns the current body's text-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

[ Top ]

method getTitle [line 548]

string getTitle(
)

Returns the current title of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

[ Top ]

method getTopMargin [line 646]

string getTopMargin(
)

Returns the current body's topmargin-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

[ Top ]

method setBackground [line 516]

void setBackground(
string
$string)

Sets the body's background-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

Parameters:

string

$string

[ Top ]

method setBGColor [line 372]

void setBGColor(
string
$string)

Sets the body's bgcolor-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

Parameters:

string

$string

[ Top ]

method setBody [line 312]

void setBody(
string
$string)

Sets the body's content of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

Parameters:

string

$string

[ Top ]

method setHead [line 296]

void setHead(
string
$string)

Sets the head of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

Parameters:

string

$string

[ Top ]

method setLeftMargin [line 388]

void setLeftMargin(
string
$string)

Sets the body's leftmargin-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

Parameters:

string

$string

[ Top ]

method setMarginHeight [line 436]

void setMarginHeight(
string
$string)

Sets the body's marginheight-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

Parameters:

string

$string

[ Top ]

method setMarginWidth [line 420]

void setMarginWidth(
string
$string)

Sets the body's marginwidth-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

Parameters:

string

$string

[ Top ]

method setMode [line 330]

void setMode(
[integer
$int = HTML_QUIRK_MODE])

Sets the mode of this document to quirk or standard. Preselect on method call with no entered parameter is the quirk mode, because preselect of the class-initiation is the standard mode.

Tags:

version:	1.0
since:	0.2.21
access:	public

Parameters:

integer

$int

[ Top ]

method setNoFormat [line 534]

void setNoFormat(
[boolean
$boolean = true])

Sets the behaviour of body's formatting. If noformat is set to true then the body will not be formatted by the plaintextformatter. Look at package CLASSPATH."core" at the class PlainTextFormatter for further information.

Tags:

version:	1.0
since:	0.1.0
access:	public

Overrides ABSTHTMLTag::setNoFormat() (Stores that the HTML-elements should not format by "\r\n" in the source.)

Parameters:

boolean

$boolean

[ Top ]

method setOnBlur [line 468]

void setOnBlur(
string
$string)

Sets the body's onblur-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

Overrides ABSTHTMLTag::setOnBlur() (Sets the value of the blur-attribute of this html-tag.)

Parameters:

string

$string

[ Top ]

method setOnLoad [line 452]

void setOnLoad(
string
$string)

Sets the body's onload-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

Parameters:

string

$string

[ Top ]

method setOnResize [line 500]

void setOnResize(
string
$string)

Sets the body's onresize-attribute of this document.

Tags:

version:	1.0
since:	0.2.23
access:	public

Parameters:

string

$string

[ Top ]

method setOnScroll [line 484]

void setOnScroll(
string
$string)

Sets the body's onscroll-attribute of this document.

Tags:

version:	1.0
since:	0.2.23
access:	public

Parameters:

string

$string

[ Top ]

method setText [line 356]

void setText(
string
$string)

Sets the body's text-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

Parameters:

string

$string

[ Top ]

method setTitle [line 280]

void setTitle(
string
$string)

Sets the title of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

Parameters:

string

$string

[ Top ]

method setTopMargin [line 404]

void setTopMargin(
string
$string)

Sets the body's topmargin-attribute of this document.

Tags:

version:	1.0
since:	0.1.0
access:	public

Parameters:

string

$string

[ Top ]

Documentation generated on Thu, 05 Jun 2008 19:12:06 +0200 by phpDocumentor 1.4.1