JDocument [Review]

API Package Subpackage Class Reference Last reviewed Doc status
API Home Package Joomla.Framework Subpackage Document Class JDocument Reference JDocument Never Work in Progress

This is the Document class. It provides an easy interface to parse and display a document. This class is instantiated through the getInstance method. The getInstance method returns an object of the appropriate child class depending on the document type. This is a child class of the JTemplate class.

Methods

Method Description
__construct Class constructor.
addScript Adds a linked script to the page.
addScriptDeclaration Adds a script to the page.
addStyleDeclaration Adds a stylesheet declaration to the page.
addStyleSheet Adds a linked stylesheet to the page.
display Outputs the template to the browser.
execRenderer Execute a renderer.
fetchBody Return the document body.
fetchHead Return the document head.
getCharset Returns the document charset encoding.
getInstance Returns a reference to the global JDocument object, only creating it if it doesn't already exist.
getLang Returns the document language.
getTitle Return the title of the page.
parse Parse a file and create an internal patTemplate object.
setCharset Sets the document charset.
setLang Sets the global document language declaration. Default is English.
setLineEnd Sets the line end style to Windows, Mac, Unix or a custom string.
setMimeEncoding Sets the document MIME encoding that is sent to the browser.
setTab Sets the string used to indent HTML.
setTitle Sets the title of the page.
setType Sets the document type of the page.
_addRenderer Adds a renderer to be called.