Class hover

Description

Hover class Provides and image which changes to a second image when the mouse is over the top of it, using onmouseover and onmouseout events.

Located in /image-defs.php (line 248)

RenderableObject
   |
   --hover
Variable Summary
 mixed $img
 mixed $img_over
 mixed $name
 mixed $name_over
 mixed $url
Method Summary
 hover hover (string $name, string $url, string $alt)
 string html ()
 void set_image (string $src, integer $width, integer $height, integer $border)
 void set_image_over (string $src, integer $width, integer $height, integer $border)
Variables
mixed $images_defined = false (line 266)

Flag, true if images have been defined

mixed $img (line 260)

Image object

mixed $img_over (line 263)

Image over object

mixed $name = "" (line 251)

Name of this element

mixed $name_over = "" (line 253)

Name of the over version of this element

mixed $url = "" (line 255)

URL to go to when image is clicked

Methods
Constructor hover (line 280)

Constructor Creates the hover object.

This creates two image objects, one for the normal image and one for the image displayed when the mouse goes over it. You must define these images:

hover hover (string $name, string $url, string $alt)
  • string $name: Name of this hover image element
  • string $url: URL to go to when image is clicked
  • string $alt: Image ALT tag content
html (line 318)

This renders the field as HTML.

  • return: The field as HTML.
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.
set_image (line 296)

Define normal image This is the image which is displayed when the mouse is 'out'.

void set_image (string $src, integer $width, integer $height, integer $border)
  • string $src: URL or path to the actual image file
  • integer $width: Width of the image in pixels
  • integer $height: Height of the image in pixels
  • integer $border: Size of border around the image in pixels
set_image_over (line 309)

Define over image This is the image which is displayed when the mouse is 'over'.

void set_image_over (string $src, integer $width, integer $height, integer $border)
  • string $src: URL or path to the actual image file
  • integer $width: Width of the image in pixels
  • integer $height: Height of the image in pixels
  • integer $border: Size of border around the image in pixels

Inherited Methods

Inherited From RenderableObject

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

Documentation generated by phpDocumentor 1.3.0RC3