Class: THead

Source Location: /Web/UI/WebControls/THead.php

Class Overview

TComponent
   |
   --TControl
      |
      --THead

THead class

Class Details

[line 64]
THead class

This component is used to provide access to the <head> HTML element through prado code. You can access it via the

 property.
 
 The THead component provides functionality that is also available through
 the TPage component (it will remain in the TPage component for cases where a THead
 component is not included on the page), including:
 
 - <b>registerScriptFile</b>
 - <b>registerStyleFile</b>
 
 Additionally, there are additional methods
 
 - <b>registerScriptBlock</b>
      <br/>Register script to be output between &lt;script&gt; tags
 - <b>registerStyleBlock</b>
      <br/>Register script to be output between &lt;style&gt; tags
 - <b>registerMetaInfo</b>
   <br/>Register information to be output in a &lt;meta&gt; tag
 
 Namespace: System.Web.UI.WebControls
 
 Properties
 - <b>Title</b>, string, kept in viewstate
   <br/>Gets or sets the &lt;title&gt; of the page
 
 Examples
 - On a page template file, insert the following line to create a THead component,
 <code>
   <com:THead Title="My Prado Page"/>

The checkbox will show "Agree" text on its right side. If the user makes any change to the Checked state, the checkAgree() method of the page class will be invoked automatically.

version:	$Revision: 1.2 $
author:	Marcus Nyeholt <tanus@users.sourceforge.net>

[ Top ]

Methods

Inherited Variables

Class: TComponent

TComponent::$children

Inherited Methods

Class: TControl

TControl::__construct(): Constructor.
TControl::addBody(): Appends an object into the body collection of this control.
TControl::addParsedObject(): Adds the object parsed in template as a body of the component.
TControl::allowBody(): Determines whether the control can add the object as a body.
TControl::clearViewState(): Clears viewstate
TControl::findBodyControl()
TControl::getAttribute()
TControl::getAttributes(): Returns the attribute list object.
TControl::getAttributesToRender(): Returns attributes to be rendered.
TControl::getBodies()
TControl::getClientID(): Returns the client ID of the component.
TControl::getContainer(): Returns the container of this component.
TControl::getSkinName()
TControl::getTagName()
TControl::getViewState(): Returns a viewstate value.
TControl::initSkin(): Initializes a skin for the control. If a skin name is provided then that skin will be loaded.
TControl::isViewStateEnabled()
TControl::isVisible(): This method checks whether a control is visible.
TControl::loadViewState(): Loads viewstate into this component and its children.
TControl::onBubbleEvent(): This method responds to a bubbled event.
TControl::onInit(): This method is invoked when the control enters 'Init' stage.
TControl::onInitRecursive(): Calls onInit of this control and its children recursively.
TControl::onLoad(): This method is invoked when the control enters 'Load' stage.
TControl::onLoadRecursive(): Calls onLoad of this control and its children recursively.
TControl::onPreRender(): This method is invoked when the control enters 'PreRender' stage.
TControl::onPreRenderRecursive(): Calls onPreRender of this control and its children recursively.
TControl::onUnload(): This method is invoked when the control enters 'Unload' stage.
TControl::onUnloadRecursive(): Calls onUnload of this control and its children recursively.
TControl::raiseBubbleEvent(): Invokes the parent's onBubbleEvent method.
TControl::removeBodies(): Removes all body content.
TControl::render(): Renders this control.
TControl::renderAttributes(): Renders the attributes.
TControl::renderBody(): Renders the body content.
TControl::saveViewState(): Returns the viewstate of this component and its children.
TControl::setAttribute(): Sets an attribute.
TControl::setContainer(): Sets the container of this component
TControl::setEnableViewState()
TControl::setSkinName(): Sets the skin to use for this control
TControl::setTagName(): Sets the tag name.
TControl::setViewState(): Sets a viewstate value.
TControl::setVisible()
TControl::synchronizeControl(): This method should only be used by framework developer.

Class: TComponent

