Class: pnFormRadioButton

pnFormPlugin
   |
   --pnFormStyledPlugin
      |
      --pnFormRadioButton

[line 47]
Radiobutton plugin

Plugin to generate a radiobutton for selecting one-of-X. Usage with fixed number of radiobuttons:

1.  <!--[pnformradiobutton id=yesButton dataField=ok]--> <!--[pnformlabel text=Yes for=yesButton]--> <br/>
2.  <!--[pnformradiobutton id=noButton dataField=ok]--> <!--[pnformlabel text=No for=noButton]-->

The above case sets 'ok' to either 'yesButton' or 'noButton' in the hashtable returned by pnFormRender::pnFormGetValues(). As you can see the radiobutton defaults to using the ID for the returned value in the hashtable. You can override this by setting 'value' to something different.

You can also enforce a selection:

1.  <!--[pnformradiobutton id=yesButton dataField=ok mandatory=1]--> <!--[pnformlabel text=Yes for=yesButton]--> <br/>
2.  <!--[pnformradiobutton id=noButton dataField=ok mandatory=1]--> <!--[pnformlabel text=No for=noButton]-->

If you have a list of radiobuttons inside a for/each loop then you can set the ID to something from the data loop like here:

1.  <!--[foreach from=$items item=item]-->
2.    <!--[pnformradiobutton id=$item.name dataField=item mandatory=true]--> <!--[pnformlabel text=$item.title for=$item.name]-->
3.  <!--[/foreach]-->

$autoPostBack =

[line 130]

Enable or disable auto postback

Auto postback means "generate a server side event when selection changes". If enabled then the event handler named in $onSelectedIndexChanged will be fired in the main form event handler.

$checked =

[line 63]

Checked

The current state of the radio button

$dataBased =

[line 83]

Enable or disable use of $dataField

$dataField =

[line 77]

Data field name for looking up initial data

The name stored here is used to lookup initial data for the plugin in the render's variables. Defaults to the ID of the plugin. See also tutorials on the Zikula site.

$errorMessage =

[line 146]

Error message to display when input does not validate

Use pnFormRadioButton::setError() and pnFormRadioButton::clearValidation() to change the value.

$group =

[line 94]

Group name for this input

The group name is used to locate data in the render (when databased) and to restrict which plugins to do validation on (to be implemented).

Tags:

$groupName =

[line 100]

Radiobutton selection group name

$isValid =  true

[line 111]

Validation indicator used by the framework.

The true/false value of this variable indicates whether or not radiobutton selection is valid (a valid (set of) radiobuttons satisfies the mandatory requirement). Use pnFormRadioButton::setError() and pnFormRadioButton::clearValidation() to change the value.

$mandatory =

[line 120]

Enable or disable mandatory check

By enabling mandatory checking you force the user to check one of the radio buttons on the page that shares the same groupName.

$myLabel =

[line 155]

Text label for this plugin

This variable contains the label text for the radiobutton. The pnFormLabel plugin will set this text automatically when it is a label for this input.

$onCheckedChanged =  'handleCheckedChanged'

[line 137]

Name of checked changed method

Tags:

$readOnly =

[line 68]

Enable or disable read only mode

$validationChecked =  false

[line 158]

$value =

[line 55]

Value

The value returned in pnFormGetValues() when this radio button is checked.

---

method clearValidation [line 314]

---

method create [line 167]

---

method decode [line 251]

---

method findCheckedRadioButton [line 274]

---

method findCheckedRadioButton_rec [line 286]

---

method getFilename [line 161]

---

method initialize [line 215]

---

method load [line 182]

---

method loadValue [line 188]

---

method raisePostBackEvent [line 243]

---

method render [line 221]

---

method saveValue [line 321]

---

method setError [line 307]

---

method validate [line 259]