Class Link

Description

Clickable link

A standard clickable link. This class incorporates a few useful features over and above the standard <A> tag functionality. You can define linkover text to appear in the browser status bar when the mouse moves over the link, and the object can be rendered as either HTML or WML.

Located in /button-defs.php (line 506)

RenderableObject
   |
   --Link
Variable Summary
 mixed $font
 mixed $href
 mixed $label
 mixed $onmouseout
 mixed $onmouseover
 mixed $style
 mixed $target
Method Summary
 Link Link (string $href, [string $label = ""], [string $onmouseover = ""], [string $onmouseout = ""], [string $font = ""], [string $target = ""])
 void highlight (mixed $highlightclass)
 string html ()
 void setstyle (mixed $style)
 void set_font (mixed $font)
 void set_href (mixed $href)
 void set_linkover_text (mixed $txt)
 string wml ()
Variables
mixed $font = "" (line 518)

Font settings for link text

mixed $highlightclass = false (line 522)

Stylesheet class name for highlighted link

mixed $href = "" (line 508)

The URL to go to when link is clicked

mixed $label = "" (line 510)

The label to display for the link

mixed $linkover_text = "" (line 520)

Status bar text when link moused over

mixed $onmouseout = "" (line 516)

Script to execute on mouse out

mixed $onmouseover = "" (line 514)

Script to execute on mouse over

mixed $style = "" (line 524)

Style to apply to the link text

mixed $target = "" (line 512)

Target frame for the URL

Methods
Constructor Link (line 534)

Constructor

Link Link (string $href, [string $label = ""], [string $onmouseover = ""], [string $onmouseout = ""], [string $font = ""], [string $target = ""])
  • string $href: The URL to go to when clicked
  • string $label: The text to display for the link
  • string $onmouseover: Javascript to execute on mouse-over
  • string $onmouseout: Javascript to execute on mouse-out
  • string $font: Font settings
  • string $target: Target frame eg: '_blank', 'myframe' etc.
highlight (line 577)

Defines special highlight class name

Defines the name of a class in your stylesheet to use for the purpose of highlighting. This property is initialised to be 'false', but if defined, then the link is spanned by a <span> tag with the given class name to highlight it accordingly.

void highlight (mixed $highlightclass)
html (line 610)

Use render() to render this element in your page.

Renders the reset button 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.
setstyle (line 566)

Sets the style Sets the style for the href tag.

void setstyle (mixed $style)
set_font (line 548)

Sets the font Deprecated. Sets the font to use with the link text. Better to use a stylesheet these days.

void set_font (mixed $font)
set_href (line 558)

Sets the URL Sets the URL to go to when the link is clicked. usually this is specified on instantiation.

void set_href (mixed $href)
set_linkover_text (line 587)

Set status text to show on mouseover Will do a mouseover status message, if onmouseover is not already defined, otherwise it will be ignored. This is useful to avoid long and ugly URL's appearing in the status bar.

void set_linkover_text (mixed $txt)
wml (line 596)

Renders the reset button as WML.

string wml ()

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

Inherited Methods

Inherited From RenderableObject

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

Documentation generated by phpDocumentor 1.3.0RC3