Class form_imagebutton

Description

Image Button class This class generates a standard form image button field.

Located in /form-defs.php (line 867)

RenderableObject
   |
   --StylableObject
      |
      --HTMLObject
         |
         --form_field
            |
            --form_buttonfield
               |
               --form_imagebutton
Variable Summary
Method Summary
 form_imagebutton form_imagebutton ([string $name = ""], [string $value = ""], [string $css = ""], [mixed $src = ""], [mixed $tooltip = ""], [mixed $width = ""], [mixed $height = ""], mixed $border)
 string html ([mixed $name = ""])
 void setimage (string $src, [string $tooltip = ""], [integer $width = ""], [integer $height = ""], string $border)
 void set_confirm_text (string $conf)
Variables
Methods
Constructor form_imagebutton (line 882)

Constructor Create a field object. Sets basic field attributes.

form_imagebutton form_imagebutton ([string $name = ""], [string $value = ""], [string $css = ""], [mixed $src = ""], [mixed $tooltip = ""], [mixed $width = ""], [mixed $height = ""], mixed $border)
  • string $name: The name of the button
  • string $value: The value of the button
  • string $css: CSS class or style to apply to the button
html (line 933)

This renders the image button as HTML. If we have onclick then we render

this as a simple image with a javascript URL rather than a INPUT form element of type "image". This is done to cope with Netscape's lack of an onclick event handler for INPUT TYPE=IMAGE, and we don't use BUTTON since that's only HTML4.

  • return: HTML rendering of button
string html ([mixed $name = ""])

Redefinition of:
form_buttonfield::html()
Renders the form button as HTML.
setimage (line 900)

Sets the image to display for this button.

Usually these details are specified in the initial instantiation

void setimage (string $src, [string $tooltip = ""], [integer $width = ""], [integer $height = ""], string $border)
  • string $src: URL or path to image for the button
  • string $tooltip: Button image tooltip (title tag) content
  • integer $width: Button image width (px)
  • integer $height: Button image height (px)
  • string $border: Size of border around image
set_confirm_text (line 921)

Set the confirmation text to popup on click using Javascript.

void set_confirm_text (string $conf)
  • string $conf: Text to display in the confirmation popup.

Inherited Methods

Inherited From form_buttonfield

 form_buttonfield::form_buttonfield()
 form_buttonfield::html()

Inherited From form_field

 form_field::form_field()
 form_field::as_displayonly()
 form_field::as_hiddenfield()
 form_field::disable_autocomplete()
 form_field::setlabel()
 form_field::setvalue()
 form_field::set_displayonly()

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