CheckListFieldRenderer: Renders the specified list of options as a list of checkboxes from which multiple values can be selected. More...

Inheritance diagram for CheckListFieldRenderer:

Collaboration diagram for CheckListFieldRenderer:

Public Member Functions
	CheckListFieldRenderer (&$form, $field, $label, $options, $grouped=false)

	allowAddEntry ($text="or add new", $size=40)

	setSize ($width, $height, $scrollAfter=0)

	addFixedOption ($value)

	addDefaultOption ($value)

	getOptionCount ()

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

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

	renderReadOnly ($field)

	renderSearchScript ($field, $mode)
	FieldRenderers can override this method to provide any Javascript that the control requires when being used in a search form. 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...

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

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

	addValidatorsToForm ($field, $required=false)
	This method is called by the AutoForm to add any default input validators that are required by the FieldRenderer. 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...

	renderOnSubmitHandler ($field)
	FieldRenderers can override this method to provide any Javascript that must be executed when the form is submitted on the client. 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

	$addEntry

	$addEntryText

	$grouped

	$addEntrySize = 20

	$width

	$height

	$resizable = false

	$nobr = false

	$dropdown

	$dropdownMaxWidth = "340px"

	$dropdownMessage = "Click to Select Terms"

	$showSelectAll = false

	$separator = ", "
	The separator between values in read only list. More...

	$fixedOptions = array()

	$defaultOptions = array()

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

CheckListFieldRenderer: Renders the specified list of options as a list of checkboxes from which multiple values can be selected.

The results are stored in the associated field as a comma-separated list of values.

Parameters

obj	$form	the AutoForm object, passed by reference
string	$field	the name of the field defined in the dataitem class object in the datamodel folder whose values can be changed by the checkbox list This field name should match the field name in the database.
string	$label	presented on the form to the user to describe the list
array	$options	defines the list of options available, as follows: $options = array ( 1 => "Option 1", 2 => "Option 2", 3 => "Option 3" ) For grouped lists, the structure would be: $options = array("Group 1" => array( 1 => "Option 1", 2 => "Option 2"), "Group 2" => array( 3 => "Option 3"));
boolean	$grouped	specifies whether the array defines a grouping structure for the checkbox list. The default is false.

Definition at line 73 of file checklist_field_renderer.inc.

Member Function Documentation

◆ addDefaultOption()

CheckListFieldRenderer::addDefaultOption ( $value )

Definition at line 134 of file checklist_field_renderer.inc.

      {    
           $this->defaultOptions[$value] = $value;
           
           return $this;
      }

◆ addFixedOption()

CheckListFieldRenderer::addFixedOption ( $value )

Definition at line 127 of file checklist_field_renderer.inc.

      {
           $this->fixedOptions[$value] = $value;
           
           return $this;
      }

◆ allowAddEntry()

CheckListFieldRenderer::allowAddEntry	(	$text = `"or add new"`,
		$size = `40`
	)

Definition at line 109 of file checklist_field_renderer.inc.

      {
           $this->addEntry = true;
           $this->addEntryText = $text;
           $this->addEntrySize = $size;
           
           return $this;
      }

◆ CheckListFieldRenderer()

CheckListFieldRenderer::CheckListFieldRenderer	(	&	$form,
			$field,
			$label,
			$options,
			$grouped = `false`
	)

Definition at line 93 of file checklist_field_renderer.inc.

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

◆ getOptionCount()

CheckListFieldRenderer::getOptionCount ( )

Definition at line 141 of file checklist_field_renderer.inc.

      {
           if (!$this->grouped) return count($this->options);
           
           $count = 0;
           
           foreach($this->options as $groupName => $group);
           {
                $count += count($group) + 1;
           }
           
           return $count;
      }

◆ preProcess()

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

For example, the FileUploadFieldRenderer overrides this method to process the uploading of the file and then store the location in the associated field in the target object.

Parameters

string $field the field name

Reimplemented from FieldRenderer.

Definition at line 452 of file checklist_field_renderer.inc.

      {         
           $value = ($this->parent->method == "POST") ? $_POST[$field] : $_GET[$field];
           $addEntry = ($this->parent->method == "POST") ? $_POST["{$field}_addEntry"] : $_GET["{$field}_addEntry"];
  
           if (is_array($value))
           {
                $this->parent->data->set($field, implode(",",  array_values($value)));
           }
           else if (!$value)
           {
                $this->parent->data->set($field, "");
           }
           else
           {
                $this->parent->data->set($field, $value);
           }
           
           trace("addEntry($field): $addEntry", 3);
           
           if ($addEntry)
           {
                if($this->parent->data->get($field))
                {
                     $this->parent->data->set($field, $this->parent->data->get($field) . ",");
                }
                
                $this->parent->data->set($field, $this->parent->data->get($field) . $addEntry);
           }
      }

◆ renderField()

