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

Inheritance diagram for PushButtonCheckListFieldRenderer:

Collaboration diagram for PushButtonCheckListFieldRenderer:

Public Member Functions
	PushButtonCheckListFieldRenderer (&$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...

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

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

	renderButtons ($field, $mode=null, $readonly=false)

	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...

	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 = true

	$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 buttons from which the user can choose one or more responses.

Definition at line 45 of file push_button_checklist_field_renderer.inc.

Member Function Documentation

◆ addValidatorsToForm()

PushButtonCheckListFieldRenderer::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 push_button_checklist_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 RequiredValidator($field, $label));
           }
           
      }

◆ PushButtonCheckListFieldRenderer()

PushButtonCheckListFieldRenderer::PushButtonCheckListFieldRenderer	(	&	$form,
			$field,
			$label,
			$options,
			$onChange = `""`
	)

Definition at line 54 of file push_button_checklist_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);
           }
      }

◆ renderButtons()

PushButtonCheckListFieldRenderer::renderButtons	(	$field,
		$mode = `null`,
		$readonly = `false`
	)

Definition at line 131 of file push_button_checklist_field_renderer.inc.

      {
           $current = $this->parent->data->get($field);
           
           $separator = "";
           
           if ($this->regular && !$this->tabular)
           {
                $width = 100 / count($this->options);
                $widthStyle = " style='width: {$width}%'";
           }
           
           $containerId = "{$this->parent->id}_{$field}_container";
           
           $values = explode(",", $current);
           
           if ($this->tabular)
           {
                if ($this->regular)
                {
                     $width = 100 / count($this->options);
                     $tdStyle = " style='width: {$width}%'";
                }
                else
                {
                     $tdStyle = "";
                }
           
                echo "<table id='{$containerId}' class='push_button_options'><tr><td{$tdStyle}>";
                $separator = "</td><td{$tdStyle}>";
                $close = "</td></tr></table>";
           }
           else if ($this->horizontal)
           {
                echo "<div id='{$containerId}' class='push_button_options horizontal'>";
                $close = "</div>";
           }
           else
           {
                echo "<div id='{$containerId}' class='push_button_options vertical'>";
                $close = "</div>";
           }
           
           $name = $mode ? "$field:$mode" : $field;
           
           echo "<input type='hidden' id='{$this->parent->id}_{$field}' name='{$name}' value='$current'/>";
      
           $out = array();
      
           $max = count($this->options) - 1;
           $disable = ($this->disable) ? "disabled='disabled'" : "";
           
           $count = 0;
           foreach($this->options as $value => $name)
           {
                $selected = (array_search($value, $values) !== FALSE) ? " selected" : "";
                $onChange = ($this->onChange) ? "{$this->onChange}(this);" : "";
      
                $position = "";
                if ($count == 0) $position .= " first";
                if ($count == $max) $position .= " last";
           
                $handler = $readonly ? "" : "{$this->parent->id}_{$field}_update(this);{$onChange}";
                
                // JDG 3/34/10, add border: none to correct IE8 display issue
                $out[] = "<a class='pushbutton{$position}{$selected}'{$widthStyle} href='#' data-value='{$value}' onclick='{$handler}return false' {$disable}/>{$name}</a>";
      
                $count++;
           }
  
           $buttons = implode($separator, $out);
           $buttons .= $close;
           
           echo $buttons;
      }

◆ renderField()

PushButtonCheckListFieldRenderer::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 119 of file push_button_checklist_field_renderer.inc.

      {
           if (!count($this->options)) return;
           
           $this->_startField($field);
           
           $this->renderButtons($field);
           
           
           $this->_endField($field);
      }

◆ renderReadOnly()

PushButtonCheckListFieldRenderer::renderReadOnly ( $field )

Definition at line 221 of file push_button_checklist_field_renderer.inc.

      {         
           $this->_startField($field);
           
           $this->renderButtons($field, null, true);    
           
           $this->_endField($field);
      }

◆ renderScript()

PushButtonCheckListFieldRenderer::renderScript ( $field )

FieldRenderers can override this method to provide any Javascript that their control requires for an edit form.

Parameters

string $field the field name

Reimplemented from FieldRenderer.

Definition at line 84 of file push_button_checklist_field_renderer.inc.

      {
           $fn = "{$this->parent->id}_{$field}_update";
           $containerId = "{$this->parent->id}_{$field}_container";
           $id = "{$this->parent->id}_{$field}";
 ?>
 <script type='text/javascript'>
 function <?echo $fn?>(element)
 {
      var container = document.id('<?echo $containerId?>');
  
      element = document.id(element);
      if (element.hasClass('selected'))
      {
           element.removeClass('selected');
      }
      else 
      {
           element.addClass('selected');
      }
  
      var values = [];
           
      container.getElements("a.selected").each(function(elt)
      {
           values.push(elt.get('data-value'));
      });
  
      document.id('<?echo $id?>').value = values.join(",");
      return false;
 }
 </script>
 <?        
      }

◆ renderSearchField()

PushButtonCheckListFieldRenderer::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 207 of file push_button_checklist_field_renderer.inc.

      {
           if ($mode != "equal") return;
           
           $searchValue = $this->parent->params->get($field, $mode);
      
           $this->_startField($field);
           
           $this->renderButtons($field, $mode);
           
           $this->_endField($field);
      }