FORMfields

Frames No frames
Summary: Field | Method | Constr Detail: Field | Method | Constr
FORMfields.fields.ImageField

Class ImageField

FormField
  |
  +--SubmitField
       |
       +--ImageField

public class ImageField
extends SubmitField

ImageField turns an image into a submit button.

Since:
FORMfields v1.0
Field Summary
mixed

$image

The URL to the image.
Fields inherited from FORMfields.fields.SubmitField
buttonListeners, data
Fields inherited from FORMfields.fields.FormField
autoPropagate, data, disableEnterHandler, displayValuesOnNewLine, editable, enabled, endingString, enterTabHandler, enterTabs, error, extraHtml, fieldBelowLabel, formError, help, hidden, htmlify, id, isData, label, labelForId, multiValues, name, required, subFieldDisplayValueSeparator, subFieldSeparator, subFieldValueSeparator, subFields, subFieldsCannotBeEmpty, trimWhitespace, validators, value, valueIsHtml
Constructor Summary

ImageField(string name, mixed image, string label)

Creates a new ImageField.

__construct(string name, mixed image, string label)

Creates a new ImageField.
Method Summary
string

getEditableFieldTag(mixed printId)

Returns the HTML used to display the input portion of this field.
void

getParameter()

Retrieves the posted field value.
Methods inherited from FORMfields.fields.SubmitField
addButtonListener, getButtonClicked, getDisplayFieldTag, getEditableFieldTag
Methods inherited from FORMfields.fields.FormField
addFieldValidator, addSubField, checkForBlank, clearValue, disable, formatRequestParameter, formatText, getButtonClicked, getData, getDbValue, getDisableFieldJs, getDisableJs, getDisableLabelJs, getDisplayFieldTag, getDisplayHtmlValue, getDisplayLabelTag, getDisplayValue, getEditable, getEditableFieldTag, getEditableLabelTag, getEnabled, getError, getExtraHtml, getFieldTag, getFormError, getHelp, getHelpTag, getHidden, getHiddenFieldTag, getId, getIsData, getIsHidden, getLabel, getLabelHtml, getLabelTag, getName, getOrNull, getParameter, getRawDbValue, getRequired, getValue, isBlank, isEmpty, isValid, setAutoPropagate, setData, setDbValue, setDisplayValuesOnNewLine, setEditable, setEnabled, setEndingString, setError, setExtraHtml, setFieldBelowLabel, setFormError, setHelp, setHidden, setHtmlify, setId, setIsData, setIsHidden, setLabel, setName, setRequired, setTrimWhitespace, setValue, setValueIsHtml, validate

Field Detail

image

public mixed $image = null

The URL to the image.

Since:
FORMfields v1.0

Constructor Detail

ImageField

public ImageField(string name, mixed image, string label)

Creates a new ImageField.

Parameters:
name - the name of the form field. This value must not be a SQL reserved word and should follow all the standard variable naming conventions in PHP.
label - this form field's label. The label is the printable text that is typically displayed on the left side of the field.
Since:
FORMfields v1.0
Deprecated:
deprecated as this constructor syntax is not expected in PHP 5 - will be removed once PHP 5 becomes a minimum requirement for FORMfields

__construct

public __construct(string name, mixed image, string label)

Creates a new ImageField.

Parameters:
name - the name of the form field. This value must not be a SQL reserved word and should follow all the standard variable naming conventions in PHP.
label - this form field's label. The label is the printable text that is typically displayed on the left side of the field.
Since:
FORMfields v1.0

Method Detail

getEditableFieldTag

public string getEditableFieldTag(mixed printId)

Returns the HTML used to display the input portion of this field.

Returns:
the HTML used to display the input portion of this field
Since:
FORMfields v1.0

getParameter

public void getParameter()

Retrieves the posted field value. In other words, sets this field value using the appropriate value(s) in $_REQUEST.

Since:
FORMfields v1.0

FORMfields

Frames No frames
Summary: Field | Method | Constr Detail: Field | Method | Constr