CheckListFieldRenderer::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 155 of file checklist_field_renderer.inc.

      {
           $this->_startField($field);
           
           $rawValue = $this->parent->data->get($field);
           if (is_array($rawValue))
           {
                $this->preProcess($field);
                $rawValue = $this->parent->data->get($field);
           }
           
           $values = explode(",", $rawValue);      
                     
           $divider = $this->horizontal ? " " : "";
           $layout = $this->horizontal ? " style='display: inline'" : "";
           
           if ($this->showSelectAll)
           {
                echo "<a class='select_toggle' href='#' onclick='return {$this->parent->id}_{$field}_toggleSelectAll(this);'>Select All</a><br/>";
           }
           
           if ($this->width && $this->height && $this->getOptionCount() > $this->scrollAfter)
           {
                $width = is_numeric($this->width) ? "{$this->width}px" : $this->width;
                $height = is_numeric($this->height) ? "{$this->height}px" : $this->height;
                $padding = ($width == "auto") ? "padding-right: 20px; " : "";
                
                $resizable = ($this->resizable && !$this->dropdown) ? " resizable": "";
                $dropdown = $this->dropdown ? " multi_select_dropdown_list" : "";
                echo "<div id='{$this->parent->id}_{$field}_container' class='selectbox scrollbox{$resizable}{$dropdown}' style='width: {$width}; height: {$height}; $padding overflow: auto'>\n";
           }
           else
           {
                echo "<div class='selectbox'>";
           }
           
           $idx = 0;
           
           if ($this->grouped)
           {
                echo "<dl>\n";
                foreach($this->options as $groupName => $group)
                {
                     echo "<dt>$groupName</dt>\n<dd>\n";
                     foreach($group as $value => $text)
                     {
                          $checked = (array_search($value, $values) !== FALSE) ? " checked" : "";
                          
                          if ($this->nobr) { $text = str_replace(" ", "&nbsp;", $text); }
                          
                          echo "<label for='{$this->parent->id}_{$field}[$idx]'$layout><input type='checkbox' class='checkbox' id='{$this->parent->id}_{$field}[$idx]' name='{$field}[$idx]' value='$value'$checked/>$text</label>$divider";
                          $idx++;
                     }
                     
                     echo "</dd>";
                }
                echo "</dl>";
           }
           else
           {
                if(count($this->options) > 0)
                {
                     foreach($this->options as $value => $text)
                     {
                          $disabled = "";
                          
                          if ($this->fixedOptions[$value])
                          {
                               $disabled = " disabled";
                               $checked = " checked";
                          }
                          else if ($this->defaultOptions[$value])
                          {
                               $checked = "checked";
                          }
                          else
                          {
                               $checked = (array_search($value, $values) !== FALSE) ? " checked" : "";
                          }
                          if ($this->nobr) { $text = str_replace(" ", "&nbsp;", $text); }
                          echo "<label for='{$this->parent->id}_{$field}[$idx]'$layout><input type='checkbox' class='checkbox' id='{$this->parent->id}_{$field}[$idx]' name='{$field}[$idx]' value='$value'$checked$disabled/>$text</label>$divider";
                          $idx++;
                     }
  
                     if($this->addEntry)
                     {
                          foreach($values as $value)
                          {
                               if(!array_key_exists($value, $this->options))
                                    $addEntryValue .= $value;
                          }
                     }
                }
           }
           
           if ($this->addEntry)
           {
                echo "&nbsp;{$this->addEntryText}&nbsp;";
           }
           
           if ($this->addEntry)
           {
                echo "<input type='text' name='{$field}_addEntry' value='{$addEntryValue}' size='{$this->addEntrySize}'/>";
           }
           
           // Save this count to loop through checkboxes on required validation
           echo "<input type=\"hidden\" name=\"count_{$field}\" value=\"".$idx."\">";      
           
           echo "</div>\n";
           
           $this->_endField($field);
      }

◆ renderReadOnly()

CheckListFieldRenderer::renderReadOnly ( $field )

Definition at line 310 of file checklist_field_renderer.inc.

      {
           $this->_startField($field);
           
           $value = $this->parent->data->get($field);
  
           $items = explode(",", $value);
           
           if ($this->grouped)
           {
                foreach($this->options as $category => $options)
                {
                     $out = "";
                
                     foreach($items as $item)
                     {
                          if (array_key_exists($item, $options))
                          {
                               if (!$out) 
                               {
                                    $out = "$category: ";
                               }
                               else
                               {
                                    $out .= $this->separator;
                               }
                               
                               $out .= $options[$item];
                          }
                     }
                     
                     if ($out) $answers[] = $out;
                }
           }
           else
           {
                // JDG 3/12 - show option value, if found, instead of key
           
                foreach($items as $item)
                {
                     $answers[] = array_key_exists($item, $this->options) ? $this->options[$item] : $item;
                }
           }
           
           $value = implode($this->separator, $answers);
           
           echo $value;
  
           $this->_endField($field);
      }

◆ renderScript()

