Class Atk4\Ui\Form\Layout

`extends`	`AbstractLayout`

Provides generic layout for a form.

Atk4\Ui\AbstractView uses AppScopeTrait, ContainerTrait, InitializerTrait, NameTrait, StaticAddToTrait, TrackableTrait
- Atk4\Ui\View
  - Atk4\Ui\Form\AbstractLayout uses WarnDynamicPropertyTrait
    - Atk4\Ui\Form\Layout
      - Atk4\Ui\Form\Layout\Columns

Located at ui/src/Form/Layout.php

Methods


					
	protected

_addControl(Control $control, Field $field): Control

Overrides

Atk4\Ui\Form\AbstractLayout::_addControl()


					
	protected

init(): void

Called when view becomes part of render tree. You can override it but avoid placing any "heavy processing" here.

Overrides

Atk4\Ui\View::init()


					
	public

addButton($seed)

Adds Button into form layout.

Implements

Atk4\Ui\Form\AbstractLayout::addButton()


					
	public

addHeader(string|array $label): $this


					
	public

addGroup(string|array $label = null): static

Adds field group in form layout.


					
	public

addSubLayout(mixed $seed = [self::class], bool $addDivider = true): self

Add a form layout section to this layout.

Each section may contain other section or group.

Parameters

$addDivider

Should we add divider after this section


					
	protected

recursiveRender(): void

Recursively render all children, placing their output in our template.

Overrides

Atk4\Ui\View::recursiveRender()

Methods inherited from Atk4\Ui\Form\AbstractLayout
`addControl(), getModelFields(), setModel(), getControl(),`

Methods inherited from Atk4\Ui\View
__construct(), setSource(), setMissingProperty(), setElement(), link(), getExecutorFactory(), add(), getClosestOwner(), set(), addClass(), removeClass(), setStyle(), removeStyle(), setAttr(), removeAttr(), url(), jsUrl(), _getStickyArgs(), stickyGet(), renderView(), renderAll(), renderTemplateToHtml(), render(), renderToTab(), renderToJsonArr(), getHtml(), js(), vue(), jsEmitEvent(), jsGetStoreData(), jsClearStoreData(), jsAddStoreData(), jsReload(), on(), getHtmlId(), getJsRenderActions(), getJs()

Methods inherited from Atk4\Ui\View

__construct(), setSource(), setMissingProperty(), setElement(), link(), getExecutorFactory(), add(), getClosestOwner(), set(), addClass(), removeClass(), setStyle(), removeStyle(), setAttr(), removeAttr(), url(), jsUrl(), _getStickyArgs(), stickyGet(), renderView(), renderAll(), renderTemplateToHtml(), render(), renderToTab(), renderToJsonArr(), getHtml(), js(), vue(), jsEmitEvent(), jsGetStoreData(), jsClearStoreData(), jsAddStoreData(), jsReload(), on(), getHtmlId(), getJsRenderActions(), getJs()

Methods inherited from Atk4\Ui\AbstractView
`getOwner()`

Methods used from Atk4\Core\AppScopeTrait
`assertInstanceOfApp(), issetApp(), getApp(), setApp()`

Methods used from Atk4\Core\ContainerTrait
`_uniqueElementName(), _addContainer(), removeElement(), _shorten(), getElement(), hasElement()`

Methods used from Atk4\Core\InitializerTrait
`isInitialized(), assertIsInitialized(), invokeInit()`

Methods used from Atk4\Core\StaticAddToTrait
`_addToAdd(), addTo(), addToWithCl(), addToWithClUnsafe()`

Methods used from Atk4\Core\TrackableTrait
`issetOwner(), setOwner(), unsetOwner(), getDesiredName(), destroy()`

Methods used from Atk4\Core\WarnDynamicPropertyTrait
`warnPropertyDoesNotExist(), __isset(), __get(), __set(), __unset()`

Properties
`public`		`$defaultTemplate = 'form/layout/generic.html'`	#
`public`	`string`	`$defaultInputTemplate = 'form/layout/generic-input.html'` Default input template file. Default input template file.	#
`public`	`string\|null`	`$label` If specified will appear on top of the group. Can be string or Label object. If specified will appear on top of the group. Can be string or Label object.	#
`public`	`string`	`$width`	#
`public`	`bool`	`$inline = false` Set true if you want fields to appear in-line. Set true if you want fields to appear in-line.	#
`public`	`HtmlTemplate\|null`	`$inputTemplate` Template holding input HTML. Template holding input HTML.	#
`public`	`array`	`$defaultHint = [Label::class, 'class' => ['pointing']]` Seed for creating input hint View used in this layout. Seed for creating input hint View used in this layout.	#

Properties inherited from Atk4\Ui\Form\AbstractLayout
`$form`

Properties inherited from Atk4\Ui\View
`$_jsActions, $model, $region, $ui, $class, $style, $attr, $template, $content, $element, $executorFactory, $stickyArgs`

Properties inherited from Atk4\Ui\AbstractView
`$_addLater, $_rendered, $elements`

Properties used from Atk4\Core\AppScopeTrait
`$_app, $maxNameLength, $uniqueNameHashes`

Properties used from Atk4\Core\ContainerTrait
`$_elementNameCounts`

Properties used from Atk4\Core\InitializerTrait
`$_initialized`

Properties used from Atk4\Core\NameTrait
`$name`

Properties used from Atk4\Core\TrackableTrait
`$_owner, $shortName`

Namespaces

Classes

Class Atk4\Ui\Form\Layout

Overrides

Overrides

Implements

Parameters

Overrides