ImageInput Class Reference

Inheritance diagram for ImageInput:

List of all members.

---

Detailed Description

An image input.

Definition at line 1002 of file controls.php.

Public Member Functions
	ImageInput ($src=null, $control_name=null)
	The ImageInput constructor.
	getXY ()
	Get the clicked image coordinates.
	getX ()
	Get the X pixel coordinate of the click.
	getY ()
	Get the Y pixel coordinate of the click.
	getSrc ()
	Get the control's image source URL.
	setSrc ($src)
	Set the control's image source URL.
	submitsMultipleValues ()
	Check whether this control submits multiple values.
	getValue ()
	Get the control's value.
	setValue ($value)
	Set the control's value.
Public Attributes
	$value
	The value (clicked coordinates) of the control.

---

Constructor & Destructor Documentation

ImageInput::ImageInput (  $  src = null, $  control_name = null )

The ImageInput constructor. Parameters: $src  the URL for the image source $control_name  the unique name for the control (also as appears in the HTTPD POST string) Definition at line 1012 of file controls.php.

---

Member Function Documentation

ImageInput::getSrc (   )

Get the control's image source URL. Returns: the image URL Definition at line 1055 of file controls.php.

ImageInput::getValue (   )

Get the control's value. An interface for retrieving a control's value. This should be overridden in a subclass to return a value. Returns: void Reimplemented from ValueInput. Definition at line 1080 of file controls.php.

ImageInput::getX (   )

Get the X pixel coordinate of the click. Returns: the X coordinate in pixels Definition at line 1033 of file controls.php.

ImageInput::getXY (   )

Get the clicked image coordinates. Returns: an associative array with 'x' and 'y' keys referencing the coordinates Definition at line 1023 of file controls.php.

ImageInput::getY (   )

Get the Y pixel coordinate of the click. Returns: the Y coordinate in pixels Definition at line 1042 of file controls.php.

ImageInput::setSrc (  $  src  )

Set the control's image source URL. Parameters: $src  the image URL Returns: void Definition at line 1065 of file controls.php.

ImageInput::setValue (  $  value  )

Set the control's value. This sets the control's value and flags the control has having been updated. Returns: void Reimplemented from ValueInput. Definition at line 1085 of file controls.php. References $value.

ImageInput::submitsMultipleValues (   )

Check whether this control submits multiple values. A control that submits multiple values is a control such as a checkbox or multiple select. Returns: true if the control is capable of submitting multiple values, false otherwise Reimplemented from ControlElement. Definition at line 1075 of file controls.php.

---

Member Data Documentation

ImageInput::$value

The value (clicked coordinates) of the control. Definition at line 1005 of file controls.php. Referenced by setValue().

---

The documentation for this class was generated from the following file:

• formcontrols/controls.php

---