phpDocumentor base
[ class tree: base ] [ index: base ] [ all elements ]

Class: Legend

Source Location: /myphp-1.9/myphp-1.9-base/html/util/Legend.php

Class Legend

Class Overview

Generates an LEGEND form element

  1. Usage:
  2. $legend = new Legend($text,$class,$accesskey);
  3. print $legend->getHtml();
  4. Or
  5. Legend::display($text,$class,$accesskey);

Located in /myphp-1.9/myphp-1.9-base/html/util/Legend.php [line 29]

Object
   |
   --Html
      |
      --Legend

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Html

Html::$elements
Html::$sizeof

Inherited From Object

Object::$cachefile
Object::$html
Object::$sql

Inherited From Html

Html::Html()
Constructor
Html::add()
Add an element, the number of elements are stored internally in an array.
Html::content()
Read the content of the specified filename
Html::display()
Display the html
Html::get()
Get the complete html for a key
Html::getAttribute()
Get the complete html for an attribute, i.e. <a class="myclass" ...
Html::getElement()
Get the element at position $i in array
Html::getElements()
Get all the elements as html
Html::getHtml()
Get Html
Html::getHtmlHelp()
Get html help
Html::getSizeof()
Get the number of elements added
Html::getTag()
Get the complete html for a html tag, i.e. <p>My paragraph</p>
Html::read()
Read the content of the specified filename and language
Html::set()
Set the named attribute (key) of a class to specified value
Html::setObject()
Set the named object to the class attribute (key), with same name
Html::showsource()
Show source
Html::update()
Save the content of the specified filename and language

Inherited From Object

Object::Object()
Constructor
Object::addHtml()
Add the current html to the SourceCode object
Object::getCacheFileName()
Returns the name of the cache file name
Object::getClassName()
Returns the name of the instanciated class
Object::getHtml()
Returns the html for the element
Object::getMsg()
Get the formatted message and debug level and Log to file ?
Object::save()
Save the SQL cache file
Object::setCacheFileName()
Set the path/name of the cache file
Object::toString()
Returns the information for this class
Object::write()
Write the content to the file opened by fp

[ Top ]
Property Summary
String   $accesskey  
String   $class  
String   $text  

[ Top ]
Method Summary
Legend   Legend()   Constructor
void   display()   Display html
String   getHtml()   Returns the html for the legend control

[ Top ]
Properties
String   $accesskey = '' [line 43]

[ Top ]
String   $class = '' [line 38]

[ Top ]
String   $text = '' [line 33]

[ Top ]
Methods
Constructor Legend  [line 51]

  Legend Legend( String $text, [String $class = ''], [String $accesskey = '']  )

Constructor

Parameters:
String   $text:  The text to show
String   $class:  The class name
String   $accesskey:  The access key


[ Top ]
display  [line 86]

  void display( String $text, [String $class = ''], [String $accesskey = '']  )

Display html

  1. Usage:
  2. Legend::display($text,$class,$accesskey);

Parameters:
String   $text:  The text to show
String   $class:  The class name
String   $accesskey:  The access key

API Tags:
Static:  


Redefinition of:
Html::display()
Display the html

[ Top ]
getHtml  [line 62]

  String getHtml( )

Returns the html for the legend control


API Tags:
Return:  the complete html


Redefinition of:
Html::getHtml()
Get Html

[ Top ]

Documentation generated on Thu, 22 Dec 2005 17:12:40 +0100 by phpDocumentor 1.3.0RC3