Class icms_form_Element

Abstract base class for form elements

Direct known subclasses

icms_form_elements_Button, icms_form_elements_Captcha, icms_form_elements_Text, icms_form_elements_Textarea, icms_form_elements_Tray, icms_ipf_form_elements_Section, icms_form_elements_Checkbox, icms_form_elements_File, icms_form_elements_Groupperm, icms_form_elements_Hidden, icms_form_elements_Label, icms_form_elements_Password, icms_form_elements_Radio, icms_form_elements_Select

Indirect known subclasses

Abstract
Package: Form\Elements
Category: ICMS
Copyright: copyright (c) 2000-2003 XOOPS.org
License: GNU General Public License (GPL)
Author: Kazumi Ono onokazu@xoops.org
Author: Taiwen Jiang phppp@users.sourceforge.net
Located at form/Element.php

Methods summary
`public`	# `__construct( )` constructor constructor
`public boolean`	# `isContainer( )` Is this element a container of other elements? Is this element a container of other elements? Returns boolean false
`public`	# `setName( string $name )` set the "name" attribute for the element set the "name" attribute for the element Parameters `$name` "name" attribute for the element
`public string`	# `getName( boolean $encode = true )` get the "name" attribute for the element get the "name" attribute for the element Parameters `$encode` encode? Returns string "name" attribute
`public`	# `setAccessKey( string $key )` set the "accesskey" attribute for the element set the "accesskey" attribute for the element Parameters `$key` "accesskey" attribute for the element
`public string`	# `getAccessKey( )` get the "accesskey" attribute for the element get the "accesskey" attribute for the element Returns string "accesskey" attribute value
`public string`	# `getAccessString( string $str )` If the accesskey is found in the specified string, underlines it If the accesskey is found in the specified string, underlines it Parameters `$str` String where to search the accesskey occurence Returns string Enhanced string with the 1st occurence of accesskey underlined
`public`	# `setClass( string $class )` set the "class" attribute for the element set the "class" attribute for the element Parameters `$class` $key "class" attribute for the element
`public string`	# `getClass( )` get the "class" attribute for the element get the "class" attribute for the element Returns string "class" attribute value
`public`	# `setCaption( string $caption )` set the caption for the element set the caption for the element Parameters `$caption`
`public string`	# `getCaption( boolean $encode = false )` get the caption for the element get the caption for the element Parameters `$encode` To sanitizer the text? Returns string
`public`	# `setDescription( string $description )` set the element's description set the element's description Parameters `$description`
`public string`	# `getDescription( boolean $encode = false )` get the element's description get the element's description Parameters `$encode` To sanitizer the text? Returns string
`public`	# `setHidden( )` flag the element as "hidden" flag the element as "hidden"
`public boolean`	# `isHidden( )` Find out if an element is "hidden". Find out if an element is "hidden". Returns boolean
`public boolean`	# `isRequired( )` Find out if an element is required. Find out if an element is required. Returns boolean
`public`	# `setRequired( )`
`public array`	# `setExtra( string $extra, string $replace = false )` Add extra attributes to the element. Add extra attributes to the element. This string will be inserted verbatim and unvalidated in the element's tag. Know what you are doing! Parameters `$extra` `$replace` If true, passed string will replace current content otherwise it will be appended to it Returns array New content of the extra string
`public string`	# `getExtra( boolean $encode = false )` Get the extra attributes for the element Get the extra attributes for the element Parameters `$encode` To sanitizer the text? Returns string
`public`	# `renderValidationJS( )` Render custom javascript validation code Render custom javascript validation code See icms_form_Base::renderValidationJS
`abstract public`	# `render( )` Generates output for the element. Generates output for the element. This method is abstract and must be overwritten by the child classes.

Properties summary
`public array()`	`$customValidationCode` Javascript performing additional validation of this element data Javascript performing additional validation of this element data This property contains a list of Javascript snippets that will be sent to icms_form_Base::renderValidationJS(). NB: All elements are added to the output one after the other, so don't forget to add a ";" after each to ensure no Javascript syntax error is generated.	# `array()`
`protected string`	`$_name` "name" attribute of the element "name" attribute of the element	#
`protected string`	`$_caption` caption of the element caption of the element	#

Packages

Classes

Class icms_form_Element

Direct known subclasses

Indirect known subclasses

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

See