Class HTMLObject

Description

An HTMLObject is any object which will be rendered in HTML according to the basic syntax defined for HTML.

Located in /html-defs.php (line 183)

RenderableObject
   |
   --StylableObject
      |
      --HTMLObject
Direct descendents
Class Description
 class form Form class
 class form_field Form Field class Abstract field class, for deriving various form field types.
 class forum The forum class.
 class tablecell tablecell
 class table Table.
 class anchor [A] - The anchor tag, otheriwse know as a clickable link.
 class hr [HR] - Horizontal Rule
 class img [IMG] - The img class. This is an object which renders the img tag.
 class embed Deprecated embed Object (HTML3.2) This object supports the older embed tag used to embed objects into HTML pages. for backward compatibility. In reality there is still a lot of mileage left in this tag.
 class EmbeddedObject Object
 class maintainer Class comprising functionality which allows a database table to be maintained through a user interface which allows the usual Add, Modify, Delete options, but which gets just about all the info it requires from the database schema itself. A dynamic maintainer.
 class menumaintainer Menu Maintainer
 class user_self_registration Self-registration class.
Variable Summary
 mixed $accesskey
 mixed $align
 mixed $alt
 mixed $bgcolor
 mixed $bgurl
 mixed $border
 mixed $color
 mixed $height
 mixed $hspace
 mixed $lang
 mixed $langdir
 mixed $name
 mixed $onblur
 mixed $onchange
 mixed $onclick
 mixed $ondblclick
 mixed $onfocus
 mixed $onkeydown
 mixed $onkeypress
 mixed $onkeyup
 mixed $onload
 mixed $onmousedown
 mixed $onmousemove
 mixed $onmouseout
 mixed $onmouseover
 mixed $onmouseup
 mixed $onselect
 mixed $size
 mixed $src
 mixed $tabindex
 mixed $target
 mixed $title
 mixed $valign
 mixed $vspace
 mixed $width
Method Summary
 HTMLObject HTMLObject ([mixed $css = ""], string $class_style)
 void inherit_attributes (object $obj)
 void setaccesskey (mixed $key)
 void setalign (mixed $align)
 void setalt (mixed $alt)
 void setbackground (mixed $bgurl)
 void setbgcolor (mixed $bgcolor)
 void setborder (mixed $px)
 void setcolor (mixed $color)
 void setheight (mixed $height)
 void sethspace (mixed $px)
 void setlang (mixed $lang)
 void setlangdir (mixed $langdir)
 void setname (mixed $name)
 void setsize (mixed $size)
 void setsrc (mixed $src)
 void settabindex (mixed $ix)
 void settarget (mixed $target)
 void settitle (mixed $title)
 void setvalign (mixed $valign)
 void setvspace (mixed $px)
 void setwidth (mixed $width)
 void set_attribute (string $attrname, [string $attrvalue = "???"])
 void set_linkover_text ([string $txt = ""])
 void set_onblur (mixed $script, [mixed $mode = SCRIPT_REPLACE])
 void set_onchange (mixed $script, [mixed $mode = SCRIPT_REPLACE])
 void set_onclick (mixed $script, [mixed $mode = SCRIPT_REPLACE])
 void set_ondblclick (mixed $script, [mixed $mode = SCRIPT_REPLACE])
 void set_onfocus (mixed $script, [mixed $mode = SCRIPT_REPLACE])
 void set_onkeydown (mixed $script, [mixed $mode = SCRIPT_REPLACE])
 void set_onkeypress (mixed $script, [mixed $mode = SCRIPT_REPLACE])
 void set_onkeyup (mixed $script, [mixed $mode = SCRIPT_REPLACE])
 void set_onload (mixed $script, [mixed $mode = SCRIPT_REPLACE])
 void set_onmousedown (mixed $script, [mixed $mode = SCRIPT_REPLACE])
 void set_onmousemove (mixed $script, [mixed $mode = SCRIPT_REPLACE])
 void set_onmouseout (mixed $script, [mixed $mode = SCRIPT_REPLACE])
 void set_onmouseover (mixed $script, [mixed $mode = SCRIPT_REPLACE])
 void set_onmouseup (mixed $script, [mixed $mode = SCRIPT_REPLACE])
 void set_onselect (mixed $script, [mixed $mode = SCRIPT_REPLACE])
 void set_tabindex (mixed $ix)
 void taghtml (mixed $tag)
