SimpleFormLayout Class Reference

SimpleFormLayout provides a form with minimal HTML, and does not employ table-based layout. More...

Inheritance diagram for SimpleFormLayout:

Collaboration diagram for SimpleFormLayout:

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

SimpleFormLayout provides a form with minimal HTML, and does not employ table-based layout.

Definition at line 782 of file auto_form_layout.inc.

Constructor & Destructor Documentation

__construct()

SimpleFormLayout::__construct

(

$form

)

Reimplemented from AutoFormLayout.

Definition at line 784 of file auto_form_layout.inc.

     {
          parent::__construct($form);
     }

Member Function Documentation

endButtonLine()

SimpleFormLayout::endButtonLine

(

)

Reimplemented from AutoFormLayout.

Definition at line 901 of file auto_form_layout.inc.

     {
          echo "</div><br/>";
     }

endField()

SimpleFormLayout::endField	(		$field,
			$renderer
	)

Reimplemented from AutoFormLayout.

Definition at line 837 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 "<br/>\n";
     }

endGroup()

SimpleFormLayout::endGroup

(

)

Reimplemented from AutoFormLayout.

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

SimpleFormLayout::endUngrouped

(

)

Reimplemented from AutoFormLayout.

Definition at line 890 of file auto_form_layout.inc.

     {
          echo "</div>";
     }

errorBox()

SimpleFormLayout::errorBox

(

)

Reimplemented from AutoFormLayout.

Definition at line 906 of file auto_form_layout.inc.

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

printLabel()

SimpleFormLayout::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 863 of file auto_form_layout.inc.

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

requiredFields()

SimpleFormLayout::requiredFields

(

$text

)

Reimplemented from AutoFormLayout.

Definition at line 911 of file auto_form_layout.inc.

     {
          echo "<p class='required_text'>{$text}</p>\n";
     }

startButtonLine()

SimpleFormLayout::startButtonLine

(

)

Reimplemented from AutoFormLayout.

Definition at line 895 of file auto_form_layout.inc.

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

startField()

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

Reimplemented from AutoFormLayout.

Definition at line 823 of file auto_form_layout.inc.

     {    
          echo "<br/>\n";
          
          $this->printLabel($field, $renderer, $styles, $this->parent->annotations[$field]);
          
          if ($renderer->parent->showAnnotations && $renderer->annotateBefore && $renderer->parent->annotations[$field])
          {
               echo $renderer->parent->annotations[$field]." ";
          }
 
          if ($colspan == 2) echo "<br/>\n";
     }

startGroup()

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

Reimplemented from AutoFormLayout.

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

SimpleFormLayout::startUngrouped

(

)

Reimplemented from AutoFormLayout.

Definition at line 882 of file auto_form_layout.inc.

     {
          echo "<div";
          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