‪TYPO3CMS  9.5
TYPO3\CMS\Form\Domain\Model\FormElements\GridContainer Class Reference
Inheritance diagram for TYPO3\CMS\Form\Domain\Model\FormElements\GridContainer:
TYPO3\CMS\Form\Domain\Model\FormElements\Section TYPO3\CMS\Form\Domain\Model\FormElements\GridContainerInterface TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable TYPO3\CMS\Form\Domain\Model\Renderable\CompositeRenderableInterface TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface TYPO3\CMS\Form\Domain\Model\Renderable\VariableRenderableInterface TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface

Public Member Functions

 initializeFormElement ()
 
 registerInFormIfPossible ()
 
 addElement (FormElementInterface $formElement)
 
FormElementInterface createElement (string $identifier, string $typeName)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Model\FormElements\Section
string getUniqueIdentifier ()
 
mixed getDefaultValue ()
 
 setDefaultValue ($defaultValue)
 
array getProperties ()
 
 setProperty (string $key, $value)
 
bool isRequired ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection
 __construct (string $identifier, string $type)
 
FormElementInterface[] getElements ()
 
FormElementInterface[] getElementsRecursively ()
 
 moveElementBefore (FormElementInterface $elementToMove, FormElementInterface $referenceElement)
 
 moveElementAfter (FormElementInterface $elementToMove, FormElementInterface $referenceElement)
 
 removeElement (FormElementInterface $elementToRemove)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable
RenderableInterface[] getRenderablesRecursively ()
 
 onRemoveFromParentRenderable ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable
string getType ()
 
string getIdentifier ()
 
 setIdentifier (string $identifier)
 
 setOptions (array $options, bool $resetValidators=false)
 
mixed createValidator (string $validatorIdentifier, array $options=[])
 
 addValidator (ValidatorInterface $validator)
 
SplObjectStorage getValidators ()
 
 setDataType (string $dataType)
 
string getRendererClassName ()
 
array getRenderingOptions ()
 
mixed setRenderingOption (string $key, $value)
 
CompositeRenderableInterface null getParentRenderable ()
 
 setParentRenderable (CompositeRenderableInterface $parentRenderable)
 
FormDefinition getRootForm ()
 
int getIndex ()
 
 setIndex (int $index)
 
string getLabel ()
 
 setLabel (string $label)
 
string getTemplateName ()
 
bool isEnabled ()
 
RenderableVariantInterface[] getVariants ()
 
RenderableVariantInterface createVariant (array $options)
 
 addVariant (RenderableVariantInterface $variant)
 
 applyVariant (RenderableVariantInterface $variant)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface
 setRenderingOption (string $key, $value)
 
SplObjectStorage< ValidatorInterfacegetValidators ()
 
 addValidator (ValidatorInterface $validator)
 
 setDataType (string $dataType)
 

Additional Inherited Members

- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable
 addRenderable (RenderableInterface $renderable)
 
 moveRenderableBefore (RenderableInterface $renderableToMove, RenderableInterface $referenceRenderable)
 
 moveRenderableAfter (RenderableInterface $renderableToMove, RenderableInterface $referenceRenderable)
 
 removeRenderable (RenderableInterface $renderableToRemove)
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Form\Domain\Model\FormElements\Section
array $properties = array( )
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable
TYPO3 CMS Form Domain Model Renderable RenderableInterface[] $renderables = array( )
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable
string $type
 
string $identifier
 
CompositeRenderableInterface $parentRenderable
 
string $label = ''
 
array $renderingOptions = array( )
 
int $index = 0
 
string $templateName = ''
 
array $variants = array( )
 

Detailed Description

A GridContainer, being part of a bigger Page

This class contains multiple GridRow elements.

Scope: frontend This class is NOT meant to be sub classed by developers.

Definition at line 28 of file GridContainer.php.

Member Function Documentation

◆ addElement()

TYPO3\CMS\Form\Domain\Model\FormElements\GridContainer::addElement ( FormElementInterface  $formElement)

◆ createElement()

FormElementInterface TYPO3\CMS\Form\Domain\Model\FormElements\GridContainer::createElement ( string  $identifier,
string  $typeName 
)

Create a form element with the given $identifier and attach it to this container.

Parameters
string$identifier‪Identifier of the new form element
string$typeName‪type of the new form element
Returns
FormElementInterface the newly created grid row
Exceptions
TypeDefinitionNotValidException

Reimplemented from TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection.

Definition at line 87 of file GridContainer.php.

References TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\$identifier.

◆ initializeFormElement()

TYPO3\CMS\Form\Domain\Model\FormElements\GridContainer::initializeFormElement ( )

Initializes the Form Element

Reimplemented from TYPO3\CMS\Form\Domain\Model\FormElements\Section.

Definition at line 35 of file GridContainer.php.

◆ registerInFormIfPossible()

TYPO3\CMS\Form\Domain\Model\FormElements\GridContainer::registerInFormIfPossible ( )

Register this element at the parent form, if there is a connection to the parent form.

Exceptions
TypeDefinitionNotValidException

Reimplemented from TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable.

Definition at line 50 of file GridContainer.php.

References TYPO3\CMS\Form\Domain\Model\FormElements\AbstractSection\getElementsRecursively().