FormDhtmlTextArea

Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

FormDhtmlTextArea

Pseudo class

• Class name: FormDhtmlTextArea
• Namespace:
• Parent class: icms_form_elements_Dhtmltextarea

Properties

$htmlEditor

public mixed $htmlEditor = array()

Extended HTML editor definition

Note: the PM window doesn't use icms_form_elements_Dhtmltextarea, so no need to report it doesn't work here

array('className', 'classPath'): To create an instance of "className", declared in the file ICMS_ROOT_PATH . $classPath

Example: $htmlEditor = array('XoopsFormTinyeditorTextArea', '/class/xoopseditor/tinyeditor/formtinyeditortextarea.php');

• Visibility: public

$_hiddenText

private string $_hiddenText

Hidden text

• Visibility: private

$_cols

protected int $_cols

number of columns

• Visibility: protected

$_rows

protected int $_rows

number of rows

• Visibility: protected

$_value

protected string $_value

initial content

• Visibility: protected

Methods

FormDhtmlTextArea

mixed FormDhtmlTextArea::FormDhtmlTextArea(array configs, \binary checkCompatible)

Constructor

• Visibility: public

Arguments

• configs array - <p>Editor Options</p>
• checkCompatible binary - <p>true - return false on failure</p>

__construct

mixed icms_form_elements_Textarea::__construct(string caption, string name, string value, int rows, int cols)

Constuctor

• Visibility: public
• This method is defined by icms_form_elements_Textarea

Arguments

• caption string - <p>caption</p>
• name string - <p>name</p>
• value string - <p>initial content</p>
• rows int - <p>number of rows</p>
• cols int - <p>number of columns</p>

render

string icms_form_elements_Textarea::render()

prepare HTML for output

• Visibility: public
• This method is defined by icms_form_elements_Textarea

renderValidationJS

mixed icms_form_elements_Dhtmltextarea::renderValidationJS()

Render Validation Javascript

• Visibility: public
• This method is defined by icms_form_elements_Dhtmltextarea

_renderSmileys

string icms_form_elements_Dhtmltextarea::_renderSmileys()

prepare HTML for output of the smiley list.

• Visibility: private
• This method is defined by icms_form_elements_Dhtmltextarea

getRows

int icms_form_elements_Textarea::getRows()

get number of rows

• Visibility: public
• This method is defined by icms_form_elements_Textarea

getCols

int icms_form_elements_Textarea::getCols()

Get number of columns

• Visibility: public
• This method is defined by icms_form_elements_Textarea

getValue

string icms_form_elements_Textarea::getValue(bool encode)

Get initial content

• Visibility: public
• This method is defined by icms_form_elements_Textarea

Arguments

• encode bool - <p>To sanitize the text? Default value should be "true"; however we have to set "false" for backward compatibility</p>

setValue

mixed icms_form_elements_Textarea::setValue(value)

Set initial content

• Visibility: public
• This method is defined by icms_form_elements_Textarea

Arguments

• value mixed - <p>string</p>