ChromestyleField
Extends JFormFieldGroupedListChrome Styles field.
| since |
3.0 |
|---|---|
| package |
Joomla CMS |
Methods
__get
Method to get certain otherwise inaccessible properties from the form field object.
__get(string name) : mixed
| since |
3.2 |
|---|
Arguments
- name
stringThe property name for which to get the value.
Response
mixedThe property value or null.
__set
Method to set certain otherwise inaccessible properties of the form field object.
__set(string name, mixed value) : void
| since |
3.2 |
|---|
Arguments
- name
stringThe property name for which to get the value.- value
mixedThe value of the property.
getGroups
Method to get the list of template chrome style options grouped by template.
getGroups() : array
| since |
3.0 |
|---|
Response
arrayThe field option objects as a nested array in groups.
getSystemTemplate
Method to get the system template as an object.
getSystemTemplate() : \stdClass
| since |
3.0 |
|---|
Response
\stdClassThe object of system template.
getTemplateModuleStyles
Method to get the templates module styles.
getTemplateModuleStyles() : array
| since |
3.0 |
|---|
Response
arrayThe array of styles, grouped by templates.
getTemplates
Return a list of templates
getTemplates() : array
| since |
3.2.1 |
|---|
Response
arrayList of templates
setup
Method to attach a JForm object to the field.
setup(\SimpleXMLElement element, mixed value, string group = null) : bool
| see | JFormField::setup() |
|---|---|
| since |
3.2 |
Arguments
- element
\SimpleXMLElementThe SimpleXMLElement object representing the<field>tag for the form field object.- value
mixedThe form field value to validate.- group
stringThe 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]".
Response
boolTrue on success.
Properties
type
The form field type.
| since |
3.0 |
|---|
Type(s)
string
clientId
The client ID.
| since |
3.2 |
|---|
Type(s)
int