File/form-defs.php

Description
Classes
Class Description
 class form Form class
 class subform SubForm class The sub-form is a special case of the form class. The difference is that it is expected to be part of an existing form, and therefore is rendered without the form tags.
 class multipart_form multipart_form class The multipart_form is just a standard form, but with the enctype pre-set to the "multipart/form-data" setting required for file multiparts of binary form data.
 class form_field Form Field class Abstract field class, for deriving various form field types.
 class form_labelfield Label Field class This is just to display a bare value where the form element would normally be, and where we dont want to use a form_textfield in non-editable mode because we don't want the hidden field..
 class form_hiddenfield Hidden Field class This class generates a hidden field.
 class form_buttonfield Button Field class This virtual class generates a standard form button field. This is a virtual class, used to provide a basis for real buttons. Do not instantiate this as an object - use the descendants instead.
 class form_submitbutton Submit Button class This class generates a standard form submit button field.
 class form_resetbutton Reset Button class This class generates a standard form reset button field.
 class form_imagebutton Image Button class This class generates a standard form image button field.
 class form_textfield Text Field class. This class generates a text field.
 class form_displayonlyfield Displayonly Field class Extends the textfield class. This class renders a textfield as text rather than a textbox control. The form value is still submitted, but as a hidden field in the form..
 class form_passwordfield Password Field class Password field element. Same as textfield, but masks user input.
 class form_fileuploadfield File Upload Field class A field for uploading files to the webserver. If used with a 'form' object, the form will be automatically rendered with the proper encoding type by setting the 'enctype' in the form tag.
 class form_combofield Combo Field class A field for producing combo boxes (dropdown select menus) or multi-line list-boxes, either of which may be single-select or multiple select.
 class form_jumpmenu Jumpmenu Field class A special case of combofield where we define key/value data made up of display-value and URL pairs.
 class form_memofield Memo Field class A field which renders a textarea form element. These are used to allow people to input large tracts of text by typing or copy/paste.
 class form_checkbox Checkbox Field class A field which renders a checkbox form element.
 class form_radiobutton Radio Button Field class A field which renders a radio form element.
 class form_radiogroup Radio Group Field class A field which groups a set of radio form elements together.
 class form_imagefield Image Field class This is a hybrid field. It is basically a text field where the value is expected to be the location of an image, either a real path to a file or a URI.
 class form_tandemfield Tandem Field class
Includes
 include_once ("button-defs.php") (line 34)

Include button creation classes

 include_once ("datetime-defs.php") (line 32)

Include date and time functions

 include_once ("html-defs.php") (line 36)

The HTML object classes are required for forms

 include_once ("data-defs.php") (line 30)

Include data definitions for key value container

Constants
DISPLAY_ONLY = false (line 50)

Form field is readonly/display only

EDITABLE = true (line 52)

Form element is editable (ie. not readonly)

F_CHECKBOX = 6 (line 68)

Tickbox or checkbox

F_COMBO = 4 (line 64)

Dropdown menu or listbox field

F_DATETIME = 3 (line 62)

Date/time field

F_IMAGE = 2 (line 60)

Text field containing image URL

F_MEMO = 5 (line 66)

Textarea memo field

F_RADIO = 7 (line 70)

Radio button

F_TEXT = 1 (line 58)

General text field

LOWER = 2 (line 78)

Force text to lowercase

MULTISELECT = true (line 82)

Combo-field is multiple-select

NONE = (line 74)

Do not force case

SINGLESELECT = false (line 84)

Combo-field is single-select

STD_WIDTH = 16 (line 41)

Standard width for a textual form element

UPPER = 1 (line 76)

Force text to uppercase

Documentation generated by phpDocumentor 1.3.0RC3