TableBasedFormLayout Class Reference

Lays out the AutoForm using table-based layout. More...

Inheritance diagram for TableBasedFormLayout:

Collaboration diagram for TableBasedFormLayout:

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

Lays out the AutoForm using table-based layout.

Definition at line 129 of file auto_form_layout.inc.

Constructor & Destructor Documentation

__construct()

TableBasedFormLayout::__construct

(

$form

)

Reimplemented from AutoFormLayout.

Reimplemented in UngroupedFormLayout.

Definition at line 131 of file auto_form_layout.inc.

     {
          parent::__construct($form);
     }

Member Function Documentation

endButtonLine()

TableBasedFormLayout::endButtonLine

(

)

Reimplemented from AutoFormLayout.

Definition at line 256 of file auto_form_layout.inc.

     {
          echo "</td></tr>";
     }

endField()

TableBasedFormLayout::endField	(		$field,
			$renderer
	)

Reimplemented from AutoFormLayout.

Definition at line 194 of file auto_form_layout.inc.

     {
          if ($renderer->parent->showAnnotations && !$renderer->annotateBefore && $renderer->parent->annotations[$field])
          {
               if ($renderer->annotateNextLine)
               {
                    echo "<br/>"; 
               }
               else 
               {
                    echo "&nbsp;&nbsp;";
               }
               echo $renderer->parent->annotations[$field];
          }
          
          echo "</td>\n</tr>\n";
     }

endGroup()

TableBasedFormLayout::endGroup

(

)

Reimplemented from AutoFormLayout.

Reimplemented in UngroupedFormLayout.

Definition at line 153 of file auto_form_layout.inc.

     {
          $this->endUngrouped();
          
          $name = $this->groupName;
          
          $desc = $this->form->getGroupDescription($name, "end");
          if ($desc)
          {
               $id = $this->form->id . "_" . codify($name) . "_group";
               echo "<div id='{$id}_description' class='{$this->form->groupDescriptionCSS}'>{$desc}</div>";
          }
     
          unset($this->groupName);
          
          echo "</fieldset>";
     }

endUngrouped()

TableBasedFormLayout::endUngrouped

(

)

Reimplemented from AutoFormLayout.

Definition at line 245 of file auto_form_layout.inc.

     {
          echo "</table>";
     }

errorBox()

TableBasedFormLayout::errorBox

(

)

Reimplemented from AutoFormLayout.

Definition at line 261 of file auto_form_layout.inc.

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

printLabel()

TableBasedFormLayout::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 220 of file auto_form_layout.inc.

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

requiredFields()

TableBasedFormLayout::requiredFields

(

$text

)

Reimplemented from AutoFormLayout.

Definition at line 266 of file auto_form_layout.inc.

     {
          echo "<tr>\n <td colspan='2'><span class='required_text'>{$text}</span></td></tr>\n";
     }

startButtonLine()

TableBasedFormLayout::startButtonLine

(

)

Reimplemented from AutoFormLayout.

Definition at line 250 of file auto_form_layout.inc.

     {
          echo "<tr>\n";
          echo " <td colspan='2' class='{$this->form->buttonLineCSS}' style='text-align: {$this->form->buttonAlignment}'><br/>";  
     }

startField()

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

Reimplemented from AutoFormLayout.

Definition at line 171 of file auto_form_layout.inc.

     {
          if ($renderer->colspan > 1) $styles = "text-align: left;$styles";
          
          echo "<tr class='{$renderer->parent->id}_{$field}_field'>\n";
          
          $this->printLabel($field, $renderer, $styles, ($renderer->annotateBefore && $renderer->colspan > 1) ? "<br/>".$renderer->parent->annotations[$field] : "");
          
          if ($renderer->colspan > 1)
          {
               echo "</tr>\n";
               echo "<tr class='{$renderer->parent->id}_{$field}_field'>\n";
          }
          echo "<td colspan='{$renderer->colspan}'";
          if ($renderer->parent->valueCSS) echo " class='{$renderer->parent->valueCSS}'";
          echo ">";
          
          if ($renderer->parent->showAnnotations && $renderer->annotateBefore && $renderer->parent->annotations[$field] && $renderer->colspan == 1)
          {
               echo $renderer->parent->annotations[$field]."<br/>";
          }
     }

startGroup()

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

Reimplemented from AutoFormLayout.

Reimplemented in UngroupedFormLayout.

Definition at line 136 of file auto_form_layout.inc.

     {
          $class = $this->getGroupClass($name, $collapsible, $collapsed);
          
          $id = $this->form->id . "_" . codify($name) . "_group";
          
          echo "<fieldset id='$id'$class><legend>$name</legend>";
          
          $desc = $this->form->getGroupDescription($name, "start");
          if ($desc)
          {
               echo "<div id='{$id}_description' class='{$this->form->groupDescriptionCSS}'>{$desc}</div>";
          }
          $this->groupName = $name;
          $this->startUngrouped();
     }

startUngrouped()

TableBasedFormLayout::startUngrouped

(

)

Reimplemented from AutoFormLayout.

Definition at line 237 of file auto_form_layout.inc.

     {
          echo "<table";
          if ($this->form->formCSS) echo " class='{$this->form->formCSS}'";
          if ($this->form->style) echo " style='{$this->form->style}'";
          echo ">\n";
     }

---

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

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