Class JFormFieldEditor

A textarea field for content creation

JFormField

JFormFieldEditor

Direct known subclasses

FOFFormFieldEditor

Package: Joomla\Libraries\Form
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 1.6
See: JEditor
Located at cms/form/field/editor.php

Methods summary

`public mixed`	# `__get( string $name )` Method to get certain otherwise inaccessible properties from the form field object. Method to get certain otherwise inaccessible properties from the form field object. Parameters `$name` `string` - $name The property name for which to the the value. Returns `mixed` - The property value or null. Since 3.2 Overrides `JFormFieldTextarea::__get`
`public`	# `__set( string $name, mixed $value )` Method to set certain otherwise inaccessible properties of the form field object. Method to set certain otherwise inaccessible properties of the form field object. Parameters `$name` `string` - $name The property name for which to the the value. `$value` `mixed` - $value The value of the property. Since 3.2 Overrides `JFormFieldTextarea::__set`
`public boolean`	# `setup( SimpleXMLElement $element, mixed $value, string $group = null )` Method to attach a JForm object to the field. Method to attach a JForm object to the field. Parameters `$element` `SimpleXMLElement` - $element The SimpleXMLElement object representing the `<field>` tag for the form field object. `$value` `mixed` - $value The form field value to validate. `$group` `string` - $group The field name group control value. This acts as an array container for the field. For example if the field has name="foo" and the group value is set to "bar" then the full field name would end up being "bar[foo]". Returns `boolean` - True on success. Since 3.2 See `JFormField::setup()` Overrides `JFormFieldTextarea::setup`
`protected string`	# `getInput( )` Method to get the field input markup for the editor area Method to get the field input markup for the editor area Returns `string` - The field input markup. Since 1.6 Overrides `JFormFieldTextarea::getInput`
`protected JEditor`	# `getEditor( )` Method to get a JEditor object based on the form field. Method to get a JEditor object based on the form field. Returns `JEditor` - The JEditor object. Since 1.6
`public string`	# `save( )` Method to get the JEditor output for an onSave event. Method to get the JEditor output for an onSave event. Returns `string` - The JEditor object output. Since 1.6

Methods inherited from JFormFieldTextarea

getLayoutData()

Methods inherited from JFormField

__construct(), getAttribute(), getControlGroup(), getFieldName(), getId(), getLabel(), getLayoutPaths(), getName(), getRenderer(), getTitle(), isDebugEnabled(), render(), renderField(), setForm(), setValue()

Magic methods summary

Properties summary

`public string`	`$type`	# The form field type. The form field type. Since 1.6
`protected JEditor`	`$editor`	# The JEditor object. The JEditor object. Since 1.6
`protected string`	`$height`	# The height of the editor. The height of the editor. Since 3.2
`protected string`	`$width`	# The width of the editor. The width of the editor. Since 3.2
`protected string`	`$assetField`	# The assetField of the editor. The assetField of the editor. Since 3.2
`protected string`	`$authorField`	# The authorField of the editor. The authorField of the editor. Since 3.2
`protected string`	`$asset`	# The asset of the editor. The asset of the editor. Since 3.2
`protected mixed`	`$buttons`	# The buttons of the editor. The buttons of the editor. Since 3.2
`protected array`	`$hide`	# The hide of the editor. The hide of the editor. Since 3.2
`protected array`	`$editorType`	# The editorType of the editor. The editorType of the editor. Since 3.2

Properties inherited from JFormFieldTextarea

$columns, $layout, $maxlength, $rows

Properties inherited from JFormField

$autocomplete, $autofocus, $class, $count, $default, $description, $disabled, $element, $fieldname, $form, $formControl, $generated_fieldname, $group, $hidden, $hint, $id, $input, $label, $labelclass, $multiple, $name, $onchange, $onclick, $pattern, $readonly, $renderLabelLayout, $renderLayout, $repeat, $required, $showon, $size, $spellcheck, $translateDescription, $translateHint, $translateLabel, $validate, $value

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JFormFieldEditor

Direct known subclasses

Methods summary

Parameters

Returns

Since

Overrides

Parameters

Since

Overrides

Parameters

Returns

Since

See

Overrides

Returns

Since

Overrides

Returns

Since

Returns

Since

Methods inherited from JFormFieldTextarea

Methods inherited from JFormField

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Since

Since

Since

Since

Since

Properties inherited from JFormFieldTextarea

Properties inherited from JFormField