Class clickable_image

Description

Clickable Image class A class for managing a clickable image. A clickable image is one which redirects to a given URL when clicked on.

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

RenderableObject
   |
   --clickable_image
Variable Summary
 mixed $img
 mixed $url
Method Summary
 clickable_image clickable_image (string $name, string $url, string $alt, string $src, integer $width, integer $height, integer $border)
 string html ()
 void set_linkover_text (string $txt)
Variables
mixed $img (line 200)

The image object

mixed $url = "" (line 195)

URL to go to when image is clicked on

Methods
Constructor clickable_image (line 213)

Constructor Creates the basic clickable image object.

clickable_image clickable_image (string $name, string $url, string $alt, string $src, integer $width, integer $height, integer $border)
  • string $name: Name of this image element
  • string $url: URL to go to when image is clicked
  • string $alt: Image ALT tag content
  • 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
html (line 233)

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_linkover_text (line 223)

Set linkover text Defines the text to show when the mouse moves over the image.

void set_linkover_text (string $txt)
  • string $txt: Text to show in status area when mouse-over.

Inherited Methods

Inherited From RenderableObject

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

Documentation generated by phpDocumentor 1.3.0RC3