Paging

Employment/Purpose

A paging component is used with another component to separate long content into multiple pages. If a component has long content to display, you could separate them into pages, and then use a paging component as a controller to allow the user decide which page to display.

The listbox, grid and tree components support the paging intrinsically, so you don’t need to specify a paging component explicitly. In other words, they will instantiate and manage a paging component automatically if the paging mold is specified. Of course, you could specify an external paging component, if you want to have different visual layout, or to control multiple listboxes, grids and/or trees with one single paging component.

Example

For example, suppose you have 100 items and prefer to show 20 items at a time, then you can use the paging components as follows.

<paging totalSize="100" pageSize="20"/>

When a user clicks on the hyperlinks, the onPaging event is sent with an instance of org.zkoss.zul.event.PagingEvent to the paging component. To decide which portion of your 100 items are visible, you should add a listener to the paging component. Please note that the code below is pseudo code. For real examples, please refer to User Cases below.

<zk>
    <div id="content"/> <!-- the long content is displayed here -->
    <paging id="paging" />
    
    <zscript>
    List result = new SearchEngine().find("ZK");
    //assume SearchEngine.find() will return a list of items.
    
    paging.setTotalSize(result.size());
    paging.addEventListener("onPaging", new org.zkoss.zk.ui.event.EventListener() {
        public void onEvent(Event event) {
            int pgno = event.getPaginal().getActivePage();
            int ofs = pgno * event.getPaginal().getPageSize();

            new Viewer().redraw(content,
                result, ofs, ofs + event.getPaginal().getPageSize() - 1);
            //assume redraw(Div content, List result, int b, int e) will display
            //the result to the content component from the b-th item to the e-th item
            }
        }
    );
    </zscript>
</zk>

Properties

Disabled

since 8.0

org.zkoss.zul.Paging#setDisabled(boolean) is used to disable the paging component. It can block the user from navigating through the pagination. For example,

<paging pageSize="2" disabled="true"/>

PageIncrement

Default: 10 (desktop), 5 (mobile)

Under os mold, the component renders a list of paging anchors for users to jump to the specific page:

This attribute determines the max number of rendered paging anchors.

Limitation

Paging can not apply stubonly at the same time. For example,

<listbox mold="paging" pageSize="1" >
    <listitem >
        <listcell stubonly="true"/>
    </listitem>
    <listitem>
        <listcell />
    </listitem>
</listbox>

Although paging will invalidate listbox and its children, stubonly needs the referred widget in client side which is detached during paging and throws mounting error.

Supported Events

Name

Event Type

onPaging

Event: [org.zkoss.zul.event.PagingEvent](https://www.zkoss.org/javadoc/latest/zk/org/zkoss/zul/event/PagingEvent.html)

Notifies one of the pages of a multi-page component is selected by the user.

Supported Molds

Available molds of a component are defined in lang.xml embedded in zul.jar.

Name

Snapshot

default

 ![](/zk_component_ref/images/paging_mold_default.png)

os

 ![](/zk_component_ref/images/paging_mold_os.png)

Supported Children

*NONE

Use Cases

Version

Description

Example Location

3.6

Small talks

Version History

Version Date Content