Variables
mixed $accesskey (line 189)

Access key of the object

mixed $align (line 197)

Alignment of the object: left, right, center

mixed $alt (line 203)

ALT text for this object

mixed $bgcolor (line 221)

Background colour of the object

mixed $bgurl (line 223)

Background image url

mixed $border (line 217)

Border size (pixels)

mixed $color (line 219)

Foreground/text colour of the object

mixed $height (line 195)

Height of the object

mixed $hspace (line 213)

Horizontal space around object (pixels)

mixed $lang (line 207)

Language code for text content in this object

mixed $langdir (line 209)

Direction for text - 'LTR' (left-to-right) or 'RTL' (right-to-left)

mixed $linkover_text = "" (line 261)

Text to display in statusbar when mouse over object

mixed $name (line 185)

Name of the object

mixed $onblur (line 245)

Script to call onblur

mixed $onchange (line 251)

Script to call onchange

mixed $onclick (line 225)

Script to call when mouse clicked

mixed $ondblclick (line 227)

Script to call when mouse double-clicked

mixed $onfocus (line 247)

Script to call onfocus

mixed $onkeydown (line 229)

Script to call on key down

mixed $onkeypress (line 231)

Script to call on key pressed

mixed $onkeyup (line 233)

Script to call on key up

mixed $onload (line 249)

Script to call onload

mixed $onmousedown (line 235)

Script to call on mouse button down

mixed $onmousemove (line 237)

Script to call on mouse button down

mixed $onmouseout (line 239)

Script to call on mouse off object

mixed $onmouseover (line 241)

Script to call on mouse over object

mixed $onmouseup (line 243)

Script to call on mouse button up

mixed $onselect (line 253)

Script to call onselect

mixed $size (line 191)

Size of the object

mixed $src (line 205)

Source URL for this object

mixed $tabindex (line 187)

TAB index of the object

mixed $target (line 211)

Traget frame for this object


Redefined in descendants as:
mixed $title (line 201)

Title of the object


Redefined in descendants as:
mixed $user_attributes = array() (line 257)

User-defined attributes

mixed $valign (line 199)

Vertical alignment: top, bottom, middle

mixed $vspace (line 215)

Vertical space around object (pixels)

mixed $width (line 193)

Width of the object

Inherited Variables

Inherited from StylableObject

StylableObject::$class
StylableObject::$id
StylableObject::$style
Methods
Constructor HTMLObject (line 268)

Constructor Create a HTMLObject. Sets basic field attributes.

HTMLObject HTMLObject ([mixed $css = ""], string $class_style)
  • string $class_style: Classname or Style setting to apply
inherit_attributes (line 446)

This sets our attributes from another object which is a descendant of HTMLObject. The attributes are specially selected to be only those which are associated with the basic appearance of the object.

void inherit_attributes (object $obj)
  • object $obj: HTMLObject object instance to inherit attributes from
setaccesskey (line 282)

Set the access key of the object

void setaccesskey (mixed $key)
setalign (line 294)

Set the horizontal alignment eg: left, center, right

void setalign (mixed $align)
setalt (line 303)

Set the ALT text

void setalt (mixed $alt)
setbackground (line 336)

Set the background image (url)

void setbackground (mixed $bgurl)
setbgcolor (line 333)

Set the background colour

void setbgcolor (mixed $bgcolor)
setborder (line 327)

Border thickness (pixels)

void setborder (mixed $px)
setcolor (line 330)

Set the foreground colour

void setcolor (mixed $color)
setheight (line 291)

Set the height specifier of the element

void setheight (mixed $height)
sethspace (line 321)

Horizontal spacing (pixels)

void sethspace (mixed $px)
setlang (line 309)

Set the language for text content

void setlang (mixed $lang)
setlangdir (line 312)

Set the text direction for text content: 'rtl' or 'ltr'

void setlangdir (mixed $langdir)
setname (line 273)

Set the name of the object

