XOOPS 2.5.6  Final
 All Classes Namespaces Files Functions Variables Pages
XoopsFormDhtmlTextArea Class Reference
Inheritance diagram for XoopsFormDhtmlTextArea:
Inheritance graph

Public Member Functions

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

Public Attributes

 $_hiddenText
 
 $doHtml = false
 
 $htmlEditor = array()
 
 $js = ''
 
 $skipPreview = false
 
- Public Attributes inherited from XoopsFormTextArea
 $_cols
 
 $_rows
 
 $_value
 
- Public Attributes inherited from XoopsFormElement
 $_accesskey = ''
 
 $_caption
 
 $_class = array()
 
 $_description = ''
 
 $_extra = array()
 
 $_formtype = ''
 
 $_hidden = false
 
 $_name
 
 $_nocolspan = false
 
 $_required = false
 
 $customValidationCode = array()
 

Detailed Description

A textarea with xoopsish formatting and smilie buttons

Definition at line 34 of file formdhtmltextarea.php.

Member Function Documentation

XoopsFormDhtmlTextArea::render ( )

Prepare HTML for output

Returns
string HTML

Definition at line 137 of file formdhtmltextarea.php.

References $GLOBALS, $javascript, $js, $ret, _PREVIEW, _XOOPS_FORM_ALT_CHECKLENGTH, _XOOPS_FORM_ALT_LENGTH, _XOOPS_FORM_ALT_LENGTH_MAX, _XOOPS_FORM_PREVIEW_CONTENT, and xoops_loadLanguage().

Here is the call graph for this function:

XoopsFormDhtmlTextArea::renderValidationJS ( )
XoopsFormDhtmlTextArea::XoopsFormDhtmlTextArea (   $caption,
  $name,
  $value = "",
  $rows = 5,
  $cols = 50,
  $hiddentext = "xoopsHiddenText",
  $options = array() 
)

Constructor

Parameters
string$captionCaption
string$name"name" attribute
string$valueInitial text
int$rowsNumber of rows
int$colsNumber of columns
string$hiddentextIdentifier for hidden Text
array$optionsExtra options

Definition at line 81 of file formdhtmltextarea.php.

References $options, $path, $xoopsConfig, XoopsEditorHandler\getInstance(), and xoops_load().

Here is the call graph for this function:

Member Data Documentation

XoopsFormDhtmlTextArea::$_hiddenText

Definition at line 64 of file formdhtmltextarea.php.

XoopsFormDhtmlTextArea::$doHtml = false

Definition at line 67 of file formdhtmltextarea.php.

XoopsFormDhtmlTextArea::$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';

Definition at line 56 of file formdhtmltextarea.php.

XoopsFormDhtmlTextArea::$js = ''

Definition at line 68 of file formdhtmltextarea.php.

XoopsFormDhtmlTextArea::$skipPreview = false

Definition at line 66 of file formdhtmltextarea.php.


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