TableHeaderFormLayout Class Reference

Used for the header row in SpreadSheetAutoForm. More...

Inheritance diagram for TableHeaderFormLayout:

Collaboration diagram for TableHeaderFormLayout:

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

Additional Inherited Members
Static Public Member Functions inherited from AutoFormLayout
static	create ($type, $form)
Public Attributes inherited from AutoFormLayout
	$form
	$externalErrorBox = false
	Flag indicating whether the error box should be rendered inside the form grouping. More...

Detailed Description

Used for the header row in SpreadSheetAutoForm.

Definition at line 318 of file auto_form_layout.inc.

Constructor & Destructor Documentation

__construct()

TableHeaderFormLayout::__construct

(

$form

)

Reimplemented from AutoFormLayout.

Reimplemented in SelectableTableHeaderFormLayout.

Definition at line 320 of file auto_form_layout.inc.

     {
          parent::__construct($form);
     }

Member Function Documentation

endButtonLine()

TableHeaderFormLayout::endButtonLine

(

)

Reimplemented from AutoFormLayout.

Definition at line 419 of file auto_form_layout.inc.

     {
          // nothing to do
     }

endField()

TableHeaderFormLayout::endField	(		$field,
			$renderer
	)

Reimplemented from AutoFormLayout.

Definition at line 348 of file auto_form_layout.inc.

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

endGroup()

TableHeaderFormLayout::endGroup

(

)

Reimplemented from AutoFormLayout.

Definition at line 330 of file auto_form_layout.inc.

     {
          $this->endUngrouped();
     }

endUngrouped()

TableHeaderFormLayout::endUngrouped

(

)

Reimplemented from AutoFormLayout.

Definition at line 409 of file auto_form_layout.inc.

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

errorBox()

TableHeaderFormLayout::errorBox

(

)

Reimplemented from AutoFormLayout.

Definition at line 424 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()

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

Reimplemented from AutoFormLayout.

Definition at line 382 of file auto_form_layout.inc.

     {
          $obj = $renderer->parent->getData();
           $label = isset($renderer->label) ? $renderer->label : $renderer->parent->prettifyFieldName($field);
 
          if ($renderer->parent->markRequiredFields &&
                    $renderer->parent->isRequired($field))
          {
          $label .= "*";
          }
 
          $label .= $renderer->labelSuffix;
 
          if ($renderer->parent->onFormatLabel)
          {
          $fn = $renderer->parent->onFormatLabel;
          $label = $fn($renderer->parent, $field, $label);
          }
       
          return $label;
     }

printLabel()

TableHeaderFormLayout::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 366 of file auto_form_layout.inc.

     {
          //if ($renderer->hideLabel && $renderer->colspan > 1 && !$annotation) return;
 
          $label = $this->getLabel($field, $renderer);
 
          echo "<th ";
          if ($renderer->parent->labelCSS) echo " class='{$renderer->parent->labelCSS}'";
          if ($styles) echo " style='$styles'";
          echo ">";
 
          echo "<label id='".$this->getLabelID($field)."' for='$field'>$label</label> ";
 
          echo "$annotation</th>\n";
     }

requiredFields()

TableHeaderFormLayout::requiredFields

(

$text

)

Reimplemented from AutoFormLayout.

Definition at line 353 of file auto_form_layout.inc.

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

startButtonLine()

TableHeaderFormLayout::startButtonLine

(

)

Reimplemented from AutoFormLayout.

Definition at line 414 of file auto_form_layout.inc.

     {
          // nothing to do
     }

startField()

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

Reimplemented from AutoFormLayout.

Definition at line 336 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()

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

Reimplemented from AutoFormLayout.

Definition at line 325 of file auto_form_layout.inc.

     {
          $this->startUngrouped();
     }

startUngrouped()

TableHeaderFormLayout::startUngrouped

(

)

Reimplemented from AutoFormLayout.

Reimplemented in SelectableTableHeaderFormLayout.

Definition at line 404 of file auto_form_layout.inc.

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

---

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

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