Class: InputImage

Source Location: /HtmlForm.FormElement.InputImage.class.php

Class Overview

FormElement
   |
   --InputSubmit
      |
      --InputImage

Wraps an image-form-submit-button.

Author(s):

Sebastian Schlapkohl

Version:

Methods

Inherited Constants

Class: FormElement

FormElement::ERRORCLASS
FormElement::JSENABLEDCLASS
FormElement::MANDATORYCLASS
FormElement::OPTIONALCLASS
FormElement::UNVALIDATEDCLASS
FormElement::WIDGETCLASS
FormElement::WRAPCLASS

Inherited Variables

Class: InputSubmit

InputSubmit::$caption

Class: FormElement

FormElement::$cssClasses
FormElement::$disabled
FormElement::$id
FormElement::$isValid
FormElement::$jsEventHandler
FormElement::$label
FormElement::$masterElement
FormElement::$masterForm
FormElement::$name
FormElement::$subElements
FormElement::$title
FormElement::$validator

Inherited Methods

Class: InputSubmit

InputSubmit::__construct(): Hidden constructor.
InputSubmit::doRender(): Compiles and returns the html-fragment for the element.
InputSubmit::get(): Factory method for InputSubmit, returns new instance.
InputSubmit::getValue(): Returns if the submit-button was used for the last occurred form-submit.
InputSubmit::setCaption(): Sets the button-caption.

Class: FormElement

FormElement::__construct(): General abstract, hidden formelement constructor.
FormElement::addCssClasses(): Adds one or many css-classes to the element's class-attribute.
FormElement::addElement(): Adds a subelement to the element.
FormElement::determineRefiller(): Returns the supposed source of refill values.
FormElement::doRender(): Returns the compiled html-code for the element.
FormElement::getId(): Return the element's html-id.
FormElement::getLabel(): Return the element's label text.
FormElement::getMasterElement(): Return the currently connected owner element for the element.
FormElement::getMasterForm(): Returns the currently connected owner form for the element.
FormElement::getName(): Return the element's html-name.
FormElement::getSubElements(): Return all owned elements of this element.
FormElement::getTitle(): Return the element's html-title.
FormElement::getValidator(): Return the currently connected validator for the element.
FormElement::getValue(): Returns the value of the element if there is any.
FormElement::getValueSet(): Returns the compiled valueset for this element including the elements owned by this one.
FormElement::insertElementAfter(): Searches the subelements of the element if present and inserts a given element after the first found one.
FormElement::isValid(): Answers if the element is in a valid state at the moment.
FormElement::needsUtf8Safety(): Answers if the element needs to be treated with precautions according to possible utf-8 values.
FormElement::printCssClasses(): Compiles the html-class-attribute-string of the element.
FormElement::printDisabled(): Compiles the html-disabled-attribute-string of the element.
FormElement::printId(): Compiles the html-id-attribute-string of the element.
FormElement::printJavascriptEventHandler(): Compiles html-javascript-eventhandler-string of the element.
FormElement::printJavascriptValidationCode(): Grabs the compiled JS-validation-code for the element from its validator, if present and returns the code as a string.
FormElement::printMessages(): Returns a string of all aggregated error messages of the element.
FormElement::printName(): Compiles the html-name-string of the element.
FormElement::printNameArray(): Comiles the html-name-string of the element, if the element is part of a group of values.
FormElement::printTabIndex(): Calculates current ongoing tabindex of the form, refreshes it and returns the proper value for the element.
FormElement::printTitle(): Compiles the html-title-string of the element.
FormElement::printWrapperClasses(): Compiles a string of all classes for the tag-wrapper for the element's html-code.
FormElement::setCssClasses(): Sets the html-class-attribute for the element.
FormElement::setDisabled(): Set the element disabled.
FormElement::setId(): Sets the html-id for this element.
FormElement::setJavascriptEventHandler(): Sets a javascript-handler for the element.
FormElement::setLabel(): Inserts a label for the element.
FormElement::setMasterElement(): Sets the owning element for an element.
FormElement::setMasterForm(): Sets the owning form for an element and by doing so inserts the element into the logical structure of the form.
FormElement::setTitle(): Sets the html-title for this element.
FormElement::setUsable(): Set the element usables or disabled based on an expression.
FormElement::setValidator(): Sets a validator for a value-bearing element.
FormElement::validate(): Starts validation for the element and all subelements according to the rules laid out in the element's validator.

Class Details

[line 22]
Wraps an image-form-submit-button.

To get click-coordinates use getCoords() after submit.

This element is not wrapped into a row, but should be inserted into a container-widget.

Tags:

author:	Sebastian Schlapkohl
version:	1.0

[ Top ]

Class Methods

static method get [line 50]

static InputImage get(
String
$name, [String
$id = ''])

Factory method for InputImage, returns new instance.

Factories are used to make instant chaining possible.

Tags:

return:	new InputImage-instance
access:	public

Overrides InputSubmit::get() (Factory method for InputSubmit, returns new instance.)

Parameters:

String	$name	html-name for the element
String	$id	html-id for the element

[ Top ]

constructor __construct [line 34]

InputImage __construct(
String
$name, [String
$id = ''])

Hidden constructor.

Get new instances with "get()" instead.

Tags:

access:

protected

Overrides InputSubmit::__construct() (Hidden constructor.)

Parameters:

String	$name	html-name for the element
String	$id	html-id for the element

[ Top ]

method doRender [line 114]

String doRender(
)

Compiles and returns the html-fragment for the element.

Tags:

return:	html-fragment for the element
access:	public

Overrides InputSubmit::doRender() (Compiles and returns the html-fragment for the element.)

[ Top ]

method getCoords [line 93]

null/Object getCoords(
)

Returns the clicked coordinates on the image-submit button.

Returns null, if button hasn't been clicked.

Tags:

return:	coordinate-object, ->x and ->y for uint-coordinates
access:	public

[ Top ]

method getValue [line 80]

Boolean getValue(
)

Returns if the image_submit-button was used for the last occurred form-submit.

Tags:

return:	image-submit-button has used for last submit yes/no
access:	public

Overrides InputSubmit::getValue() (Returns if the submit-button was used for the last occurred form-submit.)

[ Top ]

method setSrc [line 65]

void setSrc(
String
$imageSrc)

Sets the image-source-url for the image of the image-submit.

Tags:

access:

public

Parameters:

String

$imageSrc

source-image url

[ Top ]

Documentation generated on Fri, 18 Jul 2014 16:31:59 +0200 by phpDocumentor 1.4.3