TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
RenderableInterface Interface Reference
Inheritance diagram for RenderableInterface:
RootRenderableInterface FormElementInterface AbstractRenderable CompositeRenderableInterface AbstractFormElement Section UnknownFormElement AbstractFormElement UnknownFormElement AbstractCompositeRenderable AbstractCompositeRenderable AdvancedPassword DatePicker FileUpload GenericFormElement AdvancedPassword DatePicker FileUpload GenericFormElement FormDefinition AbstractSection FormDefinition AbstractSection

Public Member Functions

 getParentRenderable ()
 
 setParentRenderable (CompositeRenderableInterface $renderable)
 
 setIndex (int $index)
 
 getIndex ()
 
 onRemoveFromParentRenderable ()
 
 onBuildingFinished ()
 
 registerInFormIfPossible ()
 
- Public Member Functions inherited from RootRenderableInterface
 getType ()
 
 getIdentifier ()
 
 getLabel ()
 
 beforeRendering (FormRuntime $formRuntime)
 
 getRendererClassName ()
 
 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 25 of file RenderableInterface.php.

Member Function Documentation

getIndex ( )

Get the index inside the parent renderable

Returns
int

Implemented in AbstractRenderable.

getParentRenderable ( )
onBuildingFinished ( )

This is a callback that is invoked by the Form Factory after the whole form has been built. It can be used to add new form elements as children for complex form elements.

Returns
void

Implemented in AbstractRenderable.

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 reseting $this->parentRenderable or deregistering the renderable at the form.

Returns
void

Implemented in AbstractRenderable, and AbstractCompositeRenderable.

Referenced by AbstractCompositeRenderable\removeRenderable().

registerInFormIfPossible ( )

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

Returns
void

Implemented in AbstractRenderable, and AbstractCompositeRenderable.

setIndex ( int  $index)

Set the index of this renderable inside the parent renderable

Parameters
int$index
Returns
void

Implemented in AbstractRenderable.

Referenced by AbstractCompositeRenderable\addRenderable(), AbstractCompositeRenderable\moveRenderableAfter(), and AbstractCompositeRenderable\moveRenderableBefore().

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
Returns
void

Implemented in AbstractRenderable, and Page.

Referenced by AbstractCompositeRenderable\addRenderable().