Class JElement

Description

Parameter base class

The JElement is the base class for all JElement types

  • deprecated: 12.1 Use JFormField instead
  • since: 11.1

Located in /libraries/joomla/html/parameter/element.php (line 22)

JObject
   |
   --JElement
Direct descendents
Class Description
JElementNewsfeed Renders a newsfeed selection element
JElementContact Renders a contact element
JElementAuthor Renders an author element
JElementArticle Renders an article element
JElementPassword Renders a password element
JElementList Renders a list element
JElementHelpsites Renders a helpsites element
JElementRadio Renders a radio element
JElementTimezones Renders a timezones element
JElementFolderlist Renders a filelist element
JElementCalendar Renders a calendar element
JElementSpacer Renders a spacer element
JElementUserGroup Renders a editors element
JElementMenuItem Renders a menu item element
JElementMenu Renders a menu element
JElementCategory Renders a category element
JElementEditors Renders a editors element
JElementTextarea Renders a textarea element
JElementImageList Renders a imagelist element
JElementLanguages Renders a languages element
JElementHidden Renders a hidden element
JElementText Renders a text element
JElementSQL Renders a SQL element
JElementFilelist Renders a filelist element
JElementTemplateStyle Renders a list of template styles.
Variable Summary
string $_name
object $_parent
Method Summary
JElement __construct ([string $parent = null])
void fetchElement (string $name, string $value, JXMLElement &$xmlElement, string $control_name)
string fetchTooltip (string $label, string $description, JXMLElement &$xmlElement, [string $control_name = ''], [string $name = ''])
string getName ()
array render (string &$xmlElement, string $value, [string $control_name = 'params'])
Variables
string $_name = null (line 33)

Element name

This has to be set in the final renderer classes.

  • since: 11.1
  • access: protected

Redefined in descendants as:
object $_parent = null (line 41)

Reference to the object that instantiated the element

  • since: 11.1
  • access: protected

Inherited Variables

Inherited from JObject

JObject::$_errors
Methods
Constructor __construct (line 50)

Constructor

  • since: 11.1
  • access: public
JElement __construct ([string $parent = null])
  • string $parent: Element parent

Redefinition of:
JObject::__construct()
Class constructor, overridden in descendant classes.
fetchElement (line 153)

Fetch an element

  • deprecated: 12.1
  • since: 11.1
  • access: public
void fetchElement (string $name, string $value, JXMLElement &$xmlElement, string $control_name)
  • string $name: Name attribute of the element
  • string $value: Value attribute of the element
  • JXMLElement &$xmlElement: Element object
  • string $control_name: Control name of the element

Redefined in descendants as:
fetchTooltip (line 121)

Method to get a tool tip from an XML element

  • deprecated: 12.1
  • since: 11.1
  • access: public
string fetchTooltip (string $label, string $description, JXMLElement &$xmlElement, [string $control_name = ''], [string $name = ''])
  • string $label: Label attribute for the element
  • string $description: Description attribute for the element
  • JXMLElement &$xmlElement: The element object
  • string $control_name: Control name
  • string $name: Name attribut

Redefined in descendants as:
getName (line 66)

Get the element name

  • return: type of the parameter
  • deprecated: 12.1
  • since: 11.1
  • access: public
string getName ()
render (line 86)

Method to render an xml element

  • return: Attributes of an element
  • deprecated: 12.1
  • since: 11.1
  • access: public
array render (string &$xmlElement, string $value, [string $control_name = 'params'])
  • string &$xmlElement: Name of the element
  • string $value: Value of the element
  • string $control_name: Name of the control

Inherited Methods

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 13:54:26 -0500 by phpDocumentor 1.4.4