CheckListFieldRenderer::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 268 of file checklist_field_renderer.inc.

      {
           if ($this->showSelectAll)
           {
                ?>
      <script type="text/javascript">
      
      function <?echo $this->parent->id?>_<?echo $field ?>_toggleSelectAll(link)
      {
           link = document.id(link);
           
           var value = (link.innerHTML == "Select All");
      
           var container = document.id('<?echo $this->parent->id?>_<?echo $field?>_container');
           
           container.getElements("input[type=checkbox]").each(function(cbox)
           {
                cbox.set('checked', value);
           });
      
           link.innerHTML = (value) ? "Deselect All" : "Select All";
           if (container.multiSelect) container.multiSelect.selectionChanged();
           return false;
      }
      
      </script>
      <?
           }
                
           if ($this->dropdown)
           {
      ?>
      <script type='text/javascript'>
      window.addEvent('domready', function()
      {
           new MultiSelect('<?echo $this->parent->id?>_<?echo $field?>_container', {maxWidth: '<?echo $this->dropdownMaxWidth?>', message: '<?echo jsSafe($this->dropdownMessage)?>'});
      });
      </script>                
      <?
           }
      }         

◆ renderSearchField()

CheckListFieldRenderer::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 369 of file checklist_field_renderer.inc.

      {
           $this->_startField($field);
           
           $rawValue = $this->parent->params->get($field, $mode);
           
           if (is_array($rawValue))
           {
                $rawValue = implode(",", array_values($rawValue));
                $this->parent->params->set($field, $mode, $rawValue);
           }
           
           $values = explode(",", $rawValue);      
           $values = array_combine($values, $values);
  
           $divider = $this->horizontal ? " " : "";
           $layout = $this->horizontal ? " style='display: inline'" : "";
           
           if ($this->showSelectAll)
           {
                echo "<a href='#' onclick='return {$this->parent->id}_{$field}_toggleSelectAll(this);'>Select All</a><br/>";
           }
           
           if ($this->width && $this->height && $this->getOptionCount() > $this->scrollAfter)
           {
                $width = is_numeric($this->width) ? "{$this->width}px" : $this->width;
                $height = is_numeric($this->height) ? "{$this->height}px" : $this->height;
                $padding = ($width == "auto") ? "padding-right: 20px; " : "";
                
                $resizable = ($this->resizable && !$this->dropdown) ? " resizable": "";
                $dropdown = $this->dropdown ? " multi_select_dropdown_list" : "";
                echo "<div id='{$this->parent->id}_{$field}_container' class='selectbox scrollbox{$resizable}{$dropdown}' style='width: {$width}; height: {$height}; $padding overflow: auto'>\n";
           }
           else
           {
                echo "<div class='selectbox'>";
           }         
           $idx = 0;
  
           
           if ($this->grouped)
           {
                echo "<dl>\n";
                foreach($this->options as $groupName => $group)
                {
                     echo "<dt>$groupName</dt>\n<dd>\n";
                     foreach($group as $value => $text)
                     {
                          $checked = (array_search($value, $values) !== FALSE) ? " checked" : "";
                          
                          if ($this->nobr) { $text = str_replace(" ", "&nbsp;", $text); }
                          
                          echo "<label for='{$this->parent->id}_{$field}_$idx'$layout><input type='checkbox' class='checkbox' id='{$this->parent->id}_{$field}_$idx' name='{$field}:{$mode}[$idx]' value='$value'$checked/>$text</label>$divider";
                               
                          $idx++;
                     }
                     
                     echo "</dd>";
                }
                echo "</dl>";
           }
           else
           {
                if(count($this->options) > 0)
                {
                     foreach($this->options as $value => $text)
                     {
                          $checked = (array_key_exists($value, $values)) ? " checked" : "";
                          echo "<label for='{$this->parent->id}_{$field}_$value'$layout><input type='checkbox' class='checkbox' id='{$this->parent->id}_{$field}_$value' name='{$field}:{$mode}[$value]' value='$value'$checked/>$text</label>$divider";
                               
                          $idx++;
                     }
                }
           }
                     
           if ($this->width && $this->height)
           {
                echo "</div>\n";
           }
           
           $this->_endField($field);
      }

◆ renderSearchScript()

CheckListFieldRenderer::renderSearchScript	(	$field,
		$mode
	)

FieldRenderers can override this method to provide any Javascript that the control requires when being used in a search form.

Parameters

string	$field	the field name
string	$mode	the search mode for the specific field ('equal', 'like', 'from', 'to', 'range')

Reimplemented from FieldRenderer.

Definition at line 361 of file checklist_field_renderer.inc.

      {
           $this->renderScript($field);
      }

◆ setSize()

CheckListFieldRenderer::setSize	(	$width,
		$height,
		$scrollAfter = `0`
	)

Definition at line 118 of file checklist_field_renderer.inc.

      {
           $this->width = $width;
           $this->height = $height;
           $this->scrollAfter = $scrollAfter;
           
           return $this;
      }