Overview Module Function Class I*Tea 3.6.8 Reference Documentation© 2013 PDM&FC

Class HtmlPage

HtmlPage -> HtmlContainer

This container widget represents an HTML document (including <header> and <body> tags). It supports the following attributes:

Method Summary
addMeta tag value content
         Adds another meta element to the document header.
addScript aScript
         Adds a script piece to the contents of the script element.
clearMetas
         Removes all the previsouly registered meta elements.
clearScripts
         Forgets all the scripts previsouly added with the addScript method.
constructor
         Initializes the object.
get attribName
         Fetches the value of an attribute.
init attribList
         Initializes the values of a set of attributes.
set attribName attribValue
         Changes the values of one of the widget attributes.

Method Detail

addMeta

HtmlPage addMeta tag value content

Adds another meta element to the document header.

Parameters:
tag - The name of the tag for the meta element.
value - The value of the tag attribute.
content - The value of the content attribute.


addScript

HtmlPage addScript aScript

Adds a script piece to the contents of the script element.

Parameters:
aScript - String representing the script piece.

The strings representing the script pieces added with this method are concatenaed and the result is used as the contents of the script element in the document header.

It is the caller responsability to ensure that aScript is indeed a valid piece of script to be added to the HTML document.


clearMetas

HtmlPage clearMetas

Removes all the previsouly registered meta elements.


clearScripts

HtmlPage clearScripts

Forgets all the scripts previsouly added with the addScript method.


constructor

HtmlPage constructor

Initializes the object.


get

HtmlPage get attribName

Fetches the value of an attribute.

Parameters:
attribName - Symbol identifying the attribute whose value is being fetched.
Returns:
The value of the attribName attribute.

The attribName argument must be one of the supported attributes.

init

HtmlPage init attribList

Initializes the values of a set of attributes.

Parameters:
attribList - A list with the attributes and its values.
Returns:
A reference to the object for which the method was called.

Initializes attributes of the widget. These are attributes known to the set and get methods.

The attribList argument contains the attributes names and values. It is a list where each element specifies an attribute. Each element is a two element list: a symbol identifying the attribute and its new value.


set

HtmlPage set attribName attribValue

Changes the values of one of the widget attributes.

Parameters:
attribName - Symbol identifying the attribute whose value will be modified.
attribValue - The new value of the attribute.
Returns:
A reference to the object for which the method was called.

The attribName argument must be the same as one of the symbols passed to the init method, otherwise a runtime error will occur.


Overview Module Function Class ${tea.teadoc.header}
Report a bug or request new features
© 2013