XoopsFormDhtmlTextArea Class Reference

Inheritance diagram for XoopsFormDhtmlTextArea:

Collaboration diagram for XoopsFormDhtmlTextArea:

Public Member Functions
	__construct ($caption, $name, $value='', $rows=5, $cols=50, $hiddentext='xoopsHiddenText', $options=array())
	render ()
	renderValidationJS ()
Public Member Functions inherited from XoopsFormTextArea
	__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
	$htmlEditor = array()
	$_hiddenText
	$skipPreview = false
	$doHtml = false
	$js = ''
Data Fields inherited from XoopsFormTextArea
	$_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 with xoopsish formatting and smilie buttons

Constructor & Destructor Documentation

__construct()

__construct	(		$caption,
			$name,
			$value = '',
			$rows = 5,
			$cols = 50,
			$hiddentext = 'xoopsHiddenText',
			$options = array()
	)

Constructor

Parameters

string	$caption	Caption
string	$name	"name" attribute
string	$value	Initial text
int	$rows	Number of rows
int	$cols	Number of columns
string	$hiddentext	Identifier for hidden Text
array	$options	Extra options

Here is the call graph for this function:

Member Function Documentation

render()

render

(

)

Prepare HTML for output

Returns

string HTML

Reimplemented from XoopsFormTextArea.

Here is the call graph for this function:

renderValidationJS()

renderValidationJS

(

)

XoopsFormDhtmlTextArea::renderValidationJS()

Returns

bool|string

Reimplemented from XoopsFormElement.

Field Documentation

$_hiddenText

$_hiddenText

$doHtml

$doHtml = false

$htmlEditor

$htmlEditor = array()

Extended HTML editor

If an extended HTML editor is set, the renderer will be replaced by the specified editor, usually a visual or WYSIWYG editor.

and user guide:

run-time settings per call To use an editor pre-configured by XoopsEditor, e.g. 'fckeditor': $options['editor'] = 'fckeditor'; To use a custom editor, e.g. 'MyEditor' class located in "/modules/myeditor/myeditor.php": $options['editor'] = array('MyEditor', XOOPS_ROOT_PATH . "/modules/myeditor/myeditor.php");

pre-configured settings, which will force to use a editor if no specific editor is set for call

up custom configs: in XOOPS_VAR_PATH . '/configs/xoopsconfig.php' set a editor as default, e.g. a pre-configured editor 'fckeditor': return array('editor' => 'fckeditor'); a custom editor 'MyEditor' class located in "/modules/myeditor/myeditor.php": return array('editor' => array('MyEditor', XOOPS_ROOT_PATH . "/modules/myeditor/myeditor.php"); To disable the default editor, in XOOPS_VAR_PATH . '/configs/xoopsconfig.php': return array(); To disable the default editor for a specific call: $options['editor'] = 'dhtmltextarea';

$js

$js = ''

$skipPreview

$skipPreview = false

---

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

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