XoopsFormTextArea Class Reference

Inheritance diagram for XoopsFormTextArea:

Collaboration diagram for XoopsFormTextArea:

Public Member Functions
	__construct ($caption, $name, $value='', $rows=5, $cols=50)
	getRows ()
	getCols ()
	getValue ($encode=false)
	setValue ($value)
	render ()
Public Member Functions inherited from XoopsFormElement
	__construct ()
	isContainer ()
	setName ($name)
	getName ($encode=true)
	setAccessKey ($key)
	getAccessKey ()
	getAccessString ($str)
	setClass ($class)
	getClass ()
	setCaption ($caption)
	getCaption ($encode=false)
	getTitle ($encode=true)
	setDescription ($description)
	getDescription ($encode=false)
	setHidden ()
	isHidden ()
	isRequired ()
	setExtra ($extra, $replace=false)
	getExtra ($encode=false)
	setNocolspan ($nocolspan=true)
	getNocolspan ()
	getFormType ()
	setFormType ($value='')
	renderValidationJS ()
	render ()

Data Fields
	$_cols
	$_rows
	$_value
Data Fields inherited from XoopsFormElement
	$customValidationCode = array()
	$_name
	$_caption
	$_accesskey = ''
	$_class = array()
	$_hidden = false
	$_extra = array()
	$_required = false
	$_description = ''
	$_nocolspan = false
	$_formtype = ''

Detailed Description

A textarea

Constructor & Destructor Documentation

__construct()

__construct	(		$caption,
			$name,
			$value = '',
			$rows = 5,
			$cols = 50
	)

Constuctor

Parameters

string	$caption	caption
string	$name	name
string	$value	initial content
int	$rows	number of rows
int	$cols	number of columns

Reimplemented in XoopsFormEditor.

Here is the call graph for this function:

Member Function Documentation

getCols()

getCols

(

)

Get number of columns

Returns

int

Here is the caller graph for this function:

getRows()

getRows

(

)

get number of rows

Returns

int

Here is the caller graph for this function:

getValue()

getValue

(

$encode = false

)

Get initial content

Parameters

bool

$encode

To sanitizer the text? Default value should be "true"; however we have to set "false" for backward compatibility

Returns

string

Here is the caller graph for this function:

render()

render

(

)

prepare HTML for output

Returns

string HTML

Reimplemented from XoopsFormElement.

Reimplemented in FormDhtmlTextArea, XoopsFormTinymce, XoopsFormDhtmlTextArea, and XoopsFormEditor.

Here is the call graph for this function:

setValue()

setValue

(

$value

)

Set initial content

Parameters

string

$value

Here is the caller graph for this function:

Field Documentation

$_cols

$_cols

$_rows

$_rows

$_value

$_value

---

The documentation for this class was generated from the following file:

• C:/xoops2511b2/htdocs/class/xoopsform/formtextarea.php