Inheritance diagram for SliderFieldRenderer:

Collaboration diagram for SliderFieldRenderer:

Public Member Functions
	__construct (&$form, $field, $min=0, $max=10, $editable=true)

	setThresholds ($thresholds)

	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
	$min = 0

	$max = 10

	$editable = true

	$thresholds = null

	$displayValue = true

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

Definition at line 40 of file slider_field_renderer.inc.

Constructor & Destructor Documentation

◆ __construct()

SliderFieldRenderer::__construct	(	&	$form,
			$field,
			$min = `0`,
			$max = `10`,
			$editable = `true`
	)

Definition at line 48 of file slider_field_renderer.inc.

      {
           $this->min = $min;
           $this->max = $max;
           $this->editable = $editable;
           $this->FieldRenderer($form);
           
           if ($field && !$form->data->hasField($field))
           {
                $form->add($this, $field);
           }
           else
           {
                $form->override($field, $label, $this);
           }
      }

Member Function Documentation

◆ renderField()

SliderFieldRenderer::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 slider_field_renderer.inc.

      {
           $this->_startField($field);
           $value = $this->parent->data->get($field);
           if (!$value) $value = $this->min;
           
           echo "<input type='range' id='{$this->parent->id}_{$field}' name='{$field}' min='{$this->min}' max='{$this->max}' value='{$value}' data-displayField='{$this->parent->id}_{$field}_display'/>";
           
           if ($this->displayValue)
           {
                $threshold = ($this->thresholds) ? $this->thresholds[$value] : "";
                echo "<span class='range_display' id='{$this->parent->id}_{$field}_display'>{$threshold}</span>";
           }
           
           $this->_endField($field);
      }

◆ renderReadOnly()

SliderFieldRenderer::renderReadOnly ( $field )

Definition at line 136 of file slider_field_renderer.inc.

137 {

138 }

◆ renderScript()

SliderFieldRenderer::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 slider_field_renderer.inc.

      {
           if (isset($this->thresholds))
           {
                krsort($this->thresholds, SORT_NUMERIC);
                $thresholds = json_encode($this->thresholds);
           }
           else
           {
                $thresholds = "null";
           }
           
           $id = "{$this->parent->id}_{$field}";
                
           $script = <<<ENDSCRIPT
 <script type='text/javascript'>
 var {$id}_thresholds = {$thresholds};
 window.addEvent('domready', function()
 {
      var range = document.id('{$id}');
      var display = document.id('{$id}_display');
  
      if (display != null)
      {
           range.addEvent('input', function(elt)
           {
                if ({$id}_thresholds != null)
                {
                     for(var score in {$id}_thresholds)
                     {
                          if (range.value == score)
                          {
                               display.set('html', ${id}_thresholds[score]);
                          }
                     }
                }
                else
                {
                     display.set('text', range.value);
                }
           });
      }
 });
 </script>
 ENDSCRIPT;
           
           echo $script;
      }

◆ setThresholds()

SliderFieldRenderer::setThresholds ( $thresholds )

Definition at line 65 of file slider_field_renderer.inc.

      {
           $this->thresholds = $thresholds;
      }

Member Data Documentation

◆ $displayValue

SliderFieldRenderer::$displayValue = true

Definition at line 46 of file slider_field_renderer.inc.

◆ $editable

SliderFieldRenderer::$editable = true

Definition at line 44 of file slider_field_renderer.inc.

◆ $max

SliderFieldRenderer::$max = 10

Definition at line 43 of file slider_field_renderer.inc.

◆ $min

SliderFieldRenderer::$min = 0

Definition at line 42 of file slider_field_renderer.inc.

◆ $thresholds

SliderFieldRenderer::$thresholds = null

Definition at line 45 of file slider_field_renderer.inc.

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

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

Public Member Functions

Public Attributes