TableRowFormLayout Class Reference

Used for each subordinate form row in SpreadSheetAutoForm. More...

Inheritance diagram for TableRowFormLayout:

Collaboration diagram for TableRowFormLayout:

Public Member Functions
	__construct ($form)
	startGroup ($name, $collapsible=false, $collapsed=false)
	endGroup ()
	startField ($field, $renderer, $colspan=1, $styles="")
	endField ($field, $renderer)
	requiredFields ($text)
	printLabel ($field, $renderer, $styles="", $annotation="")
	Internal method to generate the HTML for the field label. More...
	getLabel ($field, $renderer, $addSuffix=true)
	startUngrouped ()
	endUngrouped ()
	startButtonLine ()
	endButtonLine ()
	errorBox ()
Public Member Functions inherited from AutoFormLayout
	getGroupClass ($name, $collapsible, $collapsed, $additionalClass="")
	getLabelID ($field)
	finalizeLayout ()

Public Attributes
	$externalErrorBox = true
Public Attributes inherited from AutoFormLayout
	$form
	$externalErrorBox = false
	Flag indicating whether the error box should be rendered inside the form grouping. More...

Additional Inherited Members
Static Public Member Functions inherited from AutoFormLayout
static	create ($type, $form)

Detailed Description

Used for each subordinate form row in SpreadSheetAutoForm.

Definition at line 456 of file auto_form_layout.inc.

Constructor & Destructor Documentation

__construct()

TableRowFormLayout::__construct

(

$form

)

Reimplemented from AutoFormLayout.

Reimplemented in SelectableTableRowFormLayout.

Definition at line 460 of file auto_form_layout.inc.

     {
          parent::__construct($form);
     }

Member Function Documentation

endButtonLine()

TableRowFormLayout::endButtonLine

(

)

Reimplemented from AutoFormLayout.

Definition at line 531 of file auto_form_layout.inc.

     {
          // nothing to do
     }

endField()

TableRowFormLayout::endField	(		$field,
			$renderer
	)

Reimplemented from AutoFormLayout.

Definition at line 488 of file auto_form_layout.inc.

     {
          echo "</td>\n";
     }

endGroup()

TableRowFormLayout::endGroup

(

)

Reimplemented from AutoFormLayout.

Definition at line 470 of file auto_form_layout.inc.

     {
          $this->endUngrouped();
     }

endUngrouped()

TableRowFormLayout::endUngrouped

(

)

Reimplemented from AutoFormLayout.

Definition at line 521 of file auto_form_layout.inc.

     {         
          echo "</tr>\n";
     }

errorBox()

TableRowFormLayout::errorBox

(

)

Reimplemented from AutoFormLayout.

Definition at line 536 of file auto_form_layout.inc.

     {
          echo "<tr>\n <td colspan='{$this->form->parent->colCount}' id='{$this->form->id}__error' class='error' style='display: ".($this->form->msg ? 'table-cell' : 'none')."'>{$this->form->msg}</td></tr>\n";
     }    

getLabel()

TableRowFormLayout::getLabel	(		$field,
			$renderer,
			$addSuffix = true
	)

Reimplemented from AutoFormLayout.

Definition at line 511 of file auto_form_layout.inc.

     {
          return "";
     }

printLabel()

TableRowFormLayout::printLabel	(		$field,
			$renderer,
			$styles = "",
			$annotation = ""
	)

Internal method to generate the HTML for the field label.

Parameters

string	$field	the field name
int	$colspan	the number of columns to span
string	$styles	optional special styles that need to be applied
string	$annotation	annotation text for the field

Reimplemented from AutoFormLayout.

Definition at line 506 of file auto_form_layout.inc.

     {         
          // Nothing to do
     }

requiredFields()

TableRowFormLayout::requiredFields

(

$text

)

Reimplemented from AutoFormLayout.

Definition at line 493 of file auto_form_layout.inc.

     {
          // empty - want displayed once at top not for every form in the spreadsheet
     }    

startButtonLine()

TableRowFormLayout::startButtonLine

(

)

Reimplemented from AutoFormLayout.

Definition at line 526 of file auto_form_layout.inc.

     {
          // nothing to do
     }

startField()

TableRowFormLayout::startField	(		$field,
			$renderer,
			$colspan = 1,
			$styles = ""
	)

Reimplemented from AutoFormLayout.

Definition at line 476 of file auto_form_layout.inc.

     {
          echo "<td ";
          if ($renderer->parent->valueCSS) echo " class='{$renderer->parent->valueCSS}'";
          echo ">";
          
          if ($renderer->annotateBefore && $renderer->parent->annotations[$field] && $renderer->colspan == 1)
          {
               echo $renderer->parent->annotations[$field]."<br/>";
          }         
     }

startGroup()

TableRowFormLayout::startGroup	(		$name,
			$collapsible = false,
			$collapsed = false
	)

Reimplemented from AutoFormLayout.

Definition at line 465 of file auto_form_layout.inc.

     {
          $this->startUngrouped();
     }

startUngrouped()

TableRowFormLayout::startUngrouped

(

)

Reimplemented from AutoFormLayout.

Reimplemented in SelectableTableRowFormLayout.

Definition at line 516 of file auto_form_layout.inc.

     {
          echo "<tr id='{$this->form->id}_container' class='{$this->form->containerClass}'>\n";
     }

Member Data Documentation

$externalErrorBox

TableRowFormLayout::$externalErrorBox = true

Definition at line 458 of file auto_form_layout.inc.

---

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

• C:/code/cms.sonjara.com/framework/auto_form_layout.inc