Class WMLcontainer

Description

WMLcontainer class Container Class: Extends element class to make a virtual class for descendants which are container of basic elements. Examples of these would be a WMLtemplate, or a WMLcard.

Located in /wml-defs.php (line 526)

RenderableObject
   |
   --WMLelement
      |
      --WMLcontainer
Direct descendents
Class Description
 class WMLtemplate WMLtemplate class Extends container class to make a template. These are useful when you have a bunch of cards which you want to all have a common set of options.
 class WMLcard WMLcard class Manage WML cards.
Variable Summary
 mixed $ontimerhref
 mixed $timerval
Method Summary
 WMLcontainer WMLcontainer ([string $body = ""])
 void insert_go (string $name, string $label, string $href)
 void insert_prev (string $label)
 void insert_refresh (string $label)
 void set_ontimer (string $href, [integer $secs = 1])
Variables
mixed $ontimerhref (line 528)

URL to go to when timer expires

mixed $timerval (line 530)

Timer expiry interval (in 10ths of seconds)

Inherited Variables

Inherited from WMLelement

WMLelement::$body
Methods
Constructor WMLcontainer (line 537)

Constructor Create a new container object.

WMLcontainer WMLcontainer ([string $body = ""])
  • string $body: Initial body content
insert_go (line 559)

Insert GO element into container

void insert_go (string $name, string $label, string $href)
  • string $name: Name for this GO element
  • string $label: Label for this GO element
  • string $href: URL to go to when clicked by user
insert_prev (line 568)

Insert PREV element into container

void insert_prev (string $label)
  • string $label: Label for this PREV element
insert_refresh (line 577)

Insert REFRESH element into container

void insert_refresh (string $label)
  • string $label: Label for this REFRESH element
set_ontimer (line 548)

Activate a timer Sets up the parameters for a timer.

void set_ontimer (string $href, [integer $secs = 1])
  • string $href: URL to go to on timer expiry
  • integer $secs: Timer expiry time, in seconds

Inherited Methods

Inherited From WMLelement

 WMLelement::WMLelement()
 WMLelement::insert()
 WMLelement::insert_para()
 WMLelement::insert_paragraph()
 WMLelement::insert_para_scrubbed()

Inherited From RenderableObject

 RenderableObject::RenderableObject()
 RenderableObject::html()
 RenderableObject::render()
 RenderableObject::wml()
 RenderableObject::wmlup()
 RenderableObject::xml()

Documentation generated by phpDocumentor 1.3.0RC3