FormLib
[ class tree: FormLib ] [ index: FormLib ] [ all elements ]

Class: ImageButton

Source Location: /FormLib/ImageButton.php

Class Overview

Button
   |
   --ImageButton

An image button class with rollover effects.


Author(s):

  • Randy

Version:

  • 0.1

Methods


Inherited Variables

Inherited Methods

Class: Button

Button::__construct()
Constructor
Button::display()
Render the button as HTML.
Button::onClick()
Button::__get()
Property accessor.
Button::__set()
Property mutator.

Class Details

[line 24]
An image button class with rollover effects.

When using the rollover effect, you must create 3 buttons to be used in normal, hover and clicked modes. The image file names must be end with the following suffixes:

Normal Mode (*-up.* or *1.*) Hover Mode (*-over.* or *2.*) Click Mode: (*-down.* or *3.*)




Tags:

author:  Randy
version:  0.1


[ Top ]


Class Methods


constructor __construct [line 36]

ImageButton __construct( string $name, string $image, string $label, [boolean $rollover = false], [PropertyHolder $style = false], PropertyHolder $properties)

Constructor.



Tags:

access:  public


Overrides Button::__construct() (Constructor)

Parameters:

string   $name   The name assigned to the button.
string   $image   URL of the image file.
string   $label   The alt/title for the image (Section 508).
boolean   $rollover   Flag to enable rollover effects.
PropertyHolder   $properties   Extra properties to associate with the button.
PropertyHolder   $style   Style settings for the button.

[ Top ]

method addRollover [line 71]

void addRollover( )

Animates the image button.

Outputs the required JavaScript to change images using onMouseOut, onMouseOver and onMouseDown.




Tags:

access:  protected


[ Top ]

method display [line 48]

void display( PropertyHolder $formStyle)

Displays the button in 2 columns of a table row.



Tags:

access:  public


Overrides Button::display() (Render the button as HTML.)

Parameters:

PropertyHolder   $formStyle   The form's style settings. (Not used)

[ Top ]


Documentation generated on Wed, 15 Nov 2006 08:48:05 -0600 by phpDocumentor 1.3.1