TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface:

Public Member Functions
CompositeRenderableInterface null	getParentRenderable ()
	setParentRenderable (CompositeRenderableInterface $renderable)
	setIndex (int $index)
int	getIndex ()
	onRemoveFromParentRenderable ()
	registerInFormIfPossible ()
string	getTemplateName ()
bool	isEnabled ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface
string	getType ()
string	getIdentifier ()
string	getLabel ()
string	getRendererClassName ()
array	getRenderingOptions ()

Detailed Description

Base interface which all Form Parts except the FormDefinition must adhere to (i.e. all elements which are NOT the root of a Form).

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

Definition at line 31 of file RenderableInterface.php.

Member Function Documentation

getIndex()

int TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface::getIndex

(

)

Get the index inside the parent renderable

Returns

‪int

Implemented in TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable.

getParentRenderable()

CompositeRenderableInterface null TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface::getParentRenderable

(

)

Return the parent renderable

Returns

‪CompositeRenderableInterface|null the parent renderable

Implemented in TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable.

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable\addRenderable(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable\getRootForm(), TYPO3\CMS\Form\ViewHelpers\RenderFormValueViewHelper\isEnabled(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable\moveRenderableAfter(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable\moveRenderableBefore(), and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable\removeRenderable().

getTemplateName()

string TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface::getTemplateName

(

)

Get the template name of the renderable

Returns

‪string

Implemented in TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable, and TYPO3\CMS\Form\Domain\Model\FormElements\UnknownFormElement.

isEnabled()

bool TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface::isEnabled

(

)

Returns whether this renderable is enabled

Returns

‪bool

Implemented in TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable.

Referenced by TYPO3\CMS\Form\ViewHelpers\RenderFormValueViewHelper\isEnabled(), and TYPO3\CMS\Form\ViewHelpers\RenderRenderableViewHelper\renderStatic().

onRemoveFromParentRenderable()

TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface::onRemoveFromParentRenderable

(

)

This function is called after a renderable has been removed from its parent renderable. The function should make sure to clean up the internal state, like resetting $this->parentRenderable or deregistering the renderable of the form.

Implemented in TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable, and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable.

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable\removeRenderable().

registerInFormIfPossible()

TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface::registerInFormIfPossible

(

)

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

Implemented in TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable, and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable.

setIndex()

TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface::setIndex

(

int

$index

)

Set the index of this renderable inside the parent renderable

Parameters

int

$index

Implemented in TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable.

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable\addRenderable(), TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable\moveRenderableAfter(), and TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable\moveRenderableBefore().

setParentRenderable()

TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface::setParentRenderable

(

CompositeRenderableInterface

$renderable

)

Set the new parent renderable. You should not call this directly; it is automatically called by addRenderable.

This method should also register itself at the parent form, if possible.

Parameters

CompositeRenderableInterface

$renderable

Implemented in TYPO3\CMS\Form\Domain\Model\Renderable\AbstractRenderable, and TYPO3\CMS\Form\Domain\Model\FormElements\Page.

Referenced by TYPO3\CMS\Form\Domain\Model\Renderable\AbstractCompositeRenderable\addRenderable().