Displays a control that provides a highly styleable set of options from which the user can select a number of items. More...

Inheritance diagram for OptionCheckListFieldRenderer:

Collaboration diagram for OptionCheckListFieldRenderer:

Public Member Functions
	OptionCheckListFieldRenderer (&$form, $field, $label, $options)

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

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

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

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

	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 = array()

	$cssClass = "options_list"

	$separator = ", "

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

Displays a control that provides a highly styleable set of options from which the user can select a number of items.

The optons are provided as an array of value-description pairs, and are rendered as an unordered list in HTML, with javascript to provide the selection interaction. Clicking on one of the items will select the associated value. The currently selected list item is given the "selected" CSS class.

Author: Andy

Definition at line 48 of file option_checklist_field_renderer.inc.

Member Function Documentation

◆ OptionCheckListFieldRenderer()

OptionCheckListFieldRenderer::OptionCheckListFieldRenderer	(	&	$form,
			$field,
			$label,
			$options
	)

Definition at line 54 of file option_checklist_field_renderer.inc.

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

◆ renderField()

OptionCheckListFieldRenderer::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 111 of file option_checklist_field_renderer.inc.

      {
           $this->_startField($field);
                     
           $value = $this->parent->data->get($field);
           
           $values = explode(",", $value);
           $values = array_combine($values, $values);
           
           $id = "{$this->parent->id}_{$field}";
           
           echo "<input type='hidden' id='{$id}' name='{$field}' value='{$value}'/>";
           echo "<ul id='{$id}_list' class='{$this->cssClass}'>";
           foreach($this->options as $option => $description)
           {
                $selected = ($values[$option] == $option) ? " class='selected'" : "";
                echo "<li{$selected} data-value='{$option}' onclick='{$id}_update(this); return false;'>{$description}</li>\n";    
           }
           echo "</ul>";
           $this->_endField($field);
      }

◆ renderReadOnly()

OptionCheckListFieldRenderer::renderReadOnly ( $field )

Definition at line 133 of file option_checklist_field_renderer.inc.

      {
           $this->_startField($field);
           
           $text = array();
           $value = $this->parent->data->get($field);
           $values = explode(",", $value);
           
           foreach($values as $v)
           {
                $text[] = $this->options[$v]; 
           }
           
           echo implode($this->separator, $text);
           
           $this->_endField($field);
      }

◆ renderScript()

OptionCheckListFieldRenderer::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 70 of file option_checklist_field_renderer.inc.

      {
           if ($this->parent->readOnlyForm || $this->parent->isReadOnly($field)) return;
           $id = "{$this->parent->id}_{$field}";
           ?>
      <script type='text/javascript'>
      function <?echo $id?>_update(sel)
      {
           if (sel.hasClass("selected"))
           {
                sel.removeClass("selected");
           }
           else
           {
                sel.addClass("selected");
           }
           
           var values = [];
           
           $$('#<?echo $id?>_list > li').each(function(elt) 
           { 
                if (elt.hasClass('selected'))
                {
                     var v = elt.get('data-value');
                     values.push(v);
                }
           });
  
           var hidden = document.id('<?echo $id?>');
           var v = hidden.value;
           hidden.value = values.join(",");
           var f = document.id('<?echo $this->parent->id?>');
           if (v != hidden.value && f && f.manager)
           {
                f.manager.dirty();
           }
      }
      </script>
 <?
      }

Member Data Documentation

◆ $cssClass

OptionCheckListFieldRenderer::$cssClass = "options_list"

Definition at line 51 of file option_checklist_field_renderer.inc.

◆ $options

OptionCheckListFieldRenderer::$options = array()

Definition at line 50 of file option_checklist_field_renderer.inc.

◆ $separator

OptionCheckListFieldRenderer::$separator = ", "

Definition at line 52 of file option_checklist_field_renderer.inc.

The documentation for this class was generated from the following file:

C:/code/cms.sonjara.com/framework/field_renderers/option_checklist_field_renderer.inc

Public Member Functions

Public Attributes