DataListFieldRenderer Class Reference

Add a DataListView table to an AutoForm. More...

Inheritance diagram for DataListFieldRenderer:

Collaboration diagram for DataListFieldRenderer:

Public Member Functions
	DataListFieldRenderer (&$parent, $table, $field="", $label="")
	renderScript ($field)
	FieldRenderers can override this method to provide any Javascript that their control requires for an edit 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...
	renderField ($field)
	FieldRenderers must override this method to provide the HTML implementation of the control used to edit the field. 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...
	renderReadOnly ()
	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 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...

Public Attributes
	$field
	$label
	$table
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

Add a DataListView table to an AutoForm.

syntax:

$personSelect = new DataListFieldRenderer($form, $table);

where table is an object of class DataListView.

The $field is taken from the table id set when the obj is instantiated.

Author

Janice Gallant for Sonjara, Inc.

7/22/2011

Definition at line 57 of file data_list_field_renderer.inc.

Member Function Documentation

DataListFieldRenderer()

DataListFieldRenderer::DataListFieldRenderer	(	&	$parent,
			$table,
			$field = "",
			$label = ""
	)

Definition at line 63 of file data_list_field_renderer.inc.

     {
          $this->FieldRenderer($parent);
 
          $this->field = ($field) ? $field : $table->id;
          $this->label = ($label) ? $label : prettify($this->field);
                    
          $this->table = $table;
          if ($parent->data->hasField($this->field))
          {
               $parent->override($this->field, $this->label, $this);
          }
          else
          {
               $parent->add($this, $this->field); 
               $parent->overrides[$this->field]['label'] = $this->label;
          }
          $this->colspan = 2;
     }

postProcess()

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

For example, the CrossReferenceSelectFieldRenderer overrides this method to update crossference tables based on the user's selection.

Parameters

string

$field

Reimplemented from FieldRenderer.

Definition at line 117 of file data_list_field_renderer.inc.

     {
          if ($this->onPostProcess != null)
          {
               $callback = $this->onPostProcess;
               call_user_func($callback, $this, $field);
          }
     }    

preProcess()

DataListFieldRenderer::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 102 of file data_list_field_renderer.inc.

     {
          if ($this->onPreProcess != null)
          {
               $callback = $this->onPreProcess;             
               call_user_func($callback, $this, $field);
          }
     }

renderField()

DataListFieldRenderer::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 93 of file data_list_field_renderer.inc.

     {
          if (!$field) $field = $this->field;
          
          $this->_startField($field);
          $this->table->drawView();
          $this->_endField($field);
     }

renderReadOnly()

DataListFieldRenderer::renderReadOnly

(

)

Definition at line 111 of file data_list_field_renderer.inc.

     {
          $this->table->selectable = false;
          $this->renderField();
     }

renderScript()

DataListFieldRenderer::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 83 of file data_list_field_renderer.inc.

     {
          return $this->table->writeScript();
     }

renderSearchField()

DataListFieldRenderer::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 88 of file data_list_field_renderer.inc.

     {
          $this->renderField();
     }

Member Data Documentation

$field

DataListFieldRenderer::$field

Definition at line 59 of file data_list_field_renderer.inc.

$label

DataListFieldRenderer::$label

Definition at line 60 of file data_list_field_renderer.inc.

$table

DataListFieldRenderer::$table

Definition at line 61 of file data_list_field_renderer.inc.

---

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

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