void setname (mixed $name)
setsize (line 285)

Set the size specifier of the element

void setsize (mixed $size)
setsrc (line 306)

Set the src URL/relative path

void setsrc (mixed $src)
settabindex (line 276)

Set the TAB index of the object (with alias)

void settabindex (mixed $ix)
settarget (line 318)

Set the frame target.

void settarget (mixed $target)
settitle (line 300)

Set the title of this element

void settitle (mixed $title)
setvalign (line 297)

Set the vertical-alignment eg: top, middle, bottom

void setvalign (mixed $valign)
setvspace (line 324)

Vertical spacing (pixels)

void setvspace (mixed $px)
setwidth (line 288)

Set the width specifier of the element

void setwidth (mixed $width)
set_attribute (line 436)

This defines a key=value pair which will be rendered in the form of '$attrname="$attrvalue"' inside the HTML object tag when rendered.

It is provided to cater for attributes not defined explicitly. NOTES: If you omit the attribute value, the attribute will be rendered as just '$attrname', without any value clause.

void set_attribute (string $attrname, [string $attrvalue = "???"])
  • string $attrname: Name or idenitifier of attribute
  • string $attrvalue: Value of the attribute (not rendered if omitted)
set_linkover_text (line 469)

Defines the text to show when the mouse moves over the object.

void set_linkover_text ([string $txt = ""])
  • string $txt: Text to show in status area when mouse-over.
set_onblur (line 399)

Set the onblur script

void set_onblur (mixed $script, [mixed $mode = SCRIPT_REPLACE])
set_onchange (line 417)

Set the onchange script

void set_onchange (mixed $script, [mixed $mode = SCRIPT_REPLACE])
set_onclick (line 339)

Set the on click script

void set_onclick (mixed $script, [mixed $mode = SCRIPT_REPLACE])
set_ondblclick (line 345)

Set the on doubleclick script

void set_ondblclick (mixed $script, [mixed $mode = SCRIPT_REPLACE])
set_onfocus (line 405)

Set the onfocus script

void set_onfocus (mixed $script, [mixed $mode = SCRIPT_REPLACE])
set_onkeydown (line 351)

Set the on keydown script

void set_onkeydown (mixed $script, [mixed $mode = SCRIPT_REPLACE])
set_onkeypress (line 357)

Set the on keypress script

void set_onkeypress (mixed $script, [mixed $mode = SCRIPT_REPLACE])
set_onkeyup (line 363)

Set the on keyup script

void set_onkeyup (mixed $script, [mixed $mode = SCRIPT_REPLACE])
set_onload (line 411)

Set the onload script

void set_onload (mixed $script, [mixed $mode = SCRIPT_REPLACE])
set_onmousedown (line 369)

Set the on mousedown script

void set_onmousedown (mixed $script, [mixed $mode = SCRIPT_REPLACE])
set_onmousemove (line 375)

Set the on mousemove script

void set_onmousemove (mixed $script, [mixed $mode = SCRIPT_REPLACE])
set_onmouseout (line 381)

Set the on mouseout script

void set_onmouseout (mixed $script, [mixed $mode = SCRIPT_REPLACE])
set_onmouseover (line 387)

Set the on mouseover script

void set_onmouseover (mixed $script, [mixed $mode = SCRIPT_REPLACE])
set_onmouseup (line 393)

Set the on mouseup script

void set_onmouseup (mixed $script, [mixed $mode = SCRIPT_REPLACE])
set_onselect (line 423)

Set the onselect script

void set_onselect (mixed $script, [mixed $mode = SCRIPT_REPLACE])
set_tabindex (line 279)

Alias for settabindex(), deprecated, backward compat.

void set_tabindex (mixed $ix)
taghtml (line 478)

Render the full tag. This method renders the given tag including all the attributes, as HTML.

void taghtml (mixed $tag)

Inherited Methods

Inherited From StylableObject

 StylableObject::StylableObject()
 StylableObject::clearstyle()
 StylableObject::setclass()
 StylableObject::setcss()
 StylableObject::setid()
 StylableObject::setstyle()

Inherited From RenderableObject

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

Documentation generated by phpDocumentor 1.3.0RC3