Class: TextWidget

Source Location: /framework/template/widgets/widgets.inc.php

http://wact.sourceforge.net/index.php/TextWidget

Class Overview

Component
   |
   --TextWidget

Allows plain text to be added Widgets are runtime components which have no compile time template tag.

Variables

$text

Methods

Inherited Variables

Class: Component

Component::$children
Component::$id
Component::$IsDynamicallyRendered
Component::$parent

Inherited Methods

Class: Component

Component::addChild(): Adds a reference to a child component to this component, using it's ID attribute as the child array key
Component::findChild(): Returns a child component given it's ID.
Component::findChildByClass(): Returns the first child component matching the supplied WACT_TEMPLATE Component PHP class name
Component::findParentByClass(): Recursively searches through parents of this component searching for a given WACT_TEMPLATE component PHP class name
Component::getChild(): Same as find child, except raises error if child is not found
Component::getServerId(): Returns the ID of the component, as defined in the template tags ID attribute
Component::render(): Outputs the component, rendering any child components as well This method will only ever be called on components that support Dynamic rendering.
Component::setChildDataSource(): set the data source of a child component, or raise an error if the child is not found.

Class Details

Allows plain text to be added Widgets are runtime components which have no compile time template tag.

They can be created and added by the PHP script controlling the template.

access:	public
see:	http://wact.sourceforge.net/index.php/TextWidget

Class Variables

$text =

Text to add

Type:

string

Class Methods

constructor TextWidget

Constructs TextComponent

TextWidget TextWidget(
string
$text)

API Tags:

access:

public

Parameters:

string

$text

text to add

method addChild

Override parent method to prevent use of children

void addChild(
)

API Tags:

access:

public

Overrides Component::addChild() (Adds a reference to a child component to this component, using it's ID attribute as the child array key)

method render

Outputs the text Widget.

void render(
)

API Tags:

access:

public

Overrides Component::render() (Outputs the component, rendering any child components as well This method will only ever be called on components that support Dynamic rendering.)

Documentation generated on Sun, 28 Nov 2004 19:51:43 -0800 by phpDocumentor 1.2.3