Class EmbeddedObject

Description

Object

This HTML4 entity is the preferred method for embedding objects into a webpage using the object tag. The only drawback is that a lot of browsers don't support it fully, hence the older embed tag is also available for use as a fallback mechanism via the add_embed() method.

  • see: function add_embed

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

RenderableObject
   |
   --StylableObject
      |
      --HTMLObject
         |
         --EmbeddedObject
Direct descendents
Class Description
 class FlashObject Macromedia Shockwave/Flash Object
 class MediaObject Generic Multimedia Object
 class DocumentObject Document Object
Variable Summary
 mixed $aslink
 mixed $category
 mixed $classid
 mixed $codebase
 mixed $codetype
 mixed $data
 mixed $embed_obj
 mixed $icon
 mixed $mimetype
 mixed $params
 mixed $pluginspage
 mixed $standby
Method Summary
 EmbeddedObject EmbeddedObject ([string $src = ""], [string $mimetype = ""], [string $classid = ""], integer $width, integer $height, [string $codebase = ""], [string $standby = "Loading.."])
 void add_embed ([string $src = ""], [string $pluginspage = ""])
 void AsLink ([string $linktext = ""], [mixed $target = ""])
 string html ()
 void setparam (string $name, string $value)
Variables
mixed $aslink = "" (line 3557)

If not empty, render as a link using $aslink as the text

mixed $aslink_target = "" (line 3560)

Target frame for the $aslink

mixed $category = "" (line 3540)

Mimetype category, eg: 'movie', 'audio' etc.

mixed $classid (line 3525)

URL for the object's implementation

mixed $codebase (line 3528)

URL for relative base for accessing object

mixed $codetype (line 3532)

Object MIME type

mixed $data (line 3530)

URL of data object might require

mixed $embed_obj (line 3551)

If set, contains a EmbeddedObject_Compat object to

mixed $extn_mimetype = "" (line 3538)

MIMETYPE of file by using its extension

mixed $icon (line 3542)

Image which acts as a play icon

mixed $internal_name = "obj" (line 3554)

Internal name sans spaces

mixed $mimetype = "" (line 3523)

MIME type of data required by the object

mixed $params = array() (line 3547)

Array of parameter key-values

mixed $pluginspage = "" (line 3536)

URL of page to acquire the relevant embed plugin

mixed $standby (line 3534)

Standby message text

Inherited Variables

Inherited from HTMLObject

HTMLObject::$accesskey
HTMLObject::$align
HTMLObject::$alt
HTMLObject::$bgcolor
HTMLObject::$bgurl
HTMLObject::$border
HTMLObject::$color
HTMLObject::$height
HTMLObject::$hspace
HTMLObject::$lang
HTMLObject::$langdir
HTMLObject::$linkover_text
HTMLObject::$name
HTMLObject::$onblur
HTMLObject::$onchange
HTMLObject::$onclick
HTMLObject::$ondblclick
HTMLObject::$onfocus
HTMLObject::$onkeydown
HTMLObject::$onkeypress
HTMLObject::$onkeyup
HTMLObject::$onload
HTMLObject::$onmousedown
HTMLObject::$onmousemove
HTMLObject::$onmouseout
HTMLObject::$onmouseover
HTMLObject::$onmouseup
HTMLObject::$onselect
HTMLObject::$size
HTMLObject::$src
HTMLObject::$tabindex
HTMLObject::$target
HTMLObject::$title
HTMLObject::$user_attributes
HTMLObject::$valign
HTMLObject::$vspace
HTMLObject::$width

Inherited from StylableObject

StylableObject::$class
StylableObject::$id
StylableObject::$style
Methods
Constructor EmbeddedObject (line 3571)

Constructor

EmbeddedObject EmbeddedObject ([string $src = ""], [string $mimetype = ""], [string $classid = ""], integer $width, integer $height, [string $codebase = ""], [string $standby = "Loading.."])
  • string $src: URL of the source datafor the object, if any
  • string $mimetype: Mimetypeof the embedded object
  • string $classid: The classid (CLSID) unique ID of this object
  • integer $width: Width of object
  • integer $height: Height of object
  • string $codebase: URL of code location for this object
  • string $standby: Standby message whilst loading
add_embed (line 3624)

Add an embed object to provide fallback for browsers which do not support the object tag properly.

void add_embed ([string $src = ""], [string $pluginspage = ""])
  • string $src: The URL of the source data for this object
  • string $pluginspage: The URL for downloading the relevant plugin
AsLink (line 3639)

Render the object as a simple link. The parameter passed will be the text of the link, and the URL is determined by the location of the object as specified in the constructor.

void AsLink ([string $linktext = ""], [mixed $target = ""])
  • string $linktext: Text to use for the link
html (line 3647)

Render the HTML

  • return: HTML for this object
string html ()

Redefinition of:
RenderableObject::html()
Return output suitable for normal HTML-capable device. This method must be over-ridden by a method of the same name in the descendant class which renders output to web browsers.

Redefined in descendants as:
setparam (line 3612)

Set up a new object parameter name/value pair. This will be rendered as a param name="foo" value="bar" tag.

void setparam (string $name, string $value)
  • string $name: Name of the new param entity
  • string $value: Value of the new param entity

Inherited Methods

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