Class Atk4\Ui\Lister

`extends`	`View`
`uses`	`HookTrait`

Atk4\Ui\AbstractView uses AppScopeTrait, ContainerTrait, InitializerTrait, NameTrait, StaticAddToTrait, TrackableTrait
- Atk4\Ui\View
  - Atk4\Ui\Lister uses HookTrait

Located at ui/src/Lister.php

Methods


					
	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()

Overriden by

Atk4\Ui\Dropdown::init()


					
	protected

initChunks(): void

From the current template will extract {row} into $this->tRowMaster and {empty} into $this->tEmpty.

Overriden by

Atk4\Ui\Table::initChunks()


					
	public

addJsPaginator(int $ipp, array $options = [], View $container = null, string $scrollRegion = null): $this

Add Dynamic paginator when scrolling content via Javascript. Will output x item in lister set per IPP until user scroll…

Add Dynamic paginator when scrolling content via Javascript. Will output x item in lister set per IPP until user scroll content to the end of page. When this happen, content will be reload x number of items.

Parameters

`$ipp`	Number of item per page
`$options`	an array with JS Scroll plugin options
`$container`	the container holding the lister for scrolling purpose
`$scrollRegion`	A specific template region to render. Render output is append to container HTML element.

Overriden by

Atk4\Ui\Table::addJsPaginator()


					
	protected

renderView(): void

View-specific rendering stuff. Feel free to replace this method with your own. View::renderView contains some logic…

View-specific rendering stuff. Feel free to replace this method with your own. View::renderView contains some logic that integrates with Fomantic-UI.

Overrides

Atk4\Ui\View::renderView()

Overriden by


					
	public

renderRow(): void

Render individual row. Override this method if you want to do more decoration.

Overriden by

Atk4\Ui\Table::renderRow()


					
	public

renderToJsonArr(string $region = null): array

Hack - override parent method with region render only support.

TODO this hack/method must be removed as rendering HTML only partially but with all JS is wrong by design. Each table row should be probably rendered natively using cloned render tree (instead of cloned template).

Overrides

Atk4\Ui\View::renderToJsonArr()

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

Methods inherited from Atk4\Ui\View

__construct(), setModel(), setSource(), setMissingProperty(), setElement(), link(), getExecutorFactory(), add(), getClosestOwner(), set(), addClass(), removeClass(), setStyle(), removeStyle(), setAttr(), removeAttr(), url(), jsUrl(), _getStickyArgs(), stickyGet(), recursiveRender(), renderAll(), renderTemplateToHtml(), render(), renderToTab(), 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\HookTrait
`_rebindHookFxToFakeInstance(), _unbindHookFxIfBoundToThis(), _rebindHooksIfCloned(), onHook(), onHookShort(), _makeHookDynamicFx(), onHookDynamic(), onHookDynamicShort(), hookHasCallbacks(), removeHook(), hook(), breakHook()`

Constants
`public`	`HOOK_BEFORE_ROW = self::class . '@beforeRow'`	#
`public`	`HOOK_AFTER_ROW = self::class . '@afterRow'`	#

Properties
`public`		`$ui = 'list'`	#
`public`		`$defaultTemplate`	#
`public`	`HtmlTemplate`	`$tRow`	#
`public`	`HtmlTemplate\|null`	`$tEmpty` Lister use this part of template in case there are no elements in it. Lister use this part of template in case there are no elements in it.	#
`public`	`JsPaginator\|null`	`$jsPaginator` A dynamic paginator attach to window scroll event. A dynamic paginator attach to window scroll event.	#
`public`	`int\|null`	`$ipp` The number of item per page for JsPaginator. The number of item per page for JsPaginator.	#
`public`	`Model`	`$currentRow` Current row entity Current row entity	#
`protected`	`int`	`$_renderedRowsCount = 0` This will count how many rows are rendered. Needed for JsPaginator for example. This will count how many rows are rendered. Needed for JsPaginator for example.	#

Properties inherited from Atk4\Ui\View
`$_jsActions, $model, $region, $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`

Properties used from Atk4\Core\HookTrait
`$hooks, $_hookIndexCounter, $_hookOrigThis`

Namespaces

Classes

Traits

Exceptions

Class Atk4\Ui\Lister

Overrides

Overriden by

Overriden by

Parameters

Overriden by

Overrides

Overriden by

Overriden by

Overrides