Class DocumentObject

Description

Document Object

In actual fact, we don't view Documents as Embedded objects, and instead we provide a link to either open a new window, or target a new browser window. We point the URL'sto the document, and let the system do what it thinks best after that.

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

RenderableObject
   |
   --StylableObject
      |
      --HTMLObject
         |
         --EmbeddedObject
            |
            --DocumentObject
Variable Summary
 mixed $docurl
Method Summary
 DocumentObject DocumentObject (string $docurl, [integer $width = ""], [integer $height = ""])
 void AsIcon ([string $tooltip = ""], [object $iconimage = false])
 string html ()
Variables
Methods
Constructor DocumentObject (line 4019)

Constructor

DocumentObject DocumentObject (string $docurl, [integer $width = ""], [integer $height = ""])
  • string $docurl: URL of the document file
  • integer $width: Width of window showing spreaddocurl
  • integer $height: Height of window showing spreaddocurl
AsIcon (line 4037)

Render the document object as an image 'icon' which can be clicked to play the media. If image is specified, it must be a valid 'image' object, otherwise a generic library symbol will be used.

  • see: img, @see clickable_image
void AsIcon ([string $tooltip = ""], [object $iconimage = false])
  • string $tooltip: Optional browser mouseover tooltip text
  • object $iconimage: A custom image object
html (line 4066)

Render the HTML

  • return: HTML for this object
string html ()

Redefinition of:
EmbeddedObject::html()
Render the HTML

Inherited Methods

Inherited From EmbeddedObject

 EmbeddedObject::EmbeddedObject()
 EmbeddedObject::add_embed()
 EmbeddedObject::AsLink()
 EmbeddedObject::html()
 EmbeddedObject::setparam()

Inherited From HTMLObject

 HTMLObject::HTMLObject()
 HTMLObject::inherit_attributes()
 HTMLObject::setaccesskey()
 HTMLObject::setalign()
 HTMLObject::setalt()
 HTMLObject::setbackground()
 HTMLObject::setbgcolor()
 HTMLObject::setborder()
 HTMLObject::setcolor()
 HTMLObject::setheight()
 HTMLObject::sethspace()
 HTMLObject::setlang()
 HTMLObject::setlangdir()
 HTMLObject::setname()
 HTMLObject::setsize()
 HTMLObject::setsrc()
 HTMLObject::settabindex()
 HTMLObject::settarget()
 HTMLObject::settitle()
 HTMLObject::setvalign()
 HTMLObject::setvspace()
 HTMLObject::setwidth()
 HTMLObject::set_attribute()
 HTMLObject::set_linkover_text()
 HTMLObject::set_onblur()
 HTMLObject::set_onchange()
 HTMLObject::set_onclick()
 HTMLObject::set_ondblclick()
 HTMLObject::set_onfocus()
 HTMLObject::set_onkeydown()
 HTMLObject::set_onkeypress()
 HTMLObject::set_onkeyup()
 HTMLObject::set_onload()
 HTMLObject::set_onmousedown()
 HTMLObject::set_onmousemove()
 HTMLObject::set_onmouseout()
 HTMLObject::set_onmouseover()
 HTMLObject::set_onmouseup()
 HTMLObject::set_onselect()
 HTMLObject::set_tabindex()
 HTMLObject::taghtml()

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