Class JFormFieldMeter

Description

Form Field class for the Joomla Platform.

Provides a meter to show value in a range.

Located in /libraries/joomla/form/fields/meter.php (line 23)

JFormField
   |
   --JFormFieldNumber
      |
      --JFormFieldMeter
Variable Summary
 boolean $active
 boolean $animated
 boolean $color
 string $type
 string $width
Method Summary
 string getInput ()
 boolean setup (SimpleXMLElement $element, mixed $value, [string $group = null])
 mixed __get (string $name)
 void __set (string $name, mixed $value)
Variables
boolean $active = false (line 47)

Whether the field is active or not.

  • since: 3.2
  • access: protected
boolean $animated = true (line 55)

Whether the field is animated or not.

  • since: 3.2
  • access: protected
boolean $color (line 63)

The color of the field

  • since: 3.2
  • access: protected
string $type = 'Meter' (line 31)

The form field type.

  • since: 3.2
  • access: protected

Redefinition of:
JFormFieldNumber::$type
The form field type.
string $width (line 39)

The width of the field increased or decreased.

  • since: 3.2
  • access: protected

Inherited Variables

Inherited from JFormFieldNumber

JFormFieldNumber::$max
JFormFieldNumber::$min
JFormFieldNumber::$step

Inherited from JFormField

JFormField::$autocomplete
JFormField::$autofocus
JFormField::$class
JFormField::$count
JFormField::$default
JFormField::$description
JFormField::$disabled
JFormField::$element
JFormField::$fieldname
JFormField::$form
JFormField::$formControl
JFormField::$generated_fieldname
JFormField::$group
JFormField::$hidden
JFormField::$hint
JFormField::$id
JFormField::$input
JFormField::$label
JFormField::$labelClass
JFormField::$multiple
JFormField::$name
JFormField::$onchange
JFormField::$onclick
JFormField::$pattern
JFormField::$readonly
JFormField::$repeat
JFormField::$required
JFormField::$size
JFormField::$spellcheck
JFormField::$translateDescription
JFormField::$translateHint
JFormField::$translateLabel
JFormField::$validate
JFormField::$value
Methods
getInput (line 162)

Method to get the field input markup.

  • return: The field input markup.
  • since: 3.2
  • access: protected
string getInput ()

Redefinition of:
JFormFieldNumber::getInput()
Method to get the field input markup.
setup (line 136)

Method to attach a JForm object to the field.

boolean setup (SimpleXMLElement $element, mixed $value, [string $group = null])
  • SimpleXMLElement $element: The SimpleXMLElement object representing the <field /> tag for the form field object.
  • mixed $value: The form field value to validate.
  • string $group: The field name group control value. This acts as 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]".

Redefinition of:
JFormFieldNumber::setup()
Method to attach a JForm object to the field.
__get (line 74)

Method to get certain otherwise inaccessible properties from the form field object.

  • return: The property value or null.
  • since: 3.2
  • access: public
mixed __get (string $name)
  • string $name: The property name for which to the the value.

Redefinition of:
JFormFieldNumber::__get()
Method to get certain otherwise inaccessible properties from the form field object.
__set (line 98)

Method to set certain otherwise inaccessible properties of the form field object.

  • since: 3.2
  • access: public
void __set (string $name, mixed $value)
  • string $name: The property name for which to the the value.
  • mixed $value: The value of the property.

Redefinition of:
JFormFieldNumber::__set()
Method to set certain otherwise inaccessible properties of the form field object.

Inherited Methods

Inherited From JFormFieldNumber

 JFormFieldNumber::getInput()
 JFormFieldNumber::setup()
 JFormFieldNumber::__get()
 JFormFieldNumber::__set()

Inherited From JFormField

 JFormField::__construct()
 JFormField::getAttribute()
 JFormField::getControlGroup()
 JFormField::getFieldName()
 JFormField::getId()
 JFormField::getInput()
 JFormField::getLabel()
 JFormField::getName()
 JFormField::getTitle()
 JFormField::setForm()
 JFormField::setup()
 JFormField::setValue()
 JFormField::__get()
 JFormField::__set()

Documentation generated on Tue, 19 Nov 2013 15:08:10 +0100 by phpDocumentor 1.4.3