Framework  3.9
SpreadsheetFormLayout Class Reference

Used for the overall layout handling of SpreadsheetAutoForm instance. More...

+ Inheritance diagram for SpreadsheetFormLayout:
+ Collaboration diagram for SpreadsheetFormLayout:

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="")
 
 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 overall layout handling of SpreadsheetAutoForm instance.

Definition at line 567 of file auto_form_layout.inc.

Constructor & Destructor Documentation

◆ __construct()

SpreadsheetFormLayout::__construct (   $form)

Reimplemented from AutoFormLayout.

Definition at line 569 of file auto_form_layout.inc.

570  {
571  parent::__construct($form);
572  }

Member Function Documentation

◆ endButtonLine()

SpreadsheetFormLayout::endButtonLine ( )

Reimplemented from AutoFormLayout.

Definition at line 628 of file auto_form_layout.inc.

629  {
630  echo "</td></tr>";
631  }

◆ endField()

SpreadsheetFormLayout::endField (   $field,
  $renderer 
)

Reimplemented from AutoFormLayout.

Definition at line 589 of file auto_form_layout.inc.

590  {
591  // nothing do to
592  }

◆ endGroup()

SpreadsheetFormLayout::endGroup ( )

Reimplemented from AutoFormLayout.

Definition at line 579 of file auto_form_layout.inc.

580  {
581  $this->endUngrouped();
582  }

◆ endUngrouped()

SpreadsheetFormLayout::endUngrouped ( )

Reimplemented from AutoFormLayout.

Definition at line 617 of file auto_form_layout.inc.

618  {
619  echo "</table>";
620  }

◆ errorBox()

SpreadsheetFormLayout::errorBox ( )

Reimplemented from AutoFormLayout.

Definition at line 633 of file auto_form_layout.inc.

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

◆ getLabel()

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

Reimplemented from AutoFormLayout.

Definition at line 604 of file auto_form_layout.inc.

605  {
606  return ""; // nothing to do
607  }

◆ printLabel()

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

Reimplemented from AutoFormLayout.

Definition at line 599 of file auto_form_layout.inc.

600  {
601  // nothing to do
602  }

◆ requiredFields()

SpreadsheetFormLayout::requiredFields (   $text)

Reimplemented from AutoFormLayout.

Definition at line 594 of file auto_form_layout.inc.

595  {
596  echo "<p><span class='required_text'>$text</span></p>";
597  }

◆ startButtonLine()

SpreadsheetFormLayout::startButtonLine ( )

Reimplemented from AutoFormLayout.

Definition at line 622 of file auto_form_layout.inc.

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

◆ startField()

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

Reimplemented from AutoFormLayout.

Definition at line 584 of file auto_form_layout.inc.

585  {
586  // nothing do to
587  }

◆ startGroup()

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

Reimplemented from AutoFormLayout.

Definition at line 574 of file auto_form_layout.inc.

575  {
576  $this->startUngrouped();
577  }

◆ startUngrouped()

SpreadsheetFormLayout::startUngrouped ( )

Reimplemented from AutoFormLayout.

Definition at line 609 of file auto_form_layout.inc.

610  {
611  echo "<table ";
612  if ($this->form->formCSS) echo " class='{$this->form->formCSS}'";
613  if ($this->form->style) echo " style='{$this->form->style}'";
614  echo ">\n";
615  }

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