[form] element index

Package indexes

All elements
a b c d e f h i k l m n o p r s t u v w
a
top
Variable $accept_charsets
form::$accept_charsets in form-defs.php
Accept-charset attributes - comma-delimited list
Variable $action
form::$action in form-defs.php
Action attribute
Variable $autocomplete
form_field::$autocomplete in form-defs.php
If false, disable autocomplete on this field. Mainly used with
Method add
form::add() in form-defs.php
Adds a form element object to the form. This is usually an object you have previously created eg. with new form_textfield(...) etc.
Method additem
Add a data item Adds a key=>value pair into the combo options collection.
Method additem
Add an image item to preview. We override the combofield additem() so we can store the image URL against the key value nin our arrays.
Method add_annotation
form::add_annotation() in form-defs.php
Add annotation to the form Adds text content to the form in the field column. The text is added literally, so you can add in effects like <em>..</em> etc.
Method add_button
form::add_button() in form-defs.php
Add a button Adds a button element to the form.
Method add_fileuploadfields
Add file upload fields Special function to add repeated fileupload fields to the form.
Method add_querydata
Add ready-made data. Populates the combo field data from a pre-run query.
Method add_separator
form::add_separator() in form-defs.php
Add form separator row
Method add_text
form::add_text() in form-defs.php
Add text to the form Adds text content to the form spanning both columns. The text is added literally, so you can add in effects like <em>..</em> etc.
Method as_displayonly
Returns current element as text, with associated hidden field.
Method as_hiddenfield
Returns current element as a hidden field.
b
top
Variable $base_path
Base path to image. This will be prefixed to the value field.
Variable $blockformats
htmlarea_config::$blockformats in htmlarea-defs.php
The list of block format styles to allow user to choose from
c
top
Variable $checked
True if this element should be selected
Variable $checked
form_checkbox::$checked in form-defs.php
True if checkbox is ticked/checked
Variable $config
form_wysiwygfield::$config in htmlarea-defs.php
The configuration override settings to use. This is
Variable $confirm_text
Popup confirmation text to display on button click
Variable $css_styles
form_wysiwygfield::$css_styles in htmlarea-defs.php
CSS Styles we want to display for this field
Method check
form_checkbox::check() in form-defs.php
Sets the checkbox to the checked state.
Method check
form_radiobutton::check() in form-defs.php
Sets the checkbox to the checked state.
Method clearitems
Clears any existing items
Method contains_fileuploadfield
Check if form contains file upload field Check all elements for presence of file upload field. This is mainly for internal use.
d
top
Variable $disabled
form_field::$disabled in form-defs.php
True if field is disabled
Method disable_autocomplete
Disable the autocomplete form functionality of the browser for this field. Browsers have, mainly for password fields, been offering auto-completion of contents. This function will stop this from being done, in browsers which obey the "autocomplete='off'" attribute.
Constant DISPLAY_ONLY
DISPLAY_ONLY in form-defs.php
Form field is readonly/display only
e
top
Variable $editable
form_field::$editable in form-defs.php
True if field is NOT readonly
Variable $elements
form::$elements in form-defs.php
Elements array. Contains form elements
Variable $elewidth_pct
form::$elewidth_pct in form-defs.php
Width taken by element (RHS) side of the form in %
Variable $enctype
form::$enctype in form-defs.php
Encoding type
Constant EDITABLE
EDITABLE in form-defs.php
Form element is editable (ie. not readonly)
f
top
Variable $fontnames
htmlarea_config::$fontnames in htmlarea-defs.php
The list of font families to allow user to choose from
Variable $fontsizes
htmlarea_config::$fontsizes in htmlarea-defs.php
The list of font sizes to allow user to choose from
Variable $force_readonly
form::$force_readonly in form-defs.php
Whether to force forma elements to be read-only
Variable $format
form_textfield::$format in form-defs.php
Format specifier (WML)
Variable $formname
The form this widget is to be displayed in
Variable $fullPage
htmlarea_config::$fullPage in htmlarea-defs.php
if true then HTMLArea will retrieve the full HTML, starting
Method force_readonly
form::force_readonly() in form-defs.php
Force all of the contained fields to be rendered read-only
Class form
form in form-defs.php
Form class
Method form
form::form() in form-defs.php
Constructor Create a form object. Sets basic form attributes.
Page form-defs.php
form-defs.php in form-defs.php
Method form_buttonfield
Constructor Create a field object. Sets basic field attributes.
Class form_buttonfield
form_buttonfield in form-defs.php
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.
Method form_checkbox
Constructor Create a field object. Sets basic field attributes.
Class form_checkbox
form_checkbox in form-defs.php
Checkbox Field class A field which renders a checkbox form element.
Method form_combofield
Constructor Create a field object. Sets basic field attributes.
Class form_combofield
form_combofield in form-defs.php
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.
Method form_displayonlyfield
Constructor Create a disply-only field object. Sets basic field attributes.
Class form_displayonlyfield
form_displayonlyfield in form-defs.php
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..
Method form_field
form_field::form_field() in form-defs.php
Constructor Create a field object. Sets basic field attributes.
Class form_field
form_field in form-defs.php
Form Field class Abstract field class, for deriving various form field types.
Method form_fileuploadfield
Constructor Create a field object. Sets basic field attributes.
Class form_fileuploadfield
form_fileuploadfield in form-defs.php
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_hiddenfield
form_hiddenfield in form-defs.php
Hidden Field class This class generates a hidden field.
Method form_hiddenfield
Constructor Create a hidden field object. Sets basic field attributes.
Method form_imagebutton
Constructor Create a field object. Sets basic field attributes.
Class form_imagebutton
form_imagebutton in form-defs.php
Image Button class This class generates a standard form image button field.
Class form_imagecombo
form_imagecombo in form-defs.php
Image Combo class
Method form_imagecombo
Constructor Create a field object. Sets basic field attributes.
Method form_imagefield
Constructor Create a field object. Sets basic field attributes.
Class form_imagefield
form_imagefield in form-defs.php
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_jumpmenu
form_jumpmenu in form-defs.php
Jumpmenu Field class A special case of combofield where we define key/value data made up of display-value and URL pairs.
Method form_jumpmenu
Constructor Create a field object. Sets basic field attributes.
Method form_labelfield
Constructor Create a label field object. Sets basic field attributes.
Class form_labelfield
form_labelfield in form-defs.php
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..
Method form_memofield
Constructor Create a field object. Sets basic field attributes.
Class form_memofield
form_memofield in form-defs.php
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.
Method form_passwordfield
Constructor Create a field object. Sets basic field attributes.
Class form_passwordfield
form_passwordfield in form-defs.php
Password Field class Password field element. Same as textfield, but masks user input.
Class form_radiobutton
form_radiobutton in form-defs.php
Radio Button Field class A field which renders a radio form element.
Method form_radiobutton
Constructor Create a field object. Sets basic field attributes.
Class form_radiogroup
form_radiogroup in form-defs.php
Radio Group Field class A field which groups a set of radio form elements together.
Method form_radiogroup
Constructor Create a field object. Sets basic field attributes.
Method form_resetbutton
Constructor Create a field object. Sets basic field attributes.
Class form_resetbutton
form_resetbutton in form-defs.php
Reset Button class This class generates a standard form reset button field.
Method form_submitbutton
Constructor Create a field object. Sets basic field attributes.
Class form_submitbutton
form_submitbutton in form-defs.php
Submit Button class This class generates a standard form submit button field.
Class form_tandemfield
form_tandemfield in form-defs.php
Tandem Field class
Method form_tandemfield
Constructor Create a field object. Sets basic field attributes.
Class form_textfield
form_textfield in form-defs.php
Text Field class. This class generates a text field.
Method form_textfield
Constructor Create a field object. Sets basic field attributes.
Method form_wysiwygfield
Constructor - create a wysiwyg form element..
Class form_wysiwygfield
form_wysiwygfield in htmlarea-defs.php
Wysiwyg Field class A field which renders a textarea form element as a Wysiwyg editor.
Constant F_CHECKBOX
F_CHECKBOX in form-defs.php
Tickbox or checkbox
Constant F_COMBO
F_COMBO in form-defs.php
Dropdown menu or listbox field
Constant F_DATETIME
F_DATETIME in form-defs.php
Date/time field
Constant F_IMAGE
F_IMAGE in form-defs.php
Text field containing image URL
Constant F_MEMO
F_MEMO in form-defs.php
Textarea memo field
Constant F_RADIO
F_RADIO in form-defs.php
Radio button
Constant F_TEXT
F_TEXT in form-defs.php
General text field
h
top
Variable $height
htmlarea_config::$height in htmlarea-defs.php
Height of HTMLarea element (default 'auto')
Variable $htmlareaPaste
htmlarea_config::$htmlareaPaste in htmlarea-defs.php
intercept ^V and use the HTMLArea paste command
Variable $htmlRemoveTags
HTML tags to disallow (these have to be a regexp, or null
Method html
form_radiobutton::html() in form-defs.php
This renders the field as HTML.
Method html
form::html() in form-defs.php
This renders the form as HTML, including the form tags and every form element in the form.
Method html
form_radiogroup::html() in form-defs.php
This renders the field as HTML.
Method html
form_wysiwygfield::html() in htmlarea-defs.php
This renders the field as HTML.
Method html
form_labelfield::html() in form-defs.php
This renders the field as HTML.
Method html
form_textfield::html() in form-defs.php
This renders the field as HTML.
Method html
form_tandemfield::html() in form-defs.php
Use render() to render this element in your page.
Method html
form_memofield::html() in form-defs.php
This renders the field as HTML.
Method html
form_jumpmenu::html() in form-defs.php
This renders the field as HTML.
Method html
form_buttonfield::html() in form-defs.php
Renders the form button as HTML.
Method html
Use render() to render this element in your page.
Method html
form_checkbox::html() in form-defs.php
This renders the field as HTML.
Method html
This renders the field as HTML.
Method html
form_hiddenfield::html() in form-defs.php
This renders the field as HTML.
Method html
form_imagefield::html() in form-defs.php
This renders the field as HTML.
Method html
form_imagecombo::html() in form-defs.php
This renders the field as HTML. Note that because of the special nature of this widget, we need to know the name of the form it is in to do the previewing. Without it, no preview image is displayed.
Method html
form_imagebutton::html() in form-defs.php
This renders the image button as HTML. If we have onclick then we render
Method html
form_combofield::html() in form-defs.php
This renders the field as HTML.
Page htmlarea-defs.php
htmlarea-defs.php in htmlarea-defs.php
Class htmlarea_config
htmlarea_config in htmlarea-defs.php
A container class for configuration settings for the HTMLArea
Method htmlarea_config
Constructor for new HTMLArea configuration object
Function htmlarea_plugins
htmlarea_plugins() in htmlarea-defs.php
Function to set plugins to be loaded. When you are using one of
i
top
Variable $image_keys
Array of image IDs we have in our combo
Variable $image_urls
Array of image URLS, one per ID above
Variable $include_maxsize
Whether to include the max size in the form
Variable $itemlist
Items to display, assoc. array
k
top
Variable $killWordOnPaste
set to true if you want Word code to be cleaned upon Paste
l
top
Variable $label
form_field::$label in form-defs.php
Label to put against the field. NB: this is not displayed unless you make it so.
Variable $labelcolon
form::$labelcolon in form-defs.php
Whether to append colon ":" to labels
Variable $labelcss
form::$labelcss in form-defs.php
Optional class/style for labels
Variable $labeljustify
form::$labeljustify in form-defs.php
Justification mode for labels "right" or "left"
Variable $labelside
Side to place label: 'right' or 'left'
Constant LOWER
LOWER in form-defs.php
Force text to lowercase
m
top
Variable $maxlength
Maximum user-enterable chars for field
Variable $max_file_size
Maximum file suze in bytes
Variable $method
form::$method in form-defs.php
Method attribute
Variable $multiselect
Boolean, multiple item select
Method multipart_form
Create an multipart_form object. Sets basic form attributes.
Class multipart_form
multipart_form in form-defs.php
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.
Constant MULTISELECT
MULTISELECT in form-defs.php
Combo-field is multiple-select
n
top
Constant NONE
NONE in form-defs.php
Do not force case
o
top
Variable $onclick_form_submit
Whether to allow form submit on-click
Variable $onsubmit
form::$onsubmit in form-defs.php
Script to call on form submit
Variable $orientation
Group orientation: 'horizontal' or 'vertical'
Method ovenready_data
Add ready-made data Use a ready-made, piping hot source of data. This should be a normal Key/Value pair associative array..
p
top
Variable $pageStyle
htmlarea_config::$pageStyle in htmlarea-defs.php
style included in the iframe document (default nullstring)
Variable $plugins
form_wysiwygfield::$plugins in htmlarea-defs.php
Plugins we want to register for this field
Variable $preview_img_height
Height of preview in px
Variable $preview_img_width
Width of preview in px
r
top
Variable $rows
form_memofield::$rows in form-defs.php
Number of rows in the text box
Method register_plugins
Set the plugins to register for this Wysiwyg editor. This is a subset
Method render
htmlarea_config::render() in htmlarea-defs.php
Render this config as a string of Javascript which could be put into a webapage and used to set the configuration of a real HTMLArea object.
s
top
Variable $showlabels
form::$showlabels in form-defs.php
Whether to render labels for fields
Variable $sizeIncludesToolbar
the next parameter specifies whether the toolbar should
Variable $statusBar
htmlarea_config::$statusBar in htmlarea-defs.php
enable creation of a status bar? (default true)
Variable $summaryfield
True if main field should be suppressed
Method setimage
Sets the image to display for this button.
Method setlabel
form_field::setlabel() in form-defs.php
Set the label associated with the field
Method setvalue
form_field::setvalue() in form-defs.php
Set the value of the field
Method set_blockformats
Set a new list of selectable block formats. The array should be an
Method set_confirm_text
Set the confirmation text to popup on click using Javascript.
Method set_displayonly
Set the field to be display-only (non-editable)
Method set_fieldwidth_pct
Set the proportion of the form taken up by the form field elements as opposed to the labels. This is specified as an integer which is the proportion as a percentage. Eg: 70 would be '70%'.
Method set_fontnames
Set a new list of selectable font families. This array should be an
Method set_fontsizes
Set a new list of selectable font sizes. The sizes array should be
Method set_format
Set field format (WML)
Method set_formname
Set the name of the form this will be displayed in.
Method set_metrics
Set the HTMLArea sizing. The default is 'auto' for both width and height, which gives you an editing area filling the are that the original memofield widget would have filled.
Method set_onsubmit
form::set_onsubmit() in form-defs.php
Set onsubmit script Defines the onsubmit script to call when the user submits the form.
Method set_pagestyle
Set the HTMLArea page style. This is the overall style setting(s) which are applied to the HTMLArea widget and so here is where you determine such basic things as the font settings of the content which is displayed/edited etc.
Method set_paste_intercept
Set the HTMLArea Paste mode. If set to true, then the HTMLArea
Method set_preview_metrics
Set the width and height of the preview image. The default setting is 125 x 125 pixels.
Method set_remove_regex
Set the regular expression to use for removing dis-allowed HTML tags from the editor content. This allows you to specify a regex matching those tags you don't want to ever appear in the content.
Method set_rows
Set the number of rows for this memo field.
Method set_size
Set select field size in lines.
Method set_statusbar
Set the HTMLArea statusbar display mode, true or false.
Method set_styles
form_wysiwygfield::set_styles() in htmlarea-defs.php
Set the styles to provide for this Wysiwyg editor. Styles are displayed
Method set_toolbar
Set a new toolbar definition. Toolbars are arrays of arrays of lists
Method set_type
form::set_type() in form-defs.php
Set the form type This can be 'normal' or 'subform'. Use the subform variant when you already have <form> tags being provided by other means. Then when you render the subform only the fields will be returned.
Method set_undo_steps
Set the HTMLArea undo steps maximum. The default number is 20. Use this method to change that.
Method set_width
Set the field width (usually in characters).
Method set_width
Set select field width. Note that selects can only have width set using a style, since they normally auto-set the width to the max length of their options display strings.
Method set_wrapmode
Set the wrap mode for the textarea.
Constant SINGLESELECT
SINGLESELECT in form-defs.php
Combo-field is single-select
Constant STD_WIDTH
STD_WIDTH in form-defs.php
Standard width for a textual form element
Class subform
subform in form-defs.php
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.
Method subform
subform::subform() in form-defs.php
Create a subform object. Sets basic form attributes.
t
top
Variable $tandemfield
The second field object in tandem with this one
Variable $tandemwidth
Overall width in pixels
Variable $toolbar
htmlarea_config::$toolbar in htmlarea-defs.php
The toolbar. This takes the form of an array of arrays of toolbar
Variable $toolbar_basic
htmlarea_config::$toolbar_basic in htmlarea-defs.php
A basic toolbar definition. Use for entering text in given
Variable $toolbar_full
htmlarea_config::$toolbar_full in htmlarea-defs.php
A fully-populated toolbar definition for power users
Variable $toolbar_medium
A medium toolbar definition, adds colour, links, raw HTML editing,
Variable $type
form::$type in form-defs.php
Type of form 'normal' or 'subform'
Variable $type
form_field::$type in form-defs.php
Type of field eg: text, hidden, checkbox etc.
u
top
Variable $undoSteps
htmlarea_config::$undoSteps in htmlarea-defs.php
maximum size of the undo queue (default 20)
Method uncheck
Sets the checkbox to the unchecked state.
Method uncheck
form_checkbox::uncheck() in form-defs.php
Sets the checkbox to the unchecked state.
Constant UPPER
UPPER in form-defs.php
Force text to uppercase
v
top
Variable $value
form_field::$value in form-defs.php
Value of the field
w
top
Variable $width
htmlarea_config::$width in htmlarea-defs.php
Width of HTMLarea element (default 'auto')
Variable $wrapmode
form_memofield::$wrapmode in form-defs.php
Wrapping mode: 'virtual', 'physical', or 'off'
Variable $wysiwyg_id
form_wysiwygfield::$wysiwyg_id in htmlarea-defs.php
Unique ID of this form element
Method wml
form_jumpmenu::wml() in form-defs.php
This renders the field as WML.
Method wml
form_textfield::wml() in form-defs.php
This renders the field as WML.
Method wml
form_combofield::wml() in form-defs.php
This renders the field as WML.
a b c d e f h i k l m n o p r s t u v w