J1.5

Difference between revisions of "Spacer parameter type"

From Joomla! Documentation

(This is a parameter, not a form field.)
Line 1: Line 1:
 
[[Image:Params.spacer.jpg|right]]
 
[[Image:Params.spacer.jpg|right]]
 +
 +
{{Ambox|type=notice|text=[[Parameter|Parameters]] have been superseded by [[Form field|form fields]] in Joomla! 1.6. You may want to use the corresponding [[Spacer form field type]].}}
 +
 
The '''spacer''' parameter type provides a visual separator between parameter field elements.  It is purely a visual aid and no parameter value is stored.
 
The '''spacer''' parameter type provides a visual separator between parameter field elements.  It is purely a visual aid and no parameter value is stored.
  
 
* '''type''' (mandatory) must be ''spacer''.
 
* '''type''' (mandatory) must be ''spacer''.
 
* '''default''' (optional) (translatable) is a string which will be used instead of the ''<nowiki><hr /></nowiki>'' that is inserted by default.
 
* '''default''' (optional) (translatable) is a string which will be used instead of the ''<nowiki><hr /></nowiki>'' that is inserted by default.
 
  
 
Example XML parameter definition:
 
Example XML parameter definition:
Line 14: Line 16:
 
Note that you can also include HTML markup but it must be encoded.  For example, to put the text into bold you can use:
 
Note that you can also include HTML markup but it must be encoded.  For example, to put the text into bold you can use:
 
<source lang="xml"><param type="spacer" default="&lt;b&gt;Advanced parameters&lt;/b&gt;" /></source>
 
<source lang="xml"><param type="spacer" default="&lt;b&gt;Advanced parameters&lt;/b&gt;" /></source>
 
'''Changes in Joomla! 1.6'''
 
 
Typical  hr spacer:
 
 
<source lang="xml"><field name="spacer1" type="spacer"
 
hr="true"
 
/></source>
 
 
Typical text spacer:
 
 
<source lang="xml"><field name="spacer" type="spacer" class="text"
 
label="PLG_TINY_FIELD_NAME_EXTENDED_LABEL"
 
/></source>
 
 
and add the JText key into the extension ini file.
 
 
 
<noinclude>
 
<noinclude>
 
=== See also ===
 
=== See also ===
* [[Standard form field types|Table of all standard form field types]]
+
* [[Standard parameter types|List of standard parameter types]]
[[Category:Standard form field types]]</noinclude>
+
[[Category:Standard parameter types]]</noinclude>

Revision as of 08:03, 21 May 2011

The "J1.5" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Params.spacer.jpg

The spacer parameter type provides a visual separator between parameter field elements. It is purely a visual aid and no parameter value is stored.

  • type (mandatory) must be spacer.
  • default (optional) (translatable) is a string which will be used instead of the <hr /> that is inserted by default.

Example XML parameter definition:

<param type="spacer" />

You can replace the basic horizontal line with a title which can be used to group parameters. For example,

<param type="spacer" default="Advanced parameters" />

Note that you can also include HTML markup but it must be encoded. For example, to put the text into bold you can use:

<param type="spacer" default="&lt;b&gt;Advanced parameters&lt;/b&gt;" />

See also[edit]