ColorFieldRenderer Class Reference

Field renderer for boolean data fields. More...

Inheritance diagram for ColorFieldRenderer:

Collaboration diagram for ColorFieldRenderer:

Public Member Functions
	__construct (&$parent, $field=null, $label=null)
	Create a new BooleanFieldRenderer. 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...
	renderSearchField ($field, $mode="match")
	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...
	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...
	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
	$disable = false
	$onChange = null
	, alternative to readonly; field can be reenabled thru javascript More...
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 boolean data fields.

Renders as a checkbox.

Definition at line 43 of file color_field_renderer.inc.

Constructor & Destructor Documentation

__construct()

ColorFieldRenderer::__construct	(	&	$parent,
			$field = null,
			$label = null
	)

Create a new BooleanFieldRenderer.

Parameters

AutoForm

$parent

the parent form

Definition at line 52 of file color_field_renderer.inc.

     {
          $this->FieldRenderer($parent);
          if ($field && !$parent->data->hasField($field))
          {
               $parent->add($this, $field, $label);
          }
     }    

Member Function Documentation

renderField()

ColorFieldRenderer::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 83 of file color_field_renderer.inc.

     {
          $this->_startField($field);
          
          $val = $this->parent->data->get($field);
          
          $f = "{$this->parent->id}_{$field}";
          $disable = ($this->disable) ? "disabled='disabled'" : "";
          
          echo "<input id='{$f}' class='color' type='text' size='7' value='{$val}' name='$field' {$disable} onkeyup='return {$f}_onChange(this);'>&nbsp;";
          echo "<input id='{$f}_color' type='color' value='{$val}' name='{$field}' {$disable} onchange='return {$f}_color_onChange(this);'>";
          
          $this->_endField($field);
     }

renderReadOnly()

ColorFieldRenderer::renderReadOnly

(

$field

)

Definition at line 111 of file color_field_renderer.inc.

     {
          $this->_startField($field);
          
          $val = $this->parent->data->get($field);
          
          echo "<input id='{$this->parent->id}_{$field}' type='color' value='{$val}' name='$field' readonly='readonly'>";
          
          $this->_endField($field);
     }

renderScript()

ColorFieldRenderer::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 61 of file color_field_renderer.inc.

     {
          $f = "{$this->parent->id}_{$field}";
          $onChange = ($this->onChange) ? " {$this->onChange}(elt);" : ";";
          
          echo <<<ENDSCRIPT
     <script type='text/javascript'>
     function {$f}_onChange(elt)
     {
          document.id('{$f}_color').value = elt.value;
          return{$onChange}
     }
          
     function {$f}_color_onChange(elt)
     {
          document.id('{$f}').value = elt.value;
          return{$onChange}
     }
     </script>
ENDSCRIPT;
     }

renderSearchField()

ColorFieldRenderer::renderSearchField	(		$field,
			$mode = "match"
	)

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 98 of file color_field_renderer.inc.

     {
          $this->_startField($field);
          
          $val = $this->parent->data->get($field);
          
          $disable = ($this->disable) ? "disabled='disabled'" : "";
          $onChange = ($this->onChange) ? " onchange='return {$this->onChange}(this);'" : "";
          echo "<input id='{$this->parent->id}_{$field}' type='color' value='{$val}' name='$field:$mode' {$disable}{$onChange}>";
          
          $this->_endField($field);
     }

Member Data Documentation

$disable

ColorFieldRenderer::$disable = false

Definition at line 45 of file color_field_renderer.inc.

$onChange

ColorFieldRenderer::$onChange = null

, alternative to readonly; field can be reenabled thru javascript

Name of Javascript function to be called when checkbox is toggled

Definition at line 46 of file color_field_renderer.inc.

---

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

• C:/code/cms.sonjara.com/framework/field_renderers/color_field_renderer.inc