Field renderer for data fields that must be displayed as a list of choices. More...

Inheritance diagram for RadioButtonFieldRenderer:

Collaboration diagram for RadioButtonFieldRenderer:

Public Member Functions
	RadioButtonFieldRenderer (&$form, $field, $label, $options, $onchange="")

	addValidatorsToForm ($field, $required=false)
	This method is called by the AutoForm to add any default input validators that are required by the FieldRenderer. More...

	renderField ($field)
	FieldRenderers must override this method to provide the HTML implementation of the control used to edit the field. More...

	renderSearchField ($field, $mode)
	FieldRenderers must override this method to provide the HTML implementation of the control displayed for the field in a search form. More...

	renderReadOnly ($field)

Public Member Functions inherited from FieldRenderer
	FieldRenderer ($parent)
	Constructor. More...

	_printLabel ($field, $colspan=1, $styles="", $annotation="")
	Internal method to generate the HTML for the field label. More...

	_getLabel ($field, $addSuffix=true)

	_startField ($field, $styles="")
	Internal method to generate the starting HTML for the field (including the label) More...

	_endField ($field)
	Internal method to generate the closing HTML for the field. More...

	addSearchValidatorsToForm ($field, $mode, $required=false)
	For SearchForm, the validator field needs to match the name tag in the form which is in the format field:mode. More...

	formatName ($item, $name)
	Formats the given DataItem based on the supplied format string. More...

	renderScript ($field)
	FieldRenderers can override this method to provide any Javascript that their control requires for an edit form. More...

	renderSearchScript ($field, $mode)
	FieldRenderers can override this method to provide any Javascript that the control requires when being used in a search form. More...

	renderOnSubmitHandler ($field)
	FieldRenderers can override this method to provide any Javascript that must be executed when the form is submitted on the client. More...

	preProcess ($field="")
	FieldRenderers can override this method to provide behavior that occurs prior to the saving of the parent form's target object to the database. More...

	postProcess ($field="")
	FieldRenderers can override this method to provide behavior that occurs after the parent form's target object has been saved to the database. More...

Public Attributes
	$options

	$horizontal = false

	$onChange = ""

	$disable = false

	$tabular = false

	$regular = false

Public Attributes inherited from FieldRenderer
	$parent = null

	$labelSuffix = ""

	$colspan = 1

	$annotateBefore = false

	$annotateNextLine = true

	$hideLabel = false

	$onPreProcess = null
	callback hook for processing prior to saving the form's data object - individual renderers may override with custom processing More...

	$onPostProcess = null
	callback hook for processing after saving the form's data object - individual renderers may override with custom processing More...

Detailed Description

Field renderer for data fields that must be displayed as a list of choices.

Renders as a set of radio buttons from which the user can choose only one response.

Definition at line 45 of file radio_button_field_renderer.inc.

Member Function Documentation

◆ addValidatorsToForm()

RadioButtonFieldRenderer::addValidatorsToForm	(	$field,
		$required = `false`
	)

This method is called by the AutoForm to add any default input validators that are required by the FieldRenderer.

Fields that need custom validation or a custom required validator should override this function.

Parameters

string	$field	the field name
boolean	$required	- whether the field is required

Reimplemented from FieldRenderer.

Definition at line 71 of file radio_button_field_renderer.inc.

      {
           $label = isset($this->label) ? $this->label : $this->parent->prettifyFieldName($field);
           
           // JDG 2/2012 - changed from tree validator expects a div and does not match the rendering of this type
           if($required)
           {
                $this->parent->validator->add(new RequiredRadioButtonValidator($field, $label));
           }
           
      }

◆ RadioButtonFieldRenderer()

RadioButtonFieldRenderer::RadioButtonFieldRenderer	(	&	$form,
			$field,
			$label,
			$options,
			$onchange = `""`
	)

Definition at line 54 of file radio_button_field_renderer.inc.

      {
           $this->options = $options;
           $this->onChange = $onchange;
           
           $this->FieldRenderer($form);
           if ($form->data->hasField($field))
           {
                $form->override($field, $label, $this);
           }
           else
           {
                $form->add($this, $field);
                $form->alias($field, $label);
           }
      }

◆ renderField()

RadioButtonFieldRenderer::renderField ( $field )

FieldRenderers must override this method to provide the HTML implementation of the control used to edit the field.

Parameters

string $field the field name

Reimplemented from FieldRenderer.

Definition at line 84 of file radio_button_field_renderer.inc.

      {
           if (!count($this->options)) return;
           
           if(($this->horizontal || $this->tabular) && count($this->options) > 2)
                $this->colspan = 2;
           $this->_startField($field);
           
           $current = $this->parent->data->get($field);
           
           $separator = "<br/>";
           
           if ($this->tabular)
           {
                if ($this->regular)
                {
                     if ($this->horizontal)
                     {
                          $width = 100 / count($this->options);
                     }
                     else
                     {
                          $width = 100;
                     }
                     $tdStyle = " style='width: {$width}%'";
                }
                else
                {
                     $tdStyle = "";
                }
                     
                echo "<table class='radio_button_options'><tr><td{$tdStyle}>";
                $separator = $this->horizontal ? "</td><td>" : "</td></tr><tr><td>";
           }
           else if ($this->horizontal)
           {
                 $separator = "&nbsp;&nbsp;";
           }
           
           $out = array();
           
           foreach($this->options as $value => $name)
           {
                $selected = ($current == $value) ? " checked" : "";
                $onchange = ($this->onChange) ? "onclick='$this->onChange(this)'" : "";
                $disable = ($this->disable) ? "disabled='disabled'" : "";
                
                // JDG 3/34/10, add border: none to correct IE8 display issue
                $out[] = "<label class='radio' for='{$this->parent->id}_{$field}_{$value}'><input id='{$this->parent->id}_{$field}_{$value}' style='border: none' type='radio' name='$field' value='$value'$selected $onchange $disable/>&nbsp;$name</label>";
           }
  
           $radios = implode($separator, $out);
           if ($this->tabular)
           {
                $radios .= "</td></tr></table>";
           }
           
           echo $radios;
           
           $this->_endField($field);
      }

◆ renderReadOnly()

RadioButtonFieldRenderer::renderReadOnly ( $field )

Definition at line 168 of file radio_button_field_renderer.inc.

      {
           $this->_startField($field);
  
           if (array_key_exists($this->parent->data->get($field), $this->options))
           {
                echo $this->options[$this->parent->data->get($field)];
           }
           else
           {
                echo "Not specified";
           }
           $this->_endField($field);
      }

◆ renderSearchField()

RadioButtonFieldRenderer::renderSearchField	(	$field,
		$mode
	)

FieldRenderers must override this method to provide the HTML implementation of the control displayed for the field in a search form.

Parameters

string $field the field name

Reimplemented from FieldRenderer.

Definition at line 150 of file radio_button_field_renderer.inc.

      {
           if ($mode != "equal") return;
           
           $searchValue = $this->parent->params->get($field, $mode);
           echo "<tr>\n";
           $this->_printLabel($field);
           echo "<td>\n";
           foreach($this->options as $value => $name)
           {
                $selected = ($searchValue == $value) ? " checked" : "";
                echo "<input style='border: none' type='radio' name='$field:$mode' value='$value'$selected>$name</option>";
                echo ($this->horizontal) ? "&nbsp;&nbsp;" : "<br/>";
           }
           echo "</td></tr>\n";
      }