\Kendo\UI\TreeListPageable

A PHP class representing the pageable setting of TreeList.

Methods

alwaysVisible

(Available as of the Kendo UI 2017 R3 release) By default, the TreeList will render a pager even when total number of items in the DataSource is less than the pageSize value.If set to false the TreeList will toggle the pager visibility as follows: When the total amount of items initially set in the DataSource is less than the pageSize number, the pager will be hidden.; When the total amount of items initially set in the DataSource is greater than or equal to the pageSize number, the pager will be shown.; When the total amount of items in the DataSource becomes less than the pageSize number (after a delete or filter operation, or upon changing the pageSize), the pager will be hidden. or When the total amount of items in the DataSource becomes greater than or equal to the pageSize number (after an insert or filter operation, or upon changing the pageSize), the pager will be shown..

Returns

\Kendo\UI\TreeListPageable

Parameters

$value boolean

Example

<?php
$pageable = new \Kendo\UI\TreeListPageable();
$pageable->alwaysVisible(true);
?>

buttonCount

The maximum number of buttons that are displayed in the numeric pager. If more pages than the specified number are rendered, the pager will display ellipsis (...).

Returns

\Kendo\UI\TreeListPageable

Parameters

$value float

Example

<?php
$pageable = new \Kendo\UI\TreeListPageable();
$pageable->buttonCount(1);
?>

info

If set to true, the pager will display information about the current page and the total number of data items. By default, the paging information is displayed.

Returns

\Kendo\UI\TreeListPageable

Parameters

$value boolean

Example

<?php
$pageable = new \Kendo\UI\TreeListPageable();
$pageable->info(true);
?>

input

If set to true, the pager will display an input element which allows the user to type a specific page number. By default, the page input is not displayed.

Returns

\Kendo\UI\TreeListPageable

Parameters

$value boolean

Example

<?php
$pageable = new \Kendo\UI\TreeListPageable();
$pageable->input(true);
?>

messages

The text messages that are displayed in the pager. Use this option to customize or localize the pager messages.

Returns

\Kendo\UI\TreeListPageable

Parameters

$value \Kendo\UI\TreeListPageableMessages|array

Example - using \Kendo\UI\TreeListPageableMessages

<?php
$pageable = new \Kendo\UI\TreeListPageable();
$messages = new \Kendo\UI\TreeListPageableMessages();
$display = 'value';
$messages->display($display);
$pageable->messages($messages);
?>

Example - using array

<?php
$pageable = new \Kendo\UI\TreeListPageable();
$display = 'value';
$pageable->messages(array('display' => $display));
?>

numeric

If set to true, the pager will display buttons for navigating to specific pages. By default, these buttons are displayed.

Returns

\Kendo\UI\TreeListPageable

Parameters

$value boolean

Example

<?php
$pageable = new \Kendo\UI\TreeListPageable();
$pageable->numeric(true);
?>

pageSize

The number of data items which will be displayed in the TreeList.

Returns

\Kendo\UI\TreeListPageable

Parameters

$value float

Example

<?php
$pageable = new \Kendo\UI\TreeListPageable();
$pageable->pageSize(1);
?>

pageSizes

If set to true, the pager will display a drop-down which allows the user to pick a page size. By default, the drop-down for the page size is not displayed. Can be set to an array of predefined page sizes to override the default list. The TreeList supports a special all value which sets the page size to the total number of records. If you set a pageSize for the data source, then this value will be selected initially.

Returns

\Kendo\UI\TreeListPageable

Parameters

$value boolean|array

Example - using boolean

<?php
$pageable = new \Kendo\UI\TreeListPageable();
$pageable->pageSizes(true);
?>

Example - using array

<?php
$pageable = new \Kendo\UI\TreeListPageable();
$pageable->pageSizes(array());
?>

previousNext

If set to true, the pager will display buttons for going to the first, previous, next, and last pages. By default, these buttons are displayed.

Returns

\Kendo\UI\TreeListPageable

Parameters

$value boolean

Example

<?php
$pageable = new \Kendo\UI\TreeListPageable();
$pageable->previousNext(true);
?>

refresh

If set to true, the pager will display the Refresh button. Clicking the Refresh button will refresh the TreeList. By default, the Refresh button is not displayed.

Returns

\Kendo\UI\TreeListPageable

Parameters

$value boolean

Example

<?php
$pageable = new \Kendo\UI\TreeListPageable();
$pageable->refresh(true);
?>

responsive

If set to false, the pager will not be responsive. By default, the pager is responsive.

Returns

\Kendo\UI\TreeListPageable

Parameters

$value boolean

Example

<?php
$pageable = new \Kendo\UI\TreeListPageable();
$pageable->responsive(true);
?>
In this article
Not finding the help you need?