TComponent::__construct(): Constructor.
TComponent::addChild(): Adds a child component.
TComponent::addParsedObject(): Handles a component or string met in template.
TComponent::attachEventHandler(): Attaches a handler function to an event.
TComponent::bindProperty(): Sets up the binding between a property and an expression.
TComponent::canGetProperty(): Determines whether a property can be read.
TComponent::canSetProperty(): Determines whether a property can be written.
TComponent::createComponent(): Creates a child component.
TComponent::dataBind(): Performs the databinding for this component.
TComponent::evaluateExpression(): Evaluates a PHP expression.
TComponent::evaluateStatements(): Evaluates a list of PHP statements.
TComponent::findObject(): Finds an object by its ID path.
TComponent::getApplication()
TComponent::getChild()
TComponent::getChildren()
TComponent::getDefinition(): Returns or builds a component definition.
TComponent::getGlobalization(): Returns the Globalization instance for the application.
TComponent::getID()
TComponent::getModule(): Returns the module object that contains the component or the page containing the component.
TComponent::getPage()
TComponent::getParent()
TComponent::getPropertyInitValue(): Gets the initial value of a property.
TComponent::getPropertyType(): Returns the type of a property
TComponent::getRequest(): Returns the request object associated with application.
TComponent::getServiceManager(): Returns the service manager for this application.
TComponent::getSession(): Returns the session object associated with the application.
TComponent::getSessionState(): Returns a session variable.
TComponent::getUniqueID(): Returns the unique ID of the component.
TComponent::getUser(): Returns the user object associated with the application.
TComponent::hasChildren()
TComponent::hasEvent(): Determines whether an event is defined.
TComponent::hasProperty(): Determines whether a property is defined.
TComponent::initProperties(): Initializes the property values.
TComponent::instantiateTemplate(): Parses a template string and instantiates the content.
TComponent::onDataBinding(): This method is invoked when dataBind is invoked for the component.
TComponent::raiseEvent(): Invokes all attached event handler functions for a particular event.
TComponent::removeChild(): Removes a child component.
TComponent::removeChildren(): Removes all child components.
TComponent::setAttribute(): Sets an attribute.
TComponent::setDefinition(): Sets a component definition.
TComponent::setID(): Sets a component ID.
TComponent::setParent(): Sets the parent of this component.
TComponent::setPropertyInitValue(): Sets the initial value of a property.
TComponent::setRoot(): Sets the root component in the component hierarchy.
TComponent::setSessionState(): Sets a session variable.
TComponent::unbindProperty(): Breaks the binding between a property and an expression.
TComponent::__get(): Returns a property value by name or a child component by ID.
TComponent::__set(): Sets value of a component property.

Class Methods

method getTitle [line 86]

string getTitle(
)

Get the title of the page

return:	The page title.
access:	public

[ Top ]

method isMetaNameTagRegistered [line 170]

boolean isMetaNameTagRegistered(
string
$key, [string
$lang = 'en'])

Indicates whether the named meta tag has been registered before.

access:	public
see:	registerMetaTag()

Parameters:

string	$key	the name of tag
string	$lang	the lang of the tag

[ Top ]

method isScriptFileRegistered [line 147]

boolean isScriptFileRegistered(
string
$key)

Indicates whether the named scriptfile has been registered before.

access:	public
see:	THead::registerScriptFile()

Parameters:

string

$key

the name of the scriptfile

[ Top ]

method isStyleFileRegistered [line 158]

boolean isStyleFileRegistered(
string
$key)

Indicates whether the named CSS style file has been registered before.

access:	public
see:	THead::registerStyleFile()

Parameters:

string

$key

the name of the style file

[ Top ]

method registerMetaNameTag [line 134]

void registerMetaNameTag(
string
$key, string
$content, [string
$lang = 'en'])

Registers a meta tag to be imported with the page body

access:	public
see:	isMetaTagRegistered()

Parameters:

string	$key	a key that identifies the meta tag to avoid repetitive registration
string	$content	the content of the meta tag
string	$lang	the language of the tag

[ Top ]

method registerScriptFile [line 107]

void registerScriptFile(
string
$key, string
$scriptFile)

Registers a javascript file to be loaded in client side

access:	public
see:	THead::isScriptFileRegistered()

Parameters:

string	$key	a key that identifies the script file to avoid repetitive registration
string	$scriptFile	the javascript file which can be relative or absolute URL

[ Top ]

method registerStyleFile [line 120]

void registerStyleFile(
string
$key, string
$styleFile)

Registers a CSS style file to be imported with the page body

access:	public
see:	THead::isStyleFileRegistered()

Parameters:

string	$key	a key that identifies the style file to avoid repetitive registration
string	$styleFile	the javascript file which can be relative or absolute URL

[ Top ]

method render [line 179]

the render(
)

Render the <head> tag

return:	rendering result.
access:	public

Overrides TControl::render() (Renders this control.)

[ Top ]

method renderMetaNameTags [line 237]

the renderMetaNameTags(
)

Renders the registered meta tags to be included

return:	rendering result
access:	public

[ Top ]

method renderScripts [line 207]

the renderScripts(
)

Renders the registered javascript files to be included

return:	rendering result
access:	public

[ Top ]

method renderStyles [line 219]

the renderStyles(
)

Renders the registered CSS style files to be included

return:	rendering result
access:	public

[ Top ]

method setTitle [line 96]

void setTitle(
string
$value)

Set the title of the page

access:

public

Parameters:

string

$value

The page's title

[ Top ]