This is the base FormElement object. It can be single form field such as a text input field, or a complex object.
Usefull Functions
get_value() - This gets the current 'value' of the FormElement. NOTE: This can be a 'complex' FormElement in which it may return an array of values.
set_value() - Set the current value for this FormElement.
get_label() - returns the label for this FormElement.
Located in Program_Root/form/FormElement.inc (line 39)
Class | Description |
---|---|
FEHidden | This is the Hidden FormElement which builds a input field of type="hidden". It has no validation method. |
FEError | This is a way of providing an Error to the FormProcessor. |
FEText | This is the Text FormElement which builds a text input field. It has no validation method. |
FEBoxElement | This is the Box FormElement which builds a DIV with a width and a height. It is a base class for more complicated FormElements. |
FECheckBox | This is the CheckBox FormElement which builds a input field of type="checkbox". It has no validation method. |
FERadioGroup | This is the Radio Button Group FormElement which builds a List of Radio buttons that can be used in any style of layout. |
Holds additional attributes for
the elements html tag
Holds the name of the element
as it appears in the form html tag
holds the array of errors for this element.
Holds the error message text
for validation errors, if any
This holds the name of the form
for js that needs it
Holds the state of the last validation
Sets to true in case of a validation error
Indicates a disabled element
Indicates whether this elements
final value is required and cannot be empty
Holds the elements label text
automatically strip slashes from
form values?
Holds additional style attributes for
the elements html tag
Holds the elements initial value
The constructor
string - text label for the element
required - is this a required element
This function creates element name
used in the form based on the text label or any other parameters
return a single attribute
attribute name
This function builds and returns the form element object
Returns the element name to be used in the form
This returns the array of errors for this element
of errors
Returns the current error message if any
This returns the initial value of the element
This function builds and returns a label object based on the label text and error conditions
This function will return the elements label text
This function return the symbol used to denote a required field
This function will return the elements value
This provides a method
for the FormContent to get access to the text associated with a field. This is only available on FormElements that have text associated with a field. It is used during Confirmation
- the value to look up
Returns the current error state
Returns the elements disabled state
Returns whether this elements final value cannot be empty
This method is used for adding any javascript that is used by this element. This will automatically get called and added to the page by the FormProcessor
This function return the javaScript code for an onBlur event
this function retuns the javaScript code for an onChange event
This function return the javaScript code for an onClick event
This function return the javaScript code for an onFocus event
This function return the javaScript code for an onSubmit event
add a single attribute (name="value")
attribute name
the value
Sets the disabled element flag
disabled
Defines error message text and sets the error flag to true
text - error message
text - a label to provide for the error. This is only needed for a complex element that has multiple 'hidden/magic' fields.
in case anyone in JS land needs the name of the form that this element lives in
- the form name
This function will set the label for the element
string
This function set the elements required state
required
This sets the stripslashes flag for this object.
Sets elements css attribute
attribute name
the value
Sets elements title text
title
This function will set the initial value for the element
mixed
This function performs the actual validation It is called only if the validation is required by this element
This function is responsible for performing complete validation and setting the appropriate error message in case of a failed validation
object.
This function builds the element form attributes
This function builds the complete javaScript events code for the element
This function checks if the validation is nesseccary and calls the validate method
object.
Documention generated on Thu, 31 Jul 2003 18:32:43 -0700 by phpDocumentor 